gov.sns.xal.smf
Class Ring

java.lang.Object
  |
  +--gov.sns.xal.smf.AcceleratorNode
        |
        +--gov.sns.xal.smf.AcceleratorSeq
              |
              +--gov.sns.xal.smf.AcceleratorSeqCombo
                    |
                    +--gov.sns.xal.smf.Ring

All Implemented Interfaces:

DataListener, ElementType

public class Ring

extends AcceleratorSeqCombo

Ring is a subclass of combo sequence that is intended to support the special needs of a Ring. A ring is made up of ring segments.

Field Summary

static java.lang.String

s_strType node type

Fields inherited from class gov.sns.xal.smf.AcceleratorSeq

m_arrNodes, m_bucSequence, nodeTable

Fields inherited from class gov.sns.xal.smf.AcceleratorNode

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

Constructor Summary

Ring(java.lang.String strID, Accelerator accelerator, DataAdaptor adaptor)
Constructor

Ring(java.lang.String strID, java.util.List segments)
Primary Constructor

Method Summary

boolean

isLinear() Identify whether the sequence is within a linear section.

Methods inherited from class gov.sns.xal.smf.AcceleratorSeqCombo

getAllNodes, getBaseConstituents, getBaseConstituentsWithQualifier, getConstituentNames, getConstituents, getConstituentsWithQualifier, getInstance, getInstance, getLength, getNodes, getNodeWithId, getPosition, getSequences, getType

Methods inherited from class gov.sns.xal.smf.AcceleratorSeq

addBucket, addNode, addNodeAt, addSequenceChain, addSoft, canPrecede, contains, dataLabel, formsRing, getAllNodesOfType, getAllNodesWithQualifier, getAllSeqs, getIndexOfNode, getLeaves, getNodeAt, getNodeCount, getNodesOfType, getNodesWithQualifier, getNodesWithQualifier, getPredecessors, getSequence, getSequenceBuc, getSequences, indexToAddNode, orderSequences, recurNodeSearch, recurSeqSearch, removeAllNodes, removeNode, setSequence, sortNodes, update, write

Methods inherited from class gov.sns.xal.smf.AcceleratorNode

channelSuite, clear, getAccelerator, getAlign, getAndConnectChannel, getAper, getBucket, getBuckets, getChannel, getHandles, getId, getParent, getPosition, getStatus, getTwiss, getValid, hasBucket, hasParent, isKindOf, isMagnet, lazilyGetAndConnect, removeFromParent, setAccelerator, setAlign, setAper, setLength, setParent, setPosition, setStatus, setTwiss, setValid, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

s_strType

public static final java.lang.String s_strType

node type

See Also:

Constant Field Values

Constructor Detail

Ring

public Ring(java.lang.String strID,
            java.util.List segments)

Primary Constructor

Ring

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

Constructor

Method Detail

isLinear

public boolean isLinear()

Identify whether the sequence is within a linear section. This helps us to determine whether it is meaningful to identify one node as being downstream from another.

Overrides:

isLinear in class AcceleratorSeq

Returns:

false since by definition the ring is not a linear section