Package xal.sim.scenario

Class DefaultElementMapping

java.lang.Object

xal.sim.scenario.ElementMapping

xal.sim.scenario.DefaultElementMapping

public class DefaultElementMapping
extends ElementMapping

The default element mapping implemented as singleton.

Author:

Ivo List

Field Summary

Fields

Modifier and Type	Field	Description
protected static ElementMapping	instance

Fields inherited from class xal.sim.scenario.ElementMapping

bolDebug, bolDivMags, bolSubsectionCtrOrigin, elementMap

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	DefaultElementMapping()

Method Summary

Modifier and Type	Method	Description
IComponent	createDefaultDrift(String name, double len)	Creates a new, general drift space.
IComponent	createRfCavityDrift(String name, double len, double freq, double mode)	Creates a drift space within an RF cavity.
Class<? extends IComponent>	getDefaultElementType()	Currently returns the type xal.model.elem.Marker
Class<? extends IComposite>	getDefaultSequenceType()	Currently returns the type xal.model.Sector
Class<? extends IComponent>	getDriftType()
static ElementMapping	getInstance()	Returns the default element mapping.
Class<? extends IComponent>	getRfCavityDriftType()
protected void	initialize()

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

instance

protected static ElementMapping instance

Constructor Details

DefaultElementMapping

protected DefaultElementMapping()

Method Details

getInstance

public static ElementMapping getInstance()

Returns the default element mapping.

Returns:

the default element mapping

getDefaultElementType

public Class<? extends IComponent> getDefaultElementType()

Currently returns the type xal.model.elem.Marker

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()

Currently returns the type xal.model.Sector

Specified by:

getDefaultSequenceType in class ElementMapping

Returns:

default class type used to model hardware sequences

Since:

Dec 5, 2014

See Also:

• ElementMapping.getDefaultSequenceType()

getDriftType

public Class<? extends IComponent> getDriftType()

Specified by:

getDriftType in class ElementMapping

getRfCavityDriftType

public Class<? extends IComponent> getRfCavityDriftType()

Specified by:

getRfCavityDriftType in class ElementMapping

createDefaultDrift

public IComponent createDefaultDrift(String name,
 double len)

Creates a new, general drift space.

Specified by:

createDefaultDrift in class ElementMapping

Returns:

drift model element

Since:

Dec 3, 2014

See Also:

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

createRfCavityDrift

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

Creates a drift space within an RF cavity.

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

Since:

Dec 3, 2014, Christopher K. Allen

See Also:

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

initialize

protected void initialize()