xal.smf

Class AcceleratorSector

java.lang.Object

xal.smf.AcceleratorNode

xal.smf.AcceleratorSeq

xal.smf.AcceleratorSector

All Implemented Interfaces:

ElementType, DataListener

public final class AcceleratorSector
extends AcceleratorSeq

Field Summary

Fields

Modifier and Type	Field and Description
protected double	m_dblBeamCharge Charge of beam in this sequence (+-1)
protected double	m_dblEr particle species rest energy
protected double	m_dblQ2M particle species charge to mass ratio

Fields inherited from class xal.smf.AcceleratorSeq

_sequences, m_arrNodes, m_bucSequence, nodeTable, s_strType

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
AcceleratorSector(java.lang.String strId) Creates a new instance of AcceleratorSector
AcceleratorSector(java.lang.String strId, int intReserve) Creates a new instance of AcceleratorSector

Method Summary

Modifier and Type	Method and Description
boolean	addNode(AcceleratorNode node) Adds node to the Sector at the tail.
AcceleratorSeq	concatenate(AcceleratorSector sec)
double	getCharge2Mass() Return the charge to mass ratio of the design particle species
double	getChargeSignum() Return the signum of design particle species charge
double	getRestEnergy() Return the rest energy of the design particle species
void	setCharge2Mass(double dblQ2M) Set the charge to mass ratio of the design particle
void	setChargeSignum(double dblSgn) Set the charge sign of the design particle @param dblSgn {-1,+1}
void	setRestEnergy(double dblEr) Set the rest energy of the design particle species

Methods inherited from class xal.smf.AcceleratorSeq

addBucket, addNodeAt, addSequenceChain, addSoft, appendNodesOfClassWithQualifier, appendNodesWithQualifier, canPrecede, contains, dataLabel, filterNodesByClass, filterNodesByStatus, formsRing, getAllInclusiveNodes, getAllInclusiveNodes, getAllInclusiveNodesWithQualifier, getAllNodes, getAllNodes, getAllNodesOfType, getAllNodesWithQualifier, getAllSeqs, getDistanceBetween, getEntranceID, getIndexOfNode, getLeaves, getLength, getNodeAt, getNodeCount, getNodes, getNodes, getNodesOfClassWithQualifier, getNodesOfClassWithQualifier, getNodesOfClassWithStatus, getNodesOfType, getNodesOfType, getNodesWithQualifier, getNodesWithQualifier, getNodeWithId, getPosition, getPredecessors, getPrimaryAncestor, getRelativePosition, getRelativePosition, getSequence, getSequenceBuc, getSequences, getSequences, getShortestRelativePosition, getType, indexToAddNode, isLinear, orderSequences, recurNodeSearch, recurSeqSearch, removeAllNodes, removeNode, setSequence, sortNodes, sortNodesByProximity, sortNodesByRelativePosition, update, write, 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, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

m_dblBeamCharge

protected double m_dblBeamCharge

Charge of beam in this sequence (+-1)

m_dblQ2M

protected double m_dblQ2M

particle species charge to mass ratio

m_dblEr

protected double m_dblEr

particle species rest energy

Constructor Detail

AcceleratorSector

public AcceleratorSector(java.lang.String strId)

Creates a new instance of AcceleratorSector

AcceleratorSector

public AcceleratorSector(java.lang.String strId,
                         int intReserve)

Creates a new instance of AcceleratorSector

Method Detail

getChargeSignum

public double getChargeSignum()

Return the signum of design particle species charge

getCharge2Mass

public double getCharge2Mass()

Return the charge to mass ratio of the design particle species

getRestEnergy

public double getRestEnergy()

Return the rest energy of the design particle species

setCharge2Mass

public void setCharge2Mass(double dblQ2M)

Set the charge to mass ratio of the design particle

setChargeSignum

public void setChargeSignum(double dblSgn)

Set the charge sign of the design particle @param dblSgn {-1,+1}

setRestEnergy

public void setRestEnergy(double dblEr)

Set the rest energy of the design particle species

addNode

public boolean addNode(AcceleratorNode node)

Adds node to the Sector at the tail. Sector become the owner of the node. CKA 08.02

Overrides:

addNode in class AcceleratorSeq

Parameters:

node - node to be appended to Sector

Returns:

true if successfully add, false if node already is owned by Sector

concatenate

public AcceleratorSeq concatenate(AcceleratorSector sec)