gov.sns.xal.model
Class RingModel

java.lang.Object
  |
  +--gov.sns.xal.model.elem.ElementSeq
        |
        +--gov.sns.xal.model.RingModel

All Implemented Interfaces:

IComponent, IComposite

public class RingModel

extends ElementSeq

Field Summary

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

RingModel()
Creates a new, empty instance of RingModel.

RingModel(java.lang.String strId)
Creates a new instance of RingModel with specified string identifier.

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

Method Summary

CorrelationMatrix	compClosedOrbit(SynchronousProbe probe)
PhaseMatrix	compOneTurnMatrix(SynchronousProbe probe)
java.lang.String	getAuthor() Get the author of the lattice definition
java.lang.String	getDate() Get the date of lattice description
java.lang.String	getVersion() Get the version of the lattice
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 verion tag

Methods inherited from class gov.sns.xal.model.elem.ElementSeq

addChild, childIterator, concatenateEquals, getChild, getChildCount, getComments, getId, getLeafCount, getLength, getType, globalIterator, localIterator, print, remove, setComments, setId

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, 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

RingModel

public RingModel()

Creates a new, empty instance of RingModel.

RingModel

public RingModel(java.lang.String strId)

Creates a new instance of RingModel with specified string identifier.

Parameters:

strId - identifier of the lattice

RingModel

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

Creates a new instance of RingModel 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 verion 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

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 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

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

compOneTurnMatrix

public PhaseMatrix compOneTurnMatrix(SynchronousProbe probe)

compClosedOrbit

public CorrelationMatrix compClosedOrbit(SynchronousProbe probe)