Package xal.smf

Class AcceleratorSector

java.lang.Object

xal.smf.AcceleratorNode

xal.smf.AcceleratorSeq

xal.smf.AcceleratorSector

All Implemented Interfaces:

Comparable, ElementType, DataListener

public final class AcceleratorSector
extends AcceleratorSeq

Author:

CKAllen

Field Summary

Fields

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

Fields inherited from class xal.smf.AcceleratorSeq

arrNodes, bucSequence, nodeTable, sequences, TYPE

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

Method Summary

Modifier and Type	Method	Description
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, addNode, addNodeAt, addSequenceChain, addSoft, appendNodesOfClassWithQualifier, appendNodesWithQualifier, canPrecede, contains, dataLabel, filterNodesByClass, filterNodesByStatus, formsRing, getAllInclusiveNodes, getAllInclusiveNodes, getAllInclusiveNodesWithQualifier, getAllNodes, getAllNodes, getAllNodesOfType, getAllNodesWithQualifier, getAllSeqs, getAperProfile, getAperProfile, 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, 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, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

dblBeamCharge

protected double dblBeamCharge

Charge of beam in this sequence (+-1)

dblQ2M

protected double dblQ2M

particle species charge to mass ratio

dblEr

protected double dblEr

particle species rest energy

Constructor Details

AcceleratorSector

public AcceleratorSector(String strId)

Creates a new instance of AcceleratorSector

AcceleratorSector

public AcceleratorSector(String strId,
 int intReserve)

Creates a new instance of AcceleratorSector

Method Details

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

concatenate

public AcceleratorSeq concatenate(AcceleratorSector sec)