xal.sim.slg

Class Element

java.lang.Object

xal.sim.slg.Element

All Implemented Interfaces:

java.lang.Cloneable, VisitorListener

Direct Known Subclasses:

Dipole, Drift, EDipole, EQuad, Octupole, Quadrupole, Sextupole, SkewQuad, SkewSext, Solenoid, ThinElement

public abstract class Element
extends java.lang.Object
implements VisitorListener, java.lang.Cloneable

The super class of all lattice elements.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Element.SECTION Indicates the component relationship of this model representation with respect to its hardware counterpart.

Field Summary

Fields

Modifier and Type	Field and Description
static java.text.NumberFormat	fmt
protected boolean	handleAsThick

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Element(Element.SECTION secHware, java.lang.String name, double position, double len) Create a new, initialized Element object.
protected	Element(java.lang.String name, double position, double len) Creates a new instance of Element

Method Summary

Modifier and Type	Method and Description
abstract void	accept(Visitor v) When called with a Visitor reference the implementor can either reject to be visited (empty method body) or call the Visitor by passing its own object reference.
java.lang.Object	clone()
AcceleratorNode	getAcceleratorNode() The XAL AcceleratorNode property.
double	getBase() Return the base for relative positions.
double	getEndPosition() Return the downstream end position of this element
java.lang.String	getFam()
Element.SECTION	getHardwareSection() Returns the hardware subsection that this element represents.
double	getLength() Return the length of this element in distance units.
java.lang.String	getName() Return the name of this element.
double	getPosition() Return the center position of this element
double	getStartPosition() Return the upstream start position of this element.
abstract java.lang.String	getType() Return the element type.
boolean	isThick() Is this really a thick element?
void	setAcceleratorNode(AcceleratorNode node) The XAL AcceleratorNode property.
void	setBase(double base) Set the base for relative positions.
void	setHardwareSection(Element.SECTION secHware) Set the hardware section that this element represents.
void	setLength(double length) Set the element length.
void	setPosition(double position) Set the element's center position.
protected java.util.List<Element>	split(Element insert)
double	toAbsolutePosition(double position) Convert to absolute position
java.lang.String	toCoutString() Returns a printable string of this element.
static java.lang.String	version() Return a version string wo the cvs keyword (i.e.

Methods inherited from class java.lang.Object

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

Field Detail

fmt

public static java.text.NumberFormat fmt

handleAsThick

protected boolean handleAsThick

Constructor Detail

Element

protected Element(java.lang.String name,
                  double position,
                  double len)

Creates a new instance of Element

Element

protected Element(Element.SECTION secHware,
                  java.lang.String name,
                  double position,
                  double len)

Create a new, initialized Element object.

Parameters:

secHware - element's hardware subsection

name - string identifier for the element

position - position of the element within the lattice

len - length of the element

Since:

Sep 2, 2009

Method Detail

clone

public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException

Overrides:

clone in class java.lang.Object

Throws:

java.lang.CloneNotSupportedException

setAcceleratorNode

public void setAcceleratorNode(AcceleratorNode node)

The XAL AcceleratorNode property.

getAcceleratorNode

public AcceleratorNode getAcceleratorNode()

The XAL AcceleratorNode property.

setHardwareSection

public void setHardwareSection(Element.SECTION secHware)

Set the hardware section that this element represents.

Parameters:

secHware - enumeration of possible hardware subsections

Since:

Sep 2, 2009

getHardwareSection

public Element.SECTION getHardwareSection()

Returns the hardware subsection that this element represents.

Returns:

the model element's corresponding hardware subsection

Since:

Sep 2, 2009

getType

public abstract java.lang.String getType()

Return the element type.

isThick

public boolean isThick()

Is this really a thick element?

Returns:

true if element is to be treated as a thick element, i.e. appended to the lattice in phase 1 of lattice generation; false if element is treated as a thin element; i.e. inserted in the lattice in phase 2 of lattice generation.

getStartPosition

public double getStartPosition()

Return the upstream start position of this element.

getEndPosition

public double getEndPosition()

Return the downstream end position of this element

getPosition

public double getPosition()

Return the center position of this element

toAbsolutePosition

public double toAbsolutePosition(double position)

Convert to absolute position

getLength

public double getLength()

Return the length of this element in distance units.

getName

public java.lang.String getName()

Return the name of this element.

getBase

public double getBase()

Return the base for relative positions.

setBase

public void setBase(double base)

Set the base for relative positions.

setPosition

public void setPosition(double position)

Set the element's center position.

setLength

public void setLength(double length)

Set the element length.

split

protected java.util.List<Element> split(Element insert)
                                 throws LatticeError

Throws:

LatticeError

toCoutString

public java.lang.String toCoutString()

Returns a printable string of this element.

getFam

public java.lang.String getFam()

version

public static java.lang.String version()

Return a version string wo the cvs keyword (i.e. Id).

accept

public abstract void accept(Visitor v)

When called with a Visitor reference the implementor can either reject to be visited (empty method body) or call the Visitor by passing its own object reference.

Specified by:

accept in interface VisitorListener

Parameters:

v - the Visitor which wants to visit this object.