public class Lattice extends ElementSeq
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 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.
|
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
|
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
public static final int s_szDefReserve
public static final java.lang.String s_strType
public Lattice()
public Lattice(java.lang.String strId)
strId
- identifier of the latticepublic Lattice(java.lang.String strId, int szReserve)
strId
- identifier of the latticeszReserve
- number of Element spaces to reservepublic void setVersion(java.lang.String strVersion)
strVersion
- revision number of latticepublic void setAuthor(java.lang.String strAuthor)
strAuthor
- author of lattice descriptionpublic void setDate(java.lang.String strDate)
strDate
- date string of lattice descriptionpublic void addLine(LineModel mdlLine)
mdlLine
- ignoredIComponent.propagate(xal.model.IProbe)
public void propagate(IProbe probe) throws ModelException
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.propagate
in interface IComponent
propagate
in interface IComposite
propagate
in class ElementSeq
probe
- the state of the probe will be advance using the elements dynamicsModelException
- an error occurred while advancing the probe stateIComponent.propagate(IProbe)
public void backPropagate(IProbe probe) throws ModelException
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!
backPropagate
in interface IComponent
backPropagate
in class ElementSeq
probe
- the state of the probe will be advance using the elements dynamicsModelException
- an error occurred while advancing the probe statepublic java.lang.String getVersion()
public java.lang.String getAuthor()
public java.lang.String getDate()
public java.util.List<RingModel> getRings()
RingModel
objects contained in this model.RingModel
objects within modelpublic java.util.List<LineModel> getLines()
LineModel
objects contained in this model.LineModel
objects within modelpublic org.w3c.dom.Document asDocument() throws java.io.IOException
java.io.IOException
- I guess this is thrown when LatticeXmlWriter
is unable to parse this latticepublic void print(java.io.PrintWriter os)
print
in class ElementSeq
os
- output stream object