xal.smf

Class AcceleratorSeqCombo

java.lang.Object

xal.smf.AcceleratorNode

xal.smf.AcceleratorSeq

xal.smf.AcceleratorSeqCombo

All Implemented Interfaces:

ElementType, DataListener

Direct Known Subclasses:

Ring

public class AcceleratorSeqCombo
extends AcceleratorSeq

The implementation of the accelerator combo sequence, This class is meant to deal with pasting together existing sequences into new sequences.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	s_strType

Fields inherited from class xal.smf.AcceleratorSeq

_sequences, m_arrNodes, m_bucSequence, nodeTable

Fields inherited from class xal.smf.AcceleratorNode

channelSuite, m_bolIsSoft, m_bolStatus, m_bolValid, m_bucAlign, m_bucAper, m_bucTwiss, m_dblLen, m_dblPos, m_dblS, m_mapAttrs, m_objAccel, m_seqParent, m_strEId, m_strId, m_strPId

Constructor Summary

Constructors

Constructor and Description
AcceleratorSeqCombo(java.lang.String strID, Accelerator accelerator, DataAdaptor adaptor) Constructor
AcceleratorSeqCombo(java.lang.String strID, java.util.List<AcceleratorSeq> seqs) Primary constructor

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object sequence) Override the equals method to return true if and only if the two combo sequences have equal IDs, are both combo sequences and have equal constituents.
java.util.List<AcceleratorNode>	getAllInclusiveNodes() Get all nodes including this sequence and constituent sequences and all of their children.
java.util.List<AcceleratorNode>	getAllNodes() Fetch all nodes looking deeply through nested child sequences.
java.util.List<AcceleratorSeq>	getBaseConstituents() Get the constituent sequences looking deeply even if the combo sequences are nested in many layers.
java.util.List<AcceleratorSeq>	getBaseConstituentsWithQualifier(TypeQualifier qualifier) Get the constituent sequences looking deeply even if the combo sequences are nested in many layers.
java.util.List<java.lang.String>	getConstituentNames() gets the list of the names of the constituent seqnences
java.util.List<AcceleratorSeq>	getConstituents() Get the constituent sequences.
java.util.List<AcceleratorSeq>	getConstituentsWithQualifier(TypeQualifier qualifier) Get the constituent sequences that are matched by the qualifier.
java.lang.String	getEntranceID() Get the ID of the first base constituent sequence of this combo sequence.
static AcceleratorSeqCombo	getInstance(Accelerator accelerator, DataAdaptor adaptor) Instantiate a an AcceleratorSeqCombo or a subclass depending on whether the sequences form a ring.
static AcceleratorSeqCombo	getInstance(java.lang.String strID, Accelerator accelerator, DataAdaptor adaptor) Instantiate a an AcceleratorSeqCombo or a subclass depending on whether the sequences form a ring.
static AcceleratorSeqCombo	getInstance(java.lang.String strID, java.util.List<AcceleratorSeq> sequences) Instantiate a an AcceleratorSeqCombo or a subclass depending on whether the sequences form a ring.
static AcceleratorSeqCombo	getInstanceForRange(java.lang.String comboID, AcceleratorSeq startSequence, AcceleratorSeq endSequence) Get an instance of a non-cycling combo sequence which starts and ends between the specified sequences inclusively.
static java.util.List<AcceleratorSeqCombo>	getInstancesForRange(java.lang.String comboID, AcceleratorSeq startSequence, AcceleratorSeq endSequence) Get the list of all non-cycling combo sequences which start and end between the specified sequences inclusively.
double	getLength() override the total length for this combo sequence
java.util.List<AcceleratorNode>	getNodes() Shallow fetch of nodes.
AcceleratorNode	getNodeWithId(java.lang.String label) Search deeply for and get the node with the specified id.
double	getPosition(AcceleratorNode node) get the position of a node in the sequence, including the extra length of the sequence starting position itself Note: this way could also be done in the parent AcceleratorSeq class, be we choose to use a more efficient scheme there, specfic to primary sequences.
java.util.List<AcceleratorSeq>	getSequences() Shallow fetch of sequences.
protected static java.util.List<AcceleratorSeq>	getSequences(Accelerator accelerator, DataAdaptor adaptor) Get the sequences in the accelerator which are referenced in the adaptor.
java.lang.String	getType() Override to identify this sequence as a combo sequence
int	hashCode() Override hashCode() as required when overriding equals()
void	write(DataAdaptor adaptor) Write this sequence's definition to a data adaptor.

Methods inherited from class xal.smf.AcceleratorSeq

addBucket, addNode, addNodeAt, addSequenceChain, addSoft, appendNodesOfClassWithQualifier, appendNodesWithQualifier, canPrecede, contains, dataLabel, filterNodesByClass, filterNodesByStatus, formsRing, getAllInclusiveNodes, getAllInclusiveNodesWithQualifier, getAllNodes, getAllNodesOfType, getAllNodesWithQualifier, getAllSeqs, getDistanceBetween, getIndexOfNode, getLeaves, getNodeAt, getNodeCount, getNodes, getNodesOfClassWithQualifier, getNodesOfClassWithQualifier, getNodesOfClassWithStatus, getNodesOfType, getNodesOfType, getNodesWithQualifier, getNodesWithQualifier, getPredecessors, getPrimaryAncestor, getRelativePosition, getRelativePosition, getSequence, getSequenceBuc, getSequences, getShortestRelativePosition, indexToAddNode, isLinear, orderSequences, recurNodeSearch, recurSeqSearch, removeAllNodes, removeNode, setSequence, sortNodes, sortNodesByProximity, sortNodesByRelativePosition, update, writeDeeply

Methods inherited from class xal.smf.AcceleratorNode

channelSuite, clear, findChannel, getAccelerator, getAlign, getAndConnectChannel, getAper, getBucket, getBuckets, getChannel, getDesignPropertyValue, getEId, getHandles, getId, getLivePropertyChannels, getLivePropertyValue, getParent, getPId, getPitchAngle, getPosition, getRollAngle, getSDisplay, getSoftType, getStatus, getTwiss, getValid, getXOffset, getYawAngle, getYOffset, getZOffset, hasBucket, hasParent, isKindOf, isMagnet, lazilyGetAndConnect, removeFromParent, setAccelerator, setAlign, setAper, setLength, setParent, setPitchAngle, setPosition, setRollAngle, setSDisplay, setStatus, setTwiss, setValid, setXOffset, setYawAngle, setYOffset, setZOffset, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

s_strType

public static final java.lang.String s_strType

See Also:

Constant Field Values

Constructor Detail

AcceleratorSeqCombo

public AcceleratorSeqCombo(java.lang.String strID,
                           java.util.List<AcceleratorSeq> seqs)

Primary constructor

AcceleratorSeqCombo

public AcceleratorSeqCombo(java.lang.String strID,
                           Accelerator accelerator,
                           DataAdaptor adaptor)

Constructor

Method Detail

getInstance

public static AcceleratorSeqCombo getInstance(java.lang.String strID,
                                              java.util.List<AcceleratorSeq> sequences)

Instantiate a an AcceleratorSeqCombo or a subclass depending on whether the sequences form a ring.

Parameters:

strID - The identifier of the new combo sequence

sequences - The sequences to flatten into a combo sequence

Returns:

a new AcceleratorSeqCombo instance if the sequences do not form a ring and a Ring if they do

getInstance

public static AcceleratorSeqCombo getInstance(java.lang.String strID,
                                              Accelerator accelerator,
                                              DataAdaptor adaptor)

Instantiate a an AcceleratorSeqCombo or a subclass depending on whether the sequences form a ring.

Parameters:

strID - The identifier of the new combo sequence

accelerator - The accelerator that holds to the sequences

adaptor - the data adaptor for specifying the sequences to combine

Returns:

a new AcceleratorSeqCombo instance if the sequences do not form a ring and a Ring if they do

getInstance

public static AcceleratorSeqCombo getInstance(Accelerator accelerator,
                                              DataAdaptor adaptor)

Instantiate a an AcceleratorSeqCombo or a subclass depending on whether the sequences form a ring.

Parameters:

accelerator - The accelerator that holds to the sequences

adaptor - the data adaptor for specifying the sequences to combine

Returns:

a new AcceleratorSeqCombo instance if the sequences do not form a ring and a Ring if they do

getInstanceForRange

public static AcceleratorSeqCombo getInstanceForRange(java.lang.String comboID,
                                                      AcceleratorSeq startSequence,
                                                      AcceleratorSeq endSequence)

Get an instance of a non-cycling combo sequence which starts and ends between the specified sequences inclusively.

Parameters:

comboID - unique ID to assign to the new combo sequence

startSequence - first sequence in combo

endSequence - last sequence in combo

Returns:

a combo sequence ranging from the first sequence to the last sequence or null if none can be found

getInstancesForRange

public static java.util.List<AcceleratorSeqCombo> getInstancesForRange(java.lang.String comboID,
                                                                       AcceleratorSeq startSequence,
                                                                       AcceleratorSeq endSequence)

Get the list of all non-cycling combo sequences which start and end between the specified sequences inclusively.

Parameters:

comboID - unique ID to assign to the new combo sequence

startSequence - first sequence in combo

endSequence - last sequence in combo

Returns:

list of combo sequences ranging from the first sequence to the last sequence

getSequences

protected static java.util.List<AcceleratorSeq> getSequences(Accelerator accelerator,
                                                             DataAdaptor adaptor)

Get the sequences in the accelerator which are referenced in the adaptor.

Parameters:

accelerator - the accelerator from which to get the sequences

adaptor - the combo sequence adaptor

write

public void write(DataAdaptor adaptor)

Write this sequence's definition to a data adaptor.

Specified by:

write in interface DataListener

Overrides:

write in class AcceleratorSeq

Parameters:

adaptor - the adaptor to which to write out this combo sequence's definition.

getType

public java.lang.String getType()

Override to identify this sequence as a combo sequence

Overrides:

getType in class AcceleratorSeq

Returns:

the combo sequence type identifier

getLength

public double getLength()

override the total length for this combo sequence

Overrides:

getLength in class AcceleratorSeq

Returns:

the length of this sequence along the closed orbit

getConstituentNames

public java.util.List<java.lang.String> getConstituentNames()

gets the list of the names of the constituent seqnences

getPosition

public double getPosition(AcceleratorNode node)

get the position of a node in the sequence, including the extra length of the sequence starting position itself Note: this way could also be done in the parent AcceleratorSeq class, be we choose to use a more efficient scheme there, specfic to primary sequences.

Overrides:

getPosition in class AcceleratorSeq

Parameters:

node - - the node for which the position is wanted

getEntranceID

public java.lang.String getEntranceID()

Get the ID of the first base constituent sequence of this combo sequence.

Overrides:

getEntranceID in class AcceleratorSeq

Returns:

the ID of first base constituent sequence

getNodeWithId

public AcceleratorNode getNodeWithId(java.lang.String label)

Search deeply for and get the node with the specified id. Overrides the inherited method to search down the path of the constituent sequences.

Overrides:

getNodeWithId in class AcceleratorSeq

Parameters:

label - The id of the node we are seeking.

Returns:

the node corresponding to the requested id or null if no such node is found.

getNodes

public java.util.List<AcceleratorNode> getNodes()

Shallow fetch of nodes. Override the AcceleratorSeq version to only return the list of nodes which are a union of those nodes which belong to the base constituent sub-sequences.

Overrides:

getNodes in class AcceleratorSeq

Returns:

a list of this sequence's immediate child nodes

getSequences

public java.util.List<AcceleratorSeq> getSequences()

Shallow fetch of sequences. Override the AcceleratorSeq version to only return the list of sequences which are a union of those nodes which belong to the base constituent sub-sequences.

Overrides:

getSequences in class AcceleratorSeq

getConstituents

public java.util.List<AcceleratorSeq> getConstituents()

Get the constituent sequences.

Returns:

the list of constituent sequences that make the primary sequence

getConstituentsWithQualifier

public java.util.List<AcceleratorSeq> getConstituentsWithQualifier(TypeQualifier qualifier)

Get the constituent sequences that are matched by the qualifier.

Parameters:

qualifier - The qualifier to restrict which constituents are returned

Returns:

the list of constituent sequences that make the combo sequence

getBaseConstituents

public java.util.List<AcceleratorSeq> getBaseConstituents()

Get the constituent sequences looking deeply even if the combo sequences are nested in many layers.

Returns:

the list of constituent sequences that make the combo sequence

getBaseConstituentsWithQualifier

public java.util.List<AcceleratorSeq> getBaseConstituentsWithQualifier(TypeQualifier qualifier)

Get the constituent sequences looking deeply even if the combo sequences are nested in many layers. Use the qualifier to limit the constituent sequences to only those which match the qualifier.

Parameters:

qualifier - The qualifier for matching which constituents get returned

Returns:

the list of qualified constituent sequences that make the combo sequence

getAllInclusiveNodes

public java.util.List<AcceleratorNode> getAllInclusiveNodes()

Get all nodes including this sequence and constituent sequences and all of their children.

Overrides:

getAllInclusiveNodes in class AcceleratorSeq

Returns:

the list of all inclusive nodes

getAllNodes

public java.util.List<AcceleratorNode> getAllNodes()

Fetch all nodes looking deeply through nested child sequences. Filter out constituent seqences.

Overrides:

getAllNodes in class AcceleratorSeq

Returns:

all child nodes looking deeply through nested child sequences

equals

public boolean equals(java.lang.Object sequence)

Override the equals method to return true if and only if the two combo sequences have equal IDs, are both combo sequences and have equal constituents.

Overrides:

equals in class java.lang.Object

Parameters:

sequence - the sequence against which to compare

Returns:

true if and only if the two sequences are equal

hashCode

public int hashCode()

Override hashCode() as required when overriding equals()

Overrides:

hashCode in class java.lang.Object