xal.model

Interface IComponent

All Known Subinterfaces:

IComposite, IElement

All Known Implementing Classes:

ChargeExchangeFoil, Collimator, ElectromagnetSeq, Element, ElementSeq, IdealDrift, IdealEDipole, IdealEQuad, IdealHorMagSteeringDipole, IdealMagDipoleFace, IdealMagDipoleFace2, IdealMagFringeQuad, IdealMagFringeQuadFace, IdealMagOctupole, IdealMagQuad, IdealMagSectorDipole, IdealMagSectorDipole2, IdealMagSextupole, IdealMagSkewQuad, IdealMagSkewQuad3, IdealMagSolenoid, IdealMagSteeringDipole, IdealMagWedgeDipole, IdealMagWedgeDipole2, IdealPermMagQuad, IdealRfGap, IdealVerMagSteeringDipole, Lattice, LineModel, Marker, RingModel, Sector, ThickDipole, ThickElectromagnet, ThickElectrostatic, ThickElement, ThickMatrix, ThinElectromagnet, ThinElement, ThinLens, ThinMatrix

public interface IComponent

Base interface for any structural modeling object. Interfaces derived from this base interface are assumed to model some aspect of the accelerator hardware.

Method Summary

Modifier and Type	Method and Description
void	backPropagate(IProbe probe) Propagates the Probe object through this component.
void	backPropagate(IProbe probe, double d) Position dependent tracking within an IElement
java.lang.String	getHardwareNodeId() Get the string identifier of the hardware node being modeled by this element.
java.lang.String	getId() Get the string identifier of the composite element
double	getLength() Return the total length of the composite element.
java.lang.String	getType() Get the string type identifier for the composite element
void	initializeFrom(LatticeElement latticeElement) Conversion method to be provided by the user
void	propagate(IProbe probe) Propagates the Probe object through this component.
void	propagate(IProbe probe, double d) Position dependent tracking within an IElement

Method Detail

getType

java.lang.String getType()

Get the string type identifier for the composite element

Returns:

type identifier for this element

getId

java.lang.String getId()

Get the string identifier of the composite element

Returns:

string identifier

getHardwareNodeId

java.lang.String getHardwareNodeId()

Get the string identifier of the hardware node being modeled by this element.

Returns:

SMF hardware node this element maps to

initializeFrom

void initializeFrom(LatticeElement latticeElement)

Conversion method to be provided by the user

Parameters:

latticeElement - the SMF node to convert

getLength

double getLength()

Return the total length of the composite element.

Returns:

length of the element (in meters)

propagate

void propagate(IProbe probe)
        throws ModelException

Propagates the Probe object through this component.

Parameters:

probe - probe to be propagate - its state is advanced

Throws:

ModelException - error advancing the probe state

propagate

void propagate(IProbe probe,
               double d)
        throws ModelException

Position dependent tracking within an IElement

Throws:

ModelException

backPropagate

void backPropagate(IProbe probe)
            throws ModelException

Propagates the Probe object through this component.

NOTES: CKA
· Support for backward propagation February, 2009.

Parameters:

probe - probe to be propagate - its state is advanced

Throws:

ModelException - error advancing the probe state

backPropagate

void backPropagate(IProbe probe,
                   double d)
            throws ModelException

Position dependent tracking within an IElement

NOTES: CKA
· Support for backward propagation February, 2009.

Parameters:

probe - probe to be propagate - its state is advanced

d - position within element

Throws:

ModelException - error advancing the probe state

Since:

Feb 27, 2009