ElementSeq

java.lang.Object
- xal.model.elem.ElementSeq

All Implemented Interfaces:

IComponent, IComposite

Direct Known Subclasses:

ElectromagnetSeq, Lattice, LineModel, RingModel, Sector
```
public abstract class ElementSeq
extends java.lang.Object
implements IComposite
```
Convenience abstract base class for a composite modeling element. The composite is represented as a sequence of modeling elements, perhaps other composites. Specifically we have an ordered list of child modeling elements.

Propagation of probes (objects exposing the IProbe interface) is done by passing it sequentially to each child. Of course if a child is also a composite the same is done there.

Field Summary

Fields
Modifier and Type Field and Description

static int s_szDefReserve
default number of element positions to reserve in list array

Fields
Modifier and Type	Field and Description
`static int`	`s_szDefReserve` default number of element positions to reserve in list array

Constructor Summary

Constructors
Constructor and Description
`ElementSeq(java.lang.String strType)` Creates a new instance of `ElementSeq` without of the given soft type but without a sequence identifier.
`ElementSeq(java.lang.String strType, java.lang.String strId)` Creates a new instance of `ElementSeq` with the given soft type and sequence identifier.
`ElementSeq(java.lang.String strType, java.lang.String strId, int szReserve)` Creates a new instance of `ElementSeq` with the given soft type and sequence identifier.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addChild(IComponent iComp)` Add a component object at the tail of the sequence.
`void`	`backPropagate(IProbe probe)` Backward propagation of probe through sequence.
`void`	`backPropagate(IProbe probe, double pos)` Override of `IComponent.propagate(xal.model.IProbe, double)`
`java.util.Iterator<IComponent>`	`childIterator()` Return an `Iterator` object that cycles through all the direct children of the sequence.
`void`	`concatenateEquals(ElementSeq seq)` Concatenate the indicated `ElementSeq` object to the tail of this sequence.
`java.util.List<IComponent>`	`getAllElements()` Returns a list of all elements contained in this sequence, more specifically, all leaf elements.
`IComponent`	`getChild(int indChild)` Get the child IComponent interface at location specified by index.
`int`	`getChildCount()` Get the number of direct children in this sequence.
`java.lang.String`	`getComments()` Get any user comments regarding this sequence.
`protected java.util.List<IComponent>`	`getCompList()` Return the internal list of components
`java.util.List<IComponent>`	`getElementList()` Return the list of `IElement` objects contained in this sequence.
`java.lang.String`	`getHardwareNodeId()` Returns the string identifier of the hardware node which this element models.
`java.lang.String`	`getId()` Get the sequence identifier
`int`	`getLeafCount()` Get the number of `IElement` derived objects contained in this sequence.
`double`	`getLength()` Return the length of the sequence.
`protected java.util.List<IComponent>`	`getReverseCompList()` Return the reverse component list (downstream to upstream)
`java.lang.String`	`getType()` Get the type identifier for the composite element.
`java.util.Iterator<IComponent>`	`globalBackIterator()` Return an `Iterator` object that iterates over every `IComponent` object in this composite.
`java.util.Iterator<IComponent>`	`globalIterator()` Return an `Iterator` object that iterates over every `IComponent` object in this composite.
`void`	`initializeFrom(LatticeElement latticeElement)` Conversion method to be provided by the user
`java.util.Iterator<IComponent>`	`localBackIterator()` Return an `Iterator` object that iterates over the direct descendants only of this composite element, in reverse order.
`java.util.Iterator<IComponent>`	`localIterator()` Return an `Iterator` object that iterates over the direct descendants only of this composite element, in order.
`void`	`print(java.io.PrintWriter os)` Dump contents to a text stream.
`void`	`propagate(IProbe probe)` Propagate probe through sequence
`void`	`propagate(IProbe probe, double pos)` Override of `IComponent.propagate(xal.model.IProbe, double)`
`boolean`	`remove(IComponent iComp)` Remove an element from the entire tree.
`void`	`setComments(java.lang.String strComment)` Sets any user comment associated with this sequence.
`protected void`	`setCompList(java.util.List<? extends IComponent> elements)` Set the comp list to the new list of elements.
`void`	`setHardwareNodeId(java.lang.String strSmfId)` Sets the string identifier of the hardware node which this element models.
`void`	`setId(java.lang.String strId)` Set the string identifier for the element.
`java.lang.String`	`toString()` Writes out the modeling elements in this element sequence structure.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - s_szDefReserve
```
public static final int s_szDefReserve
```
    default number of element positions to reserve in list array
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - ElementSeq
```
public ElementSeq(java.lang.String strType)
```
    Creates a new instance of ElementSeq without of the given soft type but without a sequence identifier.
    
    Parameters:
    
    strType - soft type of the sequence (defined by the child class)
  - ElementSeq
```
public ElementSeq(java.lang.String strType,
                  java.lang.String strId)
```
    Creates a new instance of ElementSeq with the given soft type and sequence identifier.
    
    Parameters:
    
    strType - soft type of the sequence (defined by the child class)
    
    strId - identifier of the sequence
  - ElementSeq
```
public ElementSeq(java.lang.String strType,
                  java.lang.String strId,
                  int szReserve)
```
    Creates a new instance of ElementSeq with the given soft type and sequence identifier. Also reserves space for a the sequence elements. This saves a little CPU time if the relative size of the sequence is known a priori.
    
    Parameters:
    
    strType - soft type of the sequence (defined by the child class)
    
    strId - identifier of the sequence
    
    szReserve - number of Element spaces to reserve
- Method Detail
  - initializeFrom
```
public void initializeFrom(LatticeElement latticeElement)
```
    Conversion method to be provided by the user
    
    Specified by:
    
    initializeFrom in interface IComponent
    
    Parameters:
    
    latticeElement - the SMF node to convert
  - setId
```
public void setId(java.lang.String strId)
```
    Set the string identifier for the element.
    
    Parameters:
    
    strId - new string identifier for element
  - setHardwareNodeId
```
public void setHardwareNodeId(java.lang.String strSmfId)
```
    Sets the string identifier of the hardware node which this element models. Node that this sequence probably models an accelerator sector, or logical unit. Thus, this ID is likely of the type "HEBT", "RING", "DTL", etc.
    
    Parameters:
    
    strSmfId - identifier for the modeled hardware node (SMF object)
    
    Since:
    
    Sep 2, 2014
  - setComments
```
public void setComments(java.lang.String strComment)
```
    Sets any user comment associated with this sequence.
    
    Parameters:
    
    strComment - string containing user comments
  - getType
```
public java.lang.String getType()
```
    Get the type identifier for the composite element.
    
    Specified by:
    
    getType in interface IComponent
    
    Returns:
    
    type identifier for ElementSeq
  - getId
```
public java.lang.String getId()
```
    Get the sequence identifier
    
    Specified by:
    
    getId in interface IComponent
    
    Returns:
    
    sequence identifier
  - getHardwareNodeId
```
public java.lang.String getHardwareNodeId()
```
    Returns the string identifier of the hardware node which this element models. This value is likely a sector of an accelerator structure, such as "HEBT", "RING", "MEBT", etc.
    
    Specified by:
    
    getHardwareNodeId in interface IComponent
    
    Returns:
    
    the identifier string of the hardware this element models
    
    Since:
    
    Sep 2, 2014
  - getLength
```
public double getLength()
```
    Return the length of the sequence. The length of the sequence is determined but summing the lengths of all the contained IElement objects.
    
    Specified by:
    
    getLength in interface IComponent
    
    Returns:
    
    total length of the sequence (in meters)
  - propagate
```
public void propagate(IProbe probe,
                      double pos)
               throws ModelException
```
    Override of IComponent.propagate(xal.model.IProbe, double)
    
    Specified by:
    
    propagate in interface IComponent
    
    Throws:
    
    ModelException
    
    Since:
    
    Feb 27, 2009
    
    See Also:
    
    IComponent.propagate(xal.model.IProbe, double)
  - propagate
```
public void propagate(IProbe probe)
               throws ModelException
```
    Propagate probe through sequence
    
    Specified by:
    
    propagate in interface IComponent
    
    Specified by:
    
    propagate in interface IComposite
    
    Parameters:
    
    probe - the state of the probe will be advance using the elements dynamics
    
    Throws:
    
    ModelException - an error occurred while advancing the probe state
    
    See Also:
    
    IComponent.propagate(IProbe)
  - backPropagate
```
public void backPropagate(IProbe probe,
                          double pos)
                   throws ModelException
```
    Override of IComponent.propagate(xal.model.IProbe, double)
    
    NOTES: CKA
    · Support for backward propagation February, 2009.
    · You must use the proper algorithm object for this method to work correctly!
    
    Specified by:
    
    backPropagate in interface IComponent
    
    Parameters:
    
    probe - probe to be propagate - its state is advanced
    
    pos - position within element
    
    Throws:
    
    ModelException - error advancing the probe state
    
    Since:
    
    Feb 27, 2009
    
    See Also:
    
    IComponent.propagate(xal.model.IProbe, double)
  - backPropagate
```
public void backPropagate(IProbe probe)
                   throws ModelException
```
    Backward propagation of probe through sequence.
    
    NOTES: CKA
    · Support for backward propagation February, 2009.
    · You must use the proper algorithm object for this method to work correctly!
    
    Specified by:
    
    backPropagate in interface IComponent
    
    Parameters:
    
    probe - the state of the probe will be advance using the elements dynamics
    
    Throws:
    
    ModelException - an error occurred while advancing the probe state
  - localIterator
```
public java.util.Iterator<IComponent> localIterator()
```
    Return an Iterator object that iterates over the direct descendants only of this composite element, in order.
    
    Specified by:
    
    localIterator in interface IComposite
    
    Returns:
    
    interface to iterator object
    
    See Also:
    
    Iterator
  - globalIterator
```
public java.util.Iterator<IComponent> globalIterator()
```
    Return an Iterator object that iterates over every IComponent object in this composite. For IComponent which are also composite the parent is returned first, then all its children. This would be in reverse order.
    
    Specified by:
    
    globalIterator in interface IComposite
    
    Returns:
    
    Iterator interface to iterator object
    
    See Also:
    
    Iterator
  - localBackIterator
```
public java.util.Iterator<IComponent> localBackIterator()
```
    Return an Iterator object that iterates over the direct descendants only of this composite element, in reverse order.
    
    Returns:
    
    interface to iterator object
    
    Since:
    
    Feb 27, 2009
    
    See Also:
    
    Iterator
  - globalBackIterator
```
public java.util.Iterator<IComponent> globalBackIterator()
```
    Return an Iterator object that iterates over every IComponent object in this composite. For IComponent which are also composite the parent is returned first, then all its children. This would be in reverse order.
    
    Returns:
    
    Iterator interface to iterator object
    
    See Also:
    
    Iterator
  - getChildCount
```
public int getChildCount()
```
    Get the number of direct children in this sequence. Note that this is not the number of leaves in the sequence.
    
    Specified by:
    
    getChildCount in interface IComposite
    
    Returns:
    
    number of direct descendants
  - getChild
```
public IComponent getChild(int indChild)
```
    Get the child IComponent interface at location specified by index.
    
    Specified by:
    
    getChild in interface IComposite
    
    Parameters:
    
    indChild - position index within the sequence list
    
    Returns:
    
    child at position indChild
  - addChild
```
public void addChild(IComponent iComp)
```
    Add a component object at the tail of the sequence.
    
    NOTES: CKA
    · Added support for backward propagation February, 2009
    
    Specified by:
    
    addChild in interface IComposite
    
    Parameters:
    
    iComp - new component object
  - remove
```
public boolean remove(IComponent iComp)
```
    Remove an element from the entire tree. The element can be a single leaf node or a composite node.
    
    Specified by:
    
    remove in interface IComposite
    
    Parameters:
    
    iComp - IComponent object to be removed
    
    Returns:
    
    return true if element was found and removed, false otherwise
  - getComments
```
public java.lang.String getComments()
```
    Get any user comments regarding this sequence. Returns the null string if none.
    
    Returns:
    
    string containing user comments
  - getLeafCount
```
public int getLeafCount()
```
    Get the number of IElement derived objects contained in this sequence.
    
    Returns:
    
    number of Element object w/in sequence
  - childIterator
```
public java.util.Iterator<IComponent> childIterator()
```
    Return an Iterator object that cycles through all the direct children of the sequence. Note that any child may have children itself.
    
    Returns:
    
    iterator of IElement interfaces
  - getElementList
```
public java.util.List<IComponent> getElementList()
```
    Return the list of IElement objects contained in this sequence.
    
    Returns:
    
    list of elements composing this sequence
  - getAllElements
```
public java.util.List<IComponent> getAllElements()
```
    Returns a list of all elements contained in this sequence, more specifically, all leaf elements.
    
    Returns:
    
    list containing all IComponent class elements in this sequence
    
    Since:
    
    Sep 11, 2014
  - concatenateEquals
```
public void concatenateEquals(ElementSeq seq)
```
    Concatenate the indicated ElementSeq object to the tail of this sequence.
    
    Parameters:
    
    seq - object to conjoin to this one
  - toString
```
public java.lang.String toString()
```
    Writes out the modeling elements in this element sequence structure.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Since:
    
    Jan 5, 2015 by Christopher K. Allen
    
    See Also:
    
    Object.toString()
  - print
```
public void print(java.io.PrintWriter os)
```
    Dump contents to a text stream.
    
    Parameters:
    
    os - output stream
  - getCompList
```
protected java.util.List<IComponent> getCompList()
```
    Return the internal list of components
  - getReverseCompList
```
protected java.util.List<IComponent> getReverseCompList()
```
    Return the reverse component list (downstream to upstream)
    
    NOTES: CKA
    · Added support for backward propagation February, 2009
    
    Returns:
    
    List of sequence components in reverse order
    
    Since:
    
    Feb 27, 2009
  - setCompList
```
protected void setCompList(java.util.List<? extends IComponent> elements)
```
    Set the comp list to the new list of elements.
    
    NOTES: CKA
    · Added support for backward propagation February, 2009
    
    Parameters:
    
    elements - the new list of elements

Class ElementSeq

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

s_szDefReserve

Constructor Detail

ElementSeq

ElementSeq

ElementSeq

Method Detail

initializeFrom

setId

setHardwareNodeId

setComments

getType

getId

getHardwareNodeId

getLength

propagate

propagate

backPropagate

backPropagate

localIterator

globalIterator

localBackIterator

globalBackIterator

getChildCount

getChild

addChild

remove

getComments

getLeafCount

childIterator

getElementList

getAllElements

concatenateEquals

toString

print

getCompList

getReverseCompList

setCompList