gov.sns.xal.model
Interface IComponent

All Known Subinterfaces:

IComposite, IElement

All Known Implementing Classes:

Element, ElementSeq

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

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	propagate(IProbe probe) Propagates the Probe object through this component.

Method Detail

getType

public java.lang.String getType()

Get the string type identifier for the composite element

Returns:

type indentifier for this element

getId

public java.lang.String getId()

Get the string identifier of the composite element

Returns:

string identifier

getLength

public double getLength()

Return the total length of the composite element.

Returns:

length of the element (in meters)

propagate

public 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