xal.model

Class LineModel

java.lang.Object

xal.model.elem.ElementSeq

xal.model.LineModel

All Implemented Interfaces:

IComponent, IComposite

public class LineModel
extends ElementSeq

Represents a model lattice for a linear accelerating structure. Or in other words, and accelerator line.

Field Summary

Fields inherited from class xal.model.elem.ElementSeq

s_szDefReserve

Constructor Summary

Constructors

Constructor and Description
LineModel(java.lang.String strType) Create a new LineModel object with the given string type identifier.
LineModel(java.lang.String strType, java.lang.String strId) Create a new LineModel object with the given type and given string identifier.
LineModel(java.lang.String strType, java.lang.String strId, int szReserve) Create a new LineModel object with the given type, given string identifier, and while reserving the given number of positions for internal modeling elements.

Method Summary

Modifier and Type	Method and Description
void	backPropagate(IProbe probe) Override of ElementSeq.backPropagate(xal.model.IProbe)
void	propagate(IProbe probe) Override of ElementSeq.propagate(xal.model.IProbe)

Methods inherited from class xal.model.elem.ElementSeq

addChild, backPropagate, childIterator, concatenateEquals, getAllElements, getChild, getChildCount, getComments, getCompList, getElementList, getHardwareNodeId, getId, getLeafCount, getLength, getReverseCompList, getType, globalBackIterator, globalIterator, initializeFrom, localBackIterator, localIterator, print, propagate, remove, setComments, setCompList, setHardwareNodeId, setId, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

LineModel

public LineModel(java.lang.String strType)

Create a new LineModel object with the given string type identifier. The type refers to the type of accelerating structure this models.

Parameters:

strType - this object's type class (name)

Since:

May 28, 2004

LineModel

public LineModel(java.lang.String strType,
                 java.lang.String strId)

Create a new LineModel object with the given type and given string identifier.

Parameters:

strType - the type class of the accelerating structure

strId - the identifier of this particular structure

Since:

May 28, 2004

LineModel

public LineModel(java.lang.String strType,
                 java.lang.String strId,
                 int szReserve)

Create a new LineModel object with the given type, given string identifier, and while reserving the given number of positions for internal modeling elements. Note that if the number of child elements grows large than the reservation number, extra space is automatically allocated. It's just faster to use this feature if you do know the size of the child set.

Parameters:

strType - the type class of the accelerating structure

strId - the identifier of this particular structure

szReserve - reserve allocation size for child modeling elements

Since:

May 28, 2004

Method Detail

propagate

public void propagate(IProbe probe)
               throws ModelException

Override of ElementSeq.propagate(xal.model.IProbe)

Specified by:

propagate in interface IComponent

Specified by:

propagate in interface IComposite

Overrides:

propagate in class ElementSeq

Parameters:

probe - the state of the probe will be advance using the elements dynamics

Throws:

ModelException - an error occurred while advancing the probe state

Since:

Feb 27, 2009

See Also:

ElementSeq.propagate(xal.model.IProbe)

backPropagate

public void backPropagate(IProbe probe)
                   throws ModelException

Override of ElementSeq.backPropagate(xal.model.IProbe)

Specified by:

backPropagate in interface IComponent

Overrides:

backPropagate in class ElementSeq

Parameters:

probe - the state of the probe will be advance using the elements dynamics

Throws:

ModelException - an error occurred while advancing the probe state

Since:

Feb 27, 2009

See Also:

ElementSeq.backPropagate(xal.model.IProbe)