Package xal.sim.scenario

Class FileBasedElementMapping

java.lang.Object

xal.sim.scenario.ElementMapping

xal.sim.scenario.FileBasedElementMapping

public class FileBasedElementMapping
extends ElementMapping

The default element mapping implemented as singleton.

The convention is to name the mapping definition file ModelConfig.modconfig and place it in the same directory as the Open XAL master configuration file main.xal. A entry reference to the mapping definition is made within the main configuration file.

CKA NOTES - Dec 3, 2014

· The class no longer appears to be a singleton. You may create multiple instances using the same or difference mapping definition files.

Since:

Jan 27, 2014

Author:

Ivo List

Field Summary

Fields

Modifier and Type	Field	Description
protected Class<? extends IComponent>	clsDefaultElem	class type of the modeling element used whenever there is no map entry
protected Class<? extends IComposite>	clsDefaultSeq	class type of the modeling element used whenever there is no map entry for a hardware sequence
protected Class<? extends IComponent>	clsDriftElem	class type of the general drift spaces created on demand
protected Class<? extends IComponent>	clsRfCavDriftElem	class type of the RF cavity drift spaced created on demand
static final String	ELEMENT_MAPPING_SCHEMA	Model Configuration schema
protected static ElementMapping	instance	Deprecated. CKA - never used

Fields inherited from class xal.sim.scenario.ElementMapping

bolDebug, bolDivMags, bolSubsectionCtrOrigin, elementMap

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	FileBasedElementMapping()	Constructor for the singleton FileBasedElementMapping.
	FileBasedElementMapping(ElementMapping elementMapping)

Method Summary

Modifier and Type	Method	Description
IComponent	createDefaultDrift(String name, double len)	Creates a general drift space.
IComponent	createRfCavityDrift(String name, double len, double freq, double mode)	Creates a new drift space within a coupled-cavity RF tank.
Class<? extends IComponent>	getDefaultElementType()	Returns the modeling element type for a hardware node used whenever no specific (hardware,model) association has been defined.
Class<? extends IComposite>	getDefaultSequenceType()	Returns the modeling element type for a hardware sequence used whenever no specific (hardware,model) association has been defined.
Class<? extends IComponent>	getDriftType()
Class<? extends IComponent>	getRfCavityDriftType()
static ElementMapping	loadFrom(String urlModelConfig, String schemaUrl)	Creates a new element mapping objects from the given definition file and its provided schema.
void	saveTo(String urlModelConfig)
void	setDefaultElement(String stringValue)
void	setDefaultSequence(String strClassType)
void	setDrift(String stringValue)
void	setRfCavityDrift(String strClsName)

Methods inherited from class xal.sim.scenario.ElementMapping

getModelElementType, getModelSequenceType, isDebugging, isMagnetDivided, isSubsectionAxisOriginCentered, putMap, removeMap, setDebug, setDivideMagnetFlag

Methods inherited from class java.lang.Object

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

Field Details

ELEMENT_MAPPING_SCHEMA

public static final String ELEMENT_MAPPING_SCHEMA

Model Configuration schema

See Also:

• Constant Field Values

instance

@Deprecated
protected static ElementMapping instance

Deprecated.

CKA - never used

The class singleton instance

clsDefaultElem

protected Class<? extends IComponent> clsDefaultElem

class type of the modeling element used whenever there is no map entry

clsDefaultSeq

protected Class<? extends IComposite> clsDefaultSeq

class type of the modeling element used whenever there is no map entry for a hardware sequence

clsDriftElem

protected Class<? extends IComponent> clsDriftElem

class type of the general drift spaces created on demand

clsRfCavDriftElem

protected Class<? extends IComponent> clsRfCavDriftElem

class type of the RF cavity drift spaced created on demand

Constructor Details

FileBasedElementMapping

protected FileBasedElementMapping()

Constructor for the singleton FileBasedElementMapping.

Since:

Dec 3, 2014

FileBasedElementMapping

public FileBasedElementMapping(ElementMapping elementMapping)

Method Details

loadFrom

public static ElementMapping loadFrom(String urlModelConfig,
 String schemaUrl)

Creates a new element mapping objects from the given definition file and its provided schema. This file should contain a set of (hardware type id, model class type) pairs arranged according to the given schema. It is usually named ModelConfig.modconfig

Current the default element type is set to Marker and the default sequence type is set to Sector

Parameters:

urlModelConfig - location of the element mapping definition file

schemaUrl - location of the schema definition file (i.e., xsd file)

Returns:

a new element mapping object defined according to the given file

Since:

Dec 3, 2014

saveTo

public void saveTo(String urlModelConfig)

Since:

Feb 25, 2021

getDefaultElementType

public Class<? extends IComponent> getDefaultElementType()

Returns the modeling element type for a hardware node used whenever no specific (hardware,model) association has been defined.

This value is initialized in global method loadFrom(String, String).

Specified by:

getDefaultElementType in class ElementMapping

Returns:

default class type used when none is defined

Since:

Dec 5, 2014 @author Christopher K. Allen

See Also:

• ElementMapping.getDefaultElementType()

getDefaultSequenceType

public Class<? extends IComposite> getDefaultSequenceType()

Returns the modeling element type for a hardware sequence used whenever no specific (hardware,model) association has been defined.

This value is initialized in global method loadFrom(String, String).

Specified by:

getDefaultSequenceType in class ElementMapping

Returns:

default class type used to model hardware sequences

Since:

Dec 5, 2014 @author Christopher K. Allen

See Also:

• ElementMapping.getDefaultSequenceType()

createDefaultDrift

public IComponent createDefaultDrift(String name,
 double len)
                              throws ModelException

Creates a general drift space.

Specified by:

createDefaultDrift in class ElementMapping

Returns:

drift model element

Throws:

ModelException

Since:

Dec 3, 2014

See Also:

• ElementMapping.createDefaultDrift(java.lang.String, double)

createRfCavityDrift

public IComponent createRfCavityDrift(String name,
 double len,
 double freq,
 double mode)
                               throws ModelException

Creates a new drift space within a coupled-cavity RF tank.

Specified by:

createRfCavityDrift in class ElementMapping

Parameters:

name - string identifier of the drift space

len - length of drift space (meters)

freq - design frequency of the enclosing RF cavity

mode - structure mode coupling the cavities within the tank

Returns:

a new RF cavity drift space

Throws:

ModelException - an exception occurred while constructing the element

Since:

Dec 3, 2014

See Also:

• ElementMapping.createRfCavityDrift(java.lang.String, double, double, double)

setDefaultElement

public void setDefaultElement(String stringValue)
                       throws ClassNotFoundException

Throws:

ClassNotFoundException

setDefaultSequence

public void setDefaultSequence(String strClassType)
                        throws ClassNotFoundException

Throws:

ClassNotFoundException

setDrift

public void setDrift(String stringValue)
              throws ClassNotFoundException

Throws:

ClassNotFoundException

getDriftType

public Class<? extends IComponent> getDriftType()

Specified by:

getDriftType in class ElementMapping

setRfCavityDrift

public void setRfCavityDrift(String strClsName)
                      throws ClassNotFoundException

Throws:

ClassNotFoundException

getRfCavityDriftType

public Class<? extends IComponent> getRfCavityDriftType()

Specified by:

getRfCavityDriftType in class ElementMapping