xal.sim.scenario

Class LatticeElement

java.lang.Object

xal.sim.scenario.LatticeElement

All Implemented Interfaces:

java.lang.Comparable<LatticeElement>

public class LatticeElement
extends java.lang.Object
implements java.lang.Comparable<LatticeElement>

CKA NOTES:

· I have modified this objects so it carries the additional attribute of the modeling element identifier. This is in contrast to the hardware node identifier from which it maps.

· The idea is that probes states produced by simulation will carry this attribute if it has been set. If not, then the probe state will have the same attribute ID as the hardware node.

· Note that probe states now carry two identifier attributes, one for the modeling element, and one for the SMF hardware node from which it came.

Since:

Oct 3, 2013

Constructor Summary

Constructors

Constructor and Description
LatticeElement(AcceleratorNode node, double position, java.lang.Class<? extends IComponent> elementClass, int originalPosition)

Method Summary

Modifier and Type	Method and Description
int	compareTo(LatticeElement e2)
IComponent	convert()
double	getCenter()
double	getEndPosition()
double	getLength()
java.lang.String	getModelingElementId() Returns the identifier string to be used for the modeling element created by this object.
AcceleratorNode	getNode()
int	getPartNr()
int	getParts()
double	getStartPosition()
boolean	isThin()
void	setModelingElementId(java.lang.String strElemId) Sets the (optional) string identifier for the modeling element that this object will create.
LatticeElement	split(LatticeElement splitter)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

LatticeElement

public LatticeElement(AcceleratorNode node,
                      double position,
                      java.lang.Class<? extends IComponent> elementClass,
                      int originalPosition)

Method Detail

setModelingElementId

public void setModelingElementId(java.lang.String strElemId)

Sets the (optional) string identifier for the modeling element that this object will create.

Parameters:

strElemId - identifier for the modeling element created

Since:

Sep 5, 2014

getModelingElementId

public java.lang.String getModelingElementId()

Returns the identifier string to be used for the modeling element created by this object.

Returns:

the element ID of the created object

Since:

Sep 5, 2014

getStartPosition

public double getStartPosition()

getLength

public double getLength()

getNode

public AcceleratorNode getNode()

getCenter

public double getCenter()

getEndPosition

public double getEndPosition()

split

public LatticeElement split(LatticeElement splitter)

isThin

public boolean isThin()

convert

public IComponent convert()
                   throws ModelException

Throws:

ModelException

compareTo

public int compareTo(LatticeElement e2)

Specified by:

compareTo in interface java.lang.Comparable<LatticeElement>

getPartNr

public int getPartNr()

getParts

public int getParts()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object