Package xal.smf

Class Ring

java.lang.Object

xal.smf.AcceleratorNode

xal.smf.AcceleratorSeq

xal.smf.AcceleratorSeqCombo

xal.smf.Ring

All Implemented Interfaces:

Comparable, ElementType, DataListener

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.

Author:

tap

Field Summary

Fields

Modifier and Type	Field	Description
static final String	TYPE	node type

Fields inherited from class xal.smf.AcceleratorSeq

arrNodes, bucSequence, nodeTable, sequences

Fields inherited from class xal.smf.AcceleratorNode

bolIsSoft, bolStatus, bolValid, bucAlign, bucAper, bucTwiss, channelSuite, dblLen, dblPos, dblS, mapAttrs, objAccel, seqParent, strEId, strId, strPId

Constructor Summary

Constructors

Constructor	Description
Ring(String strID, List<AcceleratorSeq> segments)	Primary Constructor
Ring(String strID, Accelerator accelerator, DataAdaptor adaptor)	Constructor

Method Summary

Modifier and Type	Method	Description
double	getRelativePosition(double position, AcceleratorNode referenceNode)	Convert the sequence position to a position relative to the specified reference node.
double	getShortestRelativePosition(AcceleratorNode node, AcceleratorNode referenceNode)	Get the shortest relative position of one node with respect to a reference node.
boolean	isLinear()	Identify whether the sequence is within a linear section.

Methods inherited from class xal.smf.AcceleratorSeqCombo

equals, getAllInclusiveNodes, getAllNodes, getAperProfile, getBaseConstituents, getBaseConstituentsWithQualifier, getConstituentNames, getConstituents, getConstituentsWithQualifier, getEntranceID, getInstance, getInstance, getInstance, getInstanceForRange, getInstancesForRange, getLength, getNodes, getNodeWithId, getPosition, getSequences, getSequences, getType, hashCode, write

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, getAperProfile, getDistanceBetween, getIndexOfNode, getLeaves, getNodeAt, getNodeCount, getNodes, getNodesOfClassWithQualifier, getNodesOfClassWithQualifier, getNodesOfClassWithStatus, getNodesOfType, getNodesOfType, getNodesWithQualifier, getNodesWithQualifier, getPredecessors, getPrimaryAncestor, getRelativePosition, getSequence, getSequenceBuc, getSequences, indexToAddNode, orderSequences, recurNodeSearch, recurSeqSearch, removeAllNodes, removeNode, setSequence, sortNodes, sortNodesByProximity, sortNodesByRelativePosition, update, writeAttributes, writeDeeply, writeStatus

Methods inherited from class xal.smf.AcceleratorNode

batchConnectAllHandles, batchConnectAllHandlesAndWait, channelSuite, clear, compareTo, findChannel, getAccelerator, getAccessibleProperties, getAccessibleProperties, getAlign, getAllChannels, getAndConnectChannel, getAndConnectChannelSetAndReadback, getAper, getBucket, getBuckets, getChannel, getDefaultHandles, getDesignPropertyValue, getEId, getHandles, getId, getLivePropertyChannels, getLivePropertyValue, getParent, getPId, getPitchAngle, getPosition, getProperties, getReadbackHandles, getRollAngle, getSDisplay, getSetHandle, getSoftType, getStatus, getTwiss, getValid, getXOffset, getYawAngle, getYOffset, getZOffset, hasBucket, hasParent, isChannelSettable, isKindOf, isMagnet, lazilyGetAndConnect, removeFromParent, setAccelerator, setAlign, setAper, setDesignPropertyValue, setLength, setLivePropertyValue, setParent, setPitchAngle, setPosition, setRollAngle, setSDisplay, setStatus, setTwiss, setValid, setValueAndVerify, setXOffset, setYawAngle, setYOffset, setZOffset, toString

Methods inherited from class java.lang.Object

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

Field Details

TYPE

public static final String TYPE

node type

See Also:

• Constant Field Values

Constructor Details

Ring

public Ring(String strID,
 List<AcceleratorSeq> segments)

Primary Constructor

Ring

public Ring(String strID,
 Accelerator accelerator,
 DataAdaptor adaptor)

Constructor

Method Details

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

getRelativePosition

public double getRelativePosition(double position,
 AcceleratorNode referenceNode)

Convert the sequence position to a position relative to the specified reference node.

Overrides:

getRelativePosition in class AcceleratorSeq

Parameters:

position - the position of a location relative to the sequence's start

referenceNode - the node relative to which we wish to get the position

getShortestRelativePosition

public double getShortestRelativePosition(AcceleratorNode node,
 AcceleratorNode referenceNode)

Get the shortest relative position of one node with respect to a reference node. This is really useful for ring sequences.

Overrides:

getShortestRelativePosition in class AcceleratorSeq

Parameters:

node - the node whose relative position is sought

referenceNode - the reference node relative to which the node's position is calculated

Returns:

the distance (positive or negative) of the node with respect to the reference node whose magnitude is shortest