xal.sim.scenario

Class ElementMapping

java.lang.Object

xal.sim.scenario.ElementMapping

Direct Known Subclasses:

DefaultElementMapping, FileBasedElementMapping

public abstract class ElementMapping
extends java.lang.Object

This is an abstract class to provide mapping from SMF nodes to online model elements

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.List<java.util.Map.Entry<java.lang.String,java.lang.Class<? extends IComponent>>>	elementMapping

Constructor Summary

Constructors

Constructor and Description
ElementMapping()

Method Summary

Modifier and Type	Method and Description
abstract IComponent	createDrift(java.lang.String name, double len) Different model may have different implementation of the drift element.
java.lang.Class<? extends IComponent>	getConverter(AcceleratorNode node) Returns converter for the given node.
abstract java.lang.Class<? extends IComponent>	getDefaultConverter() Default converter should produce a general model element like a Marker.
protected void	putMap(java.lang.String key, java.lang.Class<? extends IComponent> value) Adds a converter to the list that's used by default implementation.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

elementMapping

protected java.util.List<java.util.Map.Entry<java.lang.String,java.lang.Class<? extends IComponent>>> elementMapping

Constructor Detail

ElementMapping

public ElementMapping()

Method Detail

getDefaultConverter

public abstract java.lang.Class<? extends IComponent> getDefaultConverter()

Default converter should produce a general model element like a Marker. It is used when no other converters have been found.

Returns:

default converter

createDrift

public abstract IComponent createDrift(java.lang.String name,
                                       double len)
                                throws ModelException

Different model may have different implementation of the drift element.

Returns:

drift model element

Throws:

ModelException

getConverter

public java.lang.Class<? extends IComponent> getConverter(AcceleratorNode node)

Returns converter for the given node. Default implementation traverses a list and returns first good converter.

Parameters:

node - the SMF node

Returns:

converter for this node

Throws:

java.lang.IllegalAccessException

java.lang.InstantiationException

putMap

protected void putMap(java.lang.String key,
                      java.lang.Class<? extends IComponent> value)

Adds a converter to the list that's used by default implementation.

Parameters:

key - node type

value - the converter