xal.model

Class Lattice

java.lang.Object

xal.model.elem.ElementSeq

xal.model.Lattice

All Implemented Interfaces:

IComponent, IComposite

public class Lattice
extends ElementSeq

High-level container representing a machine model.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	s_strType the string type identifier for all Lattice objects
static int	s_szDefReserve default number of element positions to reserve in list array

Constructor Summary

Constructors

Constructor and Description
Lattice() Creates a new instance of Lattice
Lattice(java.lang.String strId) Creates a new instance of Lattice
Lattice(java.lang.String strId, int szReserve) Creates a new instance of Lattice and reserves space for a szReserve length lattice.

Method Summary

Modifier and Type	Method and Description
void	addLine(LineModel mdlLine) This does nothing at the moment.
org.w3c.dom.Document	asDocument() Returns a DOM document for the lattice.
void	backPropagate(IProbe probe) Backward propagation of a probe through the lattice.
java.lang.String	getAuthor() Get the author of the lattice definition
java.lang.String	getDate() Get the date of lattice description
java.util.List<LineModel>	getLines() Return a list of the LineModel objects contained in this model.
java.util.List<RingModel>	getRings() Return a list of the RingModel objects contained in this model.
java.lang.String	getVersion() Get the version of the lattice
void	print(java.io.PrintWriter os) Dump current state and content to output stream.
void	propagate(IProbe probe) Propagate a probe through the lattice.
void	setAuthor(java.lang.String strAuthor) Sets the author tag
void	setDate(java.lang.String strDate) Sets the date tag
void	setVersion(java.lang.String strVersion) Sets the version tag

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, propagate, remove, setComments, setCompList, setHardwareNodeId, setId, toString

Methods inherited from class java.lang.Object

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

Field Detail

s_szDefReserve

public static final int s_szDefReserve

default number of element positions to reserve in list array

See Also:

Constant Field Values

s_strType

public static final java.lang.String s_strType

the string type identifier for all Lattice objects

See Also:

Constant Field Values

Constructor Detail

Lattice

public Lattice()

Creates a new instance of Lattice

Lattice

public Lattice(java.lang.String strId)

Creates a new instance of Lattice

Parameters:

strId - identifier of the lattice

Lattice

public Lattice(java.lang.String strId,
               int szReserve)

Creates a new instance of Lattice and reserves space for a szReserve length lattice.

Parameters:

strId - identifier of the lattice

szReserve - number of Element spaces to reserve

Method Detail

setVersion

public void setVersion(java.lang.String strVersion)

Sets the version tag

Parameters:

strVersion - revision number of lattice

setAuthor

public void setAuthor(java.lang.String strAuthor)

Sets the author tag

Parameters:

strAuthor - author of lattice description

setDate

public void setDate(java.lang.String strDate)

Sets the date tag

Parameters:

strDate - date string of lattice description

addLine

public void addLine(LineModel mdlLine)

This does nothing at the moment. Add a new line to the model.

Parameters:

mdlLine - ignored

See Also:

IComponent.propagate(xal.model.IProbe)

propagate

public void propagate(IProbe probe)
               throws ModelException

Propagate a probe through the lattice. The probe is first initialized by calling the initialize() method of the probe then updated by calling the update() method in order to save the initial state of the probe into its trajectory.

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

See Also:

IComponent.propagate(IProbe)

backPropagate

public void backPropagate(IProbe probe)
                   throws ModelException

Backward propagation of a probe through the lattice.

The probe is first initialized by calling the initialize() method of the probe then updated by calling the update() method in order to save the initial state of the probe into its trajectory.

NOTES: CKA
· Support for backward propagation February, 2009.
· You must use the proper algorithm object for this method to work correctly!

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

getVersion

public java.lang.String getVersion()

Get the version of the lattice

Returns:

lattice revision number

getAuthor

public java.lang.String getAuthor()

Get the author of the lattice definition

Returns:

lattice author

getDate

public java.lang.String getDate()

Get the date of lattice description

Returns:

lattice model date

getRings

public java.util.List<RingModel> getRings()

Return a list of the RingModel objects contained in this model.

Returns:

ordered list of all RingModel objects within model

getLines

public java.util.List<LineModel> getLines()

Return a list of the LineModel objects contained in this model.

Returns:

ordered list of all LineModel objects within model

asDocument

public org.w3c.dom.Document asDocument()
                                throws java.io.IOException

Returns a DOM document for the lattice.

Returns:

a DOM document for the lattice

Throws:

java.io.IOException - I guess this is thrown when LatticeXmlWriter is unable to parse this lattice

print

public void print(java.io.PrintWriter os)

Dump current state and content to output stream.

Overrides:

print in class ElementSeq

Parameters:

os - output stream object