|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--gov.sns.xal.model.elem.Element
Convenience abstract base class for constructing XAL modeling elements.
This class implements many of the general methods for the
IElement
interface that are not element specific.
Field Summary |
Fields inherited from interface gov.sns.xal.model.IElement |
LightSpeed, Permeability, Permittivity, UnitCharge |
Constructor Summary | |
Element(java.lang.String strType)
Creates a new instance of Element |
|
Element(java.lang.String strType,
java.lang.String strId)
Creates a new instance of Element |
Method Summary | |
double |
compDriftingTime(IProbe probe,
double dblLen)
Compute the time the probe probe spends drifting a
a distance dblLen . |
abstract double |
elapsedTime(IProbe probe,
double dblLen)
Returns the time taken for the probe probe to propagate
through a subsection of the element with length dblLen . |
abstract double |
energyGain(IProbe probe,
double dblLen)
Returns energy gain for subsection of this element of length dblLen for the specified given probe. |
java.lang.String |
getId()
Returns the string identifier for this element. |
abstract double |
getLength()
Return the length of this element. |
java.lang.String |
getType()
Return the element type identifier |
int |
getUID()
Return the internal class unique identifier of this element. |
void |
initializeFrom(IModelDataSource source)
Initialize this Element from the supplied object. |
void |
print(java.io.PrintWriter os)
Dump current state and content to output stream. |
void |
propagate(IProbe probe)
Propagates the Probe object through this element based on the associated algorithm. |
void |
setId(java.lang.String strId)
Set the string identifier for the element. |
abstract PhaseMap |
transferMap(IProbe probe,
double dblLen)
Compute the tranfer matrix for subsection of this element of length dblLen for the specified given probe. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public Element(java.lang.String strType)
strType
- type identifier of the elementpublic Element(java.lang.String strType, java.lang.String strId)
strType
- type identifier of the elementstrId
- string identifier of the elementMethod Detail |
public abstract double getLength()
getLength
in interface IComponent
public abstract double elapsedTime(IProbe probe, double dblLen)
probe
to propagate
through a subsection of the element with length dblLen
.
elapsedTime
in interface IElement
probe
- determine energy gain for this probedblLen
- length of subsection to calculate energy gain for
public abstract double energyGain(IProbe probe, double dblLen)
dblLen
for the specified given probe.
energyGain
in interface IElement
probe
- determine energy gain for this probedblLen
- length of subsection to calculate energy gain
public abstract PhaseMap transferMap(IProbe probe, double dblLen) throws ModelException
dblLen
for the specified given probe. That is, this method should
return the incremental transfer matrix.
transferMap
in interface IElement
dblLen
- length of subelementprobe
- probe containing parameters for the subsectional transfer matrix
ModelException
- unable to compute transfer map#transferMap()
public void initializeFrom(IModelDataSource source) throws ModelException
initializeFrom
in interface IElement
source
- object to initialize element from
ModelException
- if error initializing from sourcepublic void setId(java.lang.String strId)
strId
- new string identifier for elementpublic int getUID()
public java.lang.String getType()
getType
in interface IComponent
public java.lang.String getId()
getId
in interface IComponent
public void propagate(IProbe probe) throws ModelException
propagate
in interface IComponent
probe
- probe object to propagate
ModelException
- error occurred during propagationpublic double compDriftingTime(IProbe probe, double dblLen)
probe
spends drifting a
a distance dblLen
.
probe
- interface to drifting probedblLen
- length of drift in meters
public void print(java.io.PrintWriter os)
os
- output stream object
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |