Uses of Interface
xal.model.IComponent

Packages that use IComponent

Package	Description
xal.extension.jels.model.elem	Combination of modeling elements from TraceWin documentation put into OpenXAL reference frame.
xal.model	The Online Model
xal.model.alg
xal.model.elem	Modeling Elements Package Library
xal.sim.scenario
xal.sim.sync

Uses of IComponent in xal.extension.jels.model.elem

Classes in xal.extension.jels.model.elem that implement IComponent

Modifier and Type	Class	Description
class	IdealMagDipoleFace	Represents the action of a rotated dipole face as a thin lens effect.
class	IdealMagSectorDipole	Represents a bending magnetic dipole magnet for a beam in a sector configuration.
class	IdealMagWedgeDipole	Represents a bending dipole magnet with arbitrary pole face angles.
class	IdealRfGap	Represents the action of an ideal RF gap.
class	RfqDummyModel
class	ThickMagFieldMap	Thick element version for magnetic field map implementation.
class	ThickRfFieldMap	Thick element version for RF field map implementation.
class	ThinMagFieldMap	Magnetic fieldmap 3D implementation.
class	ThinRfFieldMap	Thin element version for RF field map implementation.

Methods in xal.extension.jels.model.elem that return IComponent

Modifier and Type	Method	Description
IComponent	JElsElementMapping.createDefaultDrift(String name, double len)
IComponent	JElsElementMapping.createRfCavityDrift(String name, double len, double freq, double mode)

Methods in xal.extension.jels.model.elem that return types with arguments of type IComponent

Modifier and Type	Method	Description
Class<? extends IComponent>	JElsElementMapping.getDefaultElementType()
Class<? extends IComponent>	JElsElementMapping.getDriftType()
Class<? extends IComponent>	JElsElementMapping.getRfCavityDriftType()

Uses of IComponent in xal.model

Subinterfaces of IComponent in xal.model

Modifier and Type	Interface	Description
interface	IComposite	Represents a composite modeling structure.
interface	IElement	The defining interface for atomic accelerator modeling components.

Classes in xal.model that implement IComponent

Modifier and Type	Class	Description
class	Lattice	High-level container representing a machine model.
class	LineModel	Deprecated. This class is never used
class	RingModel	Deprecated. This class is never used
class	Sector	Represents a logical sector of beamline.

Methods in xal.model that return IComponent

Modifier and Type	Method	Description
IComponent	IComposite.getChild(int index)	Return the direct descendant given by the index.
IComponent	CompositeGlobalIterator.next()

Methods in xal.model that return types with arguments of type IComponent

Modifier and Type	Method	Description
Iterator<IComponent>	IComposite.globalIterator()	Returns iterator over all the components in this composite element in proper sequence.
Iterator<IComponent>	IComposite.localIterator()	Return iterator over direct descendants only of this composite element in sequence.

Methods in xal.model with parameters of type IComponent

Modifier and Type	Method	Description
void	IComposite.addChild(IComponent iComp)	Add a direct child object to the current composite element.
boolean	IComposite.remove(IComponent iComp)	Remove the specified child from the composite element
void	IComposite.setDirty(IComponent cmpCaller)

Uses of IComponent in xal.model.alg

Methods in xal.model.alg with parameters of type IComponent

Modifier and Type	Method	Description
void	SynchronousTracker.propagate(IProbe probe, IComponent elem)	This method was included to deal with RfCavitie objects

Uses of IComponent in xal.model.elem

Classes in xal.model.elem that implement IComponent

Modifier and Type	Class	Description
class	ChargeExchangeFoil	This class is used as a location marker in the modeling lattice.
class	Collimator	This class is used as a location marker in the modeling lattice.
class	ElectromagnetSeq	This class implements IElectromagnet interface for composed magnets.
class	Element	Convenience abstract base class for constructing XAL modeling elements.
class	ElementSeq	Convenience abstract base class for a composite modeling element.
class	IdealDrift	Represents a drift space in a particle beam transport/accelerator system.
class	IdealEDipole	Represents a thick electric dipole magnet for a beam transport/accelerator system.
class	IdealEQuad	Represents an ideal electrostatic quadrupole for a beam transport/accelerator system.
class	IdealHorMagSteeringDipole	Represents an ideal magnetic steering dipole in the horizontal direction.
class	IdealMagDipoleFace	Deprecated. This class has been replaced by IdealMagDipoleFace2
class	IdealMagDipoleFace2	Represents the action of a rotated dipole face as a thin lens effect.
class	IdealMagFringeQuad	Represents a quadrupole magnet with thin face elements which represent fringe field.
class	IdealMagFringeQuadFace	Represents the action of a rotated dipole face as a thin lens effect.
class	IdealMagOctupole	Octupole magnets element Created by Hiroyuki Sako on 11/30/07.
class	IdealMagQuad	Represents an ideal magnetic quadrupole magnet for a beam transport/accelerator system.
class	IdealMagSectorDipole	Deprecated. This class has been replaced by IdealMagSectorDipole2
class	IdealMagSectorDipole2	Represents a bending magnetic dipole magnet for a beam in a sector configuration.
class	IdealMagSextupole	Sextupole magnets element
class	IdealMagSkewQuad	Deprecated. This class has been replaced by IdealMagSkewQuad3
class	IdealMagSkewQuad3	Represents a "skewed" ideal quadrupole magnet.
class	IdealMagSolenoid	Models an ideal solenoid magnet.
class	IdealMagSteeringDipole	Represents the action of an ideal magnetic dipole.
class	IdealMagWedgeDipole	Deprecated. This class has been replaced by IdealMagWedgeDipole2
class	IdealMagWedgeDipole2	Represents a bending dipole magnet with arbitrary pole face angles.
class	IdealPermMagQuad	Represents an ideal permanent magnet quadrupole for a beam transport/accelerator system.
class	IdealRfCavity	This class represents a general RF cavity being an composition of RF gaps and cavity drifts.
class	IdealRfCavityDrift	Represents a drift region between RF cavity accelerating gaps.
class	IdealRfGap	Represents the action of an ideal RF gap.
class	IdealRfGapUpgraded	Represents the action of an ideal RF gap.
class	IdealVerMagSteeringDipole	Represents an ideal magnetic steering dipole in the vertical direction.
class	Marker	This class is used as a location marker in the modeling lattice.
class	SpectrumMapRfGap	Represents the action of an ideal RF gap.
class	ThickDipole	Represents a thick magnetic dipole magnet for a beam transport/accelerator system.
class	ThickElectromagnet	This class implements IElectromagnet interface for thick magnets.
class	ThickElectrostatic	This class implements IElectrostatic interface for thick electrostatics.
class	ThickElement	Base class for all modeling elements having a finite length.
class	ThickMatrix	User element representing a general beamline element.
class	ThinElectromagnet	This class implements IElectromagnet interface for thin magnets.
class	ThinElement	Classes derived from ThinElement are modeled as having no length.
class	ThinLens	Represents a thin lens abstract modeling element in a particle beam transport/accelerator system.
class	ThinMatrix	User element represent a general beamline element.

Methods in xal.model.elem that return IComponent

Modifier and Type	Method	Description
IComponent	ElementSeq.getChild(int indChild)	Get the child IComponent interface at location specified by index.

Methods in xal.model.elem that return types with arguments of type IComponent

Modifier and Type	Method	Description
Iterator<IComponent>	ElementSeq.childIterator()	Return an Iterator object that cycles through all the direct children of the sequence.
List<IComponent>	ElementSeq.getAllElements()	Returns a list of all elements contained in this sequence, more specifically, all leaf elements.
List<IComponent>	ElementSeq.getElementList()	Return the list of IElement objects contained in this sequence.
protected List<IComponent>	ElementSeq.getForwardCompList()	Return the internal list of components
protected List<IComponent>	ElementSeq.getReverseCompList()	Return the reverse component list (downstream to upstream)
Iterator<IComponent>	ElementSeq.globalBackIterator()	Return an Iterator object that iterates over every IComponent object in this composite.
Iterator<IComponent>	ElementSeq.globalIterator()	Return an Iterator object that iterates over every IComponent object in this composite.
Iterator<IComponent>	ElementSeq.iterator()	Returns a shallow iterator for the direct descendants of this composite modeling element.
Iterator<IComponent>	ElementSeq.localBackIterator()	Return an Iterator object that iterates over the direct descendants only of this composite element, in reverse order.
Iterator<IComponent>	ElementSeq.localIterator()	Return an Iterator object that iterates over the direct descendants only of this composite element, in order.

Methods in xal.model.elem with parameters of type IComponent

Modifier and Type	Method	Description
void	ElementSeq.addChild(IComponent iComp)	Add a component object at the tail of the sequence list and at the head of the reverse sequence list.
boolean	ElementSeq.remove(IComponent iCmp)	Remove an element from the entire tree.
void	ElementSeq.setDirty(IComponent cmpCaller)

Method parameters in xal.model.elem with type arguments of type IComponent

Modifier and Type	Method	Description
protected void	ElementSeq.setCompList(List<? extends IComponent> elements)	Set the comp list to the new list of elements.

Uses of IComponent in xal.sim.scenario

Fields in xal.sim.scenario with type parameters of type IComponent

Modifier and Type	Field	Description
protected Class<? extends IComponent>	FileBasedElementMapping.clsDefaultElem	class type of the modeling element used whenever there is no map entry
protected Class<? extends IComponent>	FileBasedElementMapping.clsDriftElem	class type of the general drift spaces created on demand
protected Class<? extends IComponent>	FileBasedElementMapping.clsRfCavDriftElem	class type of the RF cavity drift spaced created on demand
protected Map<String,Class<? extends IComponent>>	ElementMapping.elementMap	The map of hardware type identifier string to modeling element class types.

Methods in xal.sim.scenario that return IComponent

Modifier and Type	Method	Description
IComponent	DefaultElementMapping.createDefaultDrift(String name, double len)	Creates a new, general drift space.
abstract IComponent	ElementMapping.createDefaultDrift(String name, double len)	Different model may have different implementation of the drift element.
IComponent	FileBasedElementMapping.createDefaultDrift(String name, double len)	Creates a general drift space.
IComponent	LatticeElement.createModelingElement()	Creates and initializes a new modeling element represented by this object.
IComponent	DefaultElementMapping.createRfCavityDrift(String name, double len, double freq, double mode)	Creates a drift space within an RF cavity.
abstract IComponent	ElementMapping.createRfCavityDrift(String name, double len, double freq, double mode)	Creates a drift space within an RF cavity structure.
IComponent	FileBasedElementMapping.createRfCavityDrift(String name, double len, double freq, double mode)	Creates a new drift space within a coupled-cavity RF tank.

Methods in xal.sim.scenario that return types with arguments of type IComponent

Modifier and Type	Method	Description
List<IComponent>	Scenario.componentsMappedTo(AcceleratorNode aNode)	Returns a List of components mapped to the specified node.
Class<? extends IComponent>	DefaultElementMapping.getDefaultElementType()	Currently returns the type xal.model.elem.Marker
abstract Class<? extends IComponent>	ElementMapping.getDefaultElementType()	Default converter should produce a general model element like a Marker.
Class<? extends IComponent>	FileBasedElementMapping.getDefaultElementType()	Returns the modeling element type for a hardware node used whenever no specific (hardware,model) association has been defined.
Class<? extends IComponent>	DefaultElementMapping.getDriftType()
abstract Class<? extends IComponent>	ElementMapping.getDriftType()
Class<? extends IComponent>	FileBasedElementMapping.getDriftType()
Class<? extends IComponent>	ElementMapping.getModelElementType(AcceleratorNode node)	Returns modeling element class type used to model the given node.
Class<? extends IComponent>	LatticeElement.getModelingClass()	Returns the class type of the modeling element used to represent the associated hardware node.
Class<? extends IComponent>	DefaultElementMapping.getRfCavityDriftType()
abstract Class<? extends IComponent>	ElementMapping.getRfCavityDriftType()
Class<? extends IComponent>	FileBasedElementMapping.getRfCavityDriftType()

Methods in xal.sim.scenario with parameters of type IComponent

Modifier and Type	Method	Description
void	Scenario.setStartComponent(IComponent start)	Sets the model to start propagation from the specified IComponent.
void	Scenario.setStopComponent(IComponent stop)	Sets the model to stop propagation (by default) after the specified IComponent.

Method parameters in xal.sim.scenario with type arguments of type IComponent

Modifier and Type	Method	Description
protected void	ElementMapping.putMap(String key, Class<? extends IComponent> value)	Adds a converter to the list that's used by default implementation.

Constructor parameters in xal.sim.scenario with type arguments of type IComponent

Modifier	Constructor	Description
	LatticeElement(AcceleratorNode smfNode, double dblPosCtr, Class<? extends IComponent> clsModElemType, int originalPosition)	Initializing constructor for LatticeElement.

Uses of IComponent in xal.sim.sync

Methods in xal.sim.sync that return types with arguments of type IComponent

Modifier and Type	Method	Description
List<IComponent>	SynchronizationManager.allComponentsMappedTo(AcceleratorNode aNode)
protected List<IComponent>	SynchronizationManager.synchronizedComponentsMappedTo(AcceleratorNode aNode)

Methods in xal.sim.sync with parameters of type IComponent

Modifier and Type	Method	Description
void	ElectromagnetSynchronizer.checkSynchronization(IComponent aComp, Map<String,Double> valueMap)
void	PermanentMagnetSynchronizer.checkSynchronization(IComponent aComp, Map<String,Double> valueMap)
void	RfCavitySynchronizer.checkSynchronization(IComponent aComp, Map<String,Double> valueMap)
void	Synchronizer.checkSynchronization(IComponent aComp, Map<String,Double> valueMap)
void	ElectromagnetSynchronizer.resync(IComponent aComp, Map<String,Double> valueMap)
void	PermanentMagnetSynchronizer.resync(IComponent aComp, Map<String,Double> valueMap)
void	RfCavitySynchronizer.resync(IComponent aComp, Map<String,Double> valueMap)
static void	SynchronizationManager.resync(IComponent aComp, Map<String,Double> valueMap)	Synchronizes anElem to the property values contained in valueMap.
void	Synchronizer.resync(IComponent aComp, Map<String,Double> valueMap)
void	SynchronizationManager.synchronize(IComponent aComp, AcceleratorNode aNode)	Creates a synchronization between the specified element and accelerator node.