xal.sim.scenario

Class ProbeFactory

java.lang.Object

xal.sim.scenario.ProbeFactory

public class ProbeFactory
extends java.lang.Object

ProbeFactory is a factory for generating probes. TODO
· Let's do the proper type of the probe species on the methods
· Perhaps we could rename the get-prefixed methods to a more conventional naming (e.g., create-)

Since:

Sep 03, 2004

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.lang.String	BEAM_TABLE table name for the beam parameters
protected static java.lang.String	CENTRCOORD_TABLE table name for phase coordinates
protected static java.lang.String	CHARGE_PARAM parameter name for charge
protected static java.lang.String	KINETIC_ENERGY_PARAM parameter name for kinetic energy
protected static java.lang.String	LOCATION_TABLE table name for the location records
protected static java.lang.String	MASS_PARAM parameter name for mass
protected static java.lang.String	PHASECOORD_TABLE table name for phase coordinates
protected static java.lang.String	PHASECOORD_VALUE_PARAM XML attribute name for the phase coordinates themselves
protected static java.lang.String	SPECIES_NAME_PARAM parameter name for species name parameter
protected static java.lang.String	SPECIES_PARAM parameter name for species
protected static java.lang.String	SPECIES_TABLE table name for species
protected static java.lang.String	TWISS_TABLE table name for the twiss parameters

Constructor Summary

Constructors

Constructor and Description
ProbeFactory()

Method Summary

Modifier and Type	Method and Description
static ParticleProbe	createParticleProbe(AcceleratorSeq sequence, IAlgorithm algorithm) Generate a Particle probe initialized with the default entrance parameters for the specified sequence.
static EnvelopeProbe	getEnvelopeProbe(AcceleratorSeq sequence, IAlgorithm algorithm) Generate an Envelope probe initialized with the default entrance parameters for the specified sequence.
static EnvelopeProbe	getEnvelopeProbe(java.lang.String locationID, AcceleratorSeq sequence, IAlgorithm algorithm) Generate an Envelope probe initialized with the entrance parameters for the specified location.
static java.util.List<java.lang.String>	getLocationIDs(Accelerator accelerator) Get the list of available location IDs ordered alpha-numerically.
static java.util.List<GenericRecord>	getLocationRecords(Accelerator accelerator) Get the list of available location records ordered by name.
static ParticleProbe	getParticleProbe(java.lang.String locationID, AcceleratorSeq sequence, IAlgorithm algorithm) Generate a Particle probe initialized with the entrance parameters for the specified location.
static TransferMapProbe	getTransferMapProbe(AcceleratorSeq sequence, IAlgorithm algorithm) Generate a TransferMap probe initialized with the default entrance parameters for the specified sequence.
static TransferMapProbe	getTransferMapProbe(java.lang.String locationID, AcceleratorSeq sequence, IAlgorithm algorithm) Generate a TransferMap probe initialized with the entrance parameters for the specified location.
static TwissProbe	getTwissProbe(AcceleratorSeq seqParent, IAlgorithm algDynamics) Create and initialize a new TwissProbe object with the default parameters in the model.params file.
static TwissProbe	getTwissProbe(java.lang.String strLocId, AcceleratorSeq seqParent, IAlgorithm algDynamics) Create and initialize a new TwissProbe object with the default parameters in the model.params file.

Methods inherited from class java.lang.Object

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

Field Detail

SPECIES_TABLE

protected static final java.lang.String SPECIES_TABLE

table name for species

See Also:

Constant Field Values

BEAM_TABLE

protected static final java.lang.String BEAM_TABLE

table name for the beam parameters

See Also:

Constant Field Values

TWISS_TABLE

protected static final java.lang.String TWISS_TABLE

table name for the twiss parameters

See Also:

Constant Field Values

PHASECOORD_TABLE

protected static final java.lang.String PHASECOORD_TABLE

table name for phase coordinates

See Also:

Constant Field Values

CENTRCOORD_TABLE

protected static final java.lang.String CENTRCOORD_TABLE

table name for phase coordinates

See Also:

Constant Field Values

LOCATION_TABLE

protected static final java.lang.String LOCATION_TABLE

table name for the location records

See Also:

Constant Field Values

KINETIC_ENERGY_PARAM

protected static final java.lang.String KINETIC_ENERGY_PARAM

parameter name for kinetic energy

See Also:

Constant Field Values

SPECIES_PARAM

protected static final java.lang.String SPECIES_PARAM

parameter name for species

See Also:

Constant Field Values

SPECIES_NAME_PARAM

protected static final java.lang.String SPECIES_NAME_PARAM

parameter name for species name parameter

See Also:

Constant Field Values

CHARGE_PARAM

protected static final java.lang.String CHARGE_PARAM

parameter name for charge

See Also:

Constant Field Values

MASS_PARAM

protected static final java.lang.String MASS_PARAM

parameter name for mass

See Also:

Constant Field Values

PHASECOORD_VALUE_PARAM

protected static final java.lang.String PHASECOORD_VALUE_PARAM

XML attribute name for the phase coordinates themselves

See Also:

Constant Field Values

Constructor Detail

ProbeFactory

public ProbeFactory()

Method Detail

createParticleProbe

public static ParticleProbe createParticleProbe(AcceleratorSeq sequence,
                                                IAlgorithm algorithm)

Generate a Particle probe initialized with the default entrance parameters for the specified sequence. The location used defaults to the sequence's entrance ID.

Parameters:

sequence - the sequence for which to initialize the probe

algorithm - the online model algorithm to use

Returns:

the initialized particle probe

getParticleProbe

public static ParticleProbe getParticleProbe(java.lang.String locationID,
                                             AcceleratorSeq sequence,
                                             IAlgorithm algorithm)

Generate a Particle probe initialized with the entrance parameters for the specified location.

Parameters:

locationID - the location ID of the entrance parameters to use

sequence - the sequence for which to initialize the probe

algorithm - the online model algorithm to use

Returns:

the initialized particle probe

getTransferMapProbe

public static TransferMapProbe getTransferMapProbe(AcceleratorSeq sequence,
                                                   IAlgorithm algorithm)

Generate a TransferMap probe initialized with the default entrance parameters for the specified sequence. The location used defaults to the sequence's entrance ID.

Parameters:

sequence - the sequence for which to initialize the probe

algorithm - the online model algorithm to use

Returns:

the initialized transfer map probe

getTransferMapProbe

public static TransferMapProbe getTransferMapProbe(java.lang.String locationID,
                                                   AcceleratorSeq sequence,
                                                   IAlgorithm algorithm)

Generate a TransferMap probe initialized with the entrance parameters for the specified location.

Parameters:

locationID - the location ID of the entrance parameters to use

sequence - the sequence for which to initialize the probe

algorithm - the online model algorithm to use

Returns:

the initialized transfer map probe

getTwissProbe

public static TwissProbe getTwissProbe(AcceleratorSeq seqParent,
                                       IAlgorithm algDynamics)

Create and initialize a new TwissProbe object with the default parameters in the model.params file. The parameters are taken for the entrance location of the provided accelerator hardware sequence. The given algorithm object is also verified and attached to the probe.

Parameters:

seqParent - accelerator sequence containing the location

algDynamics - algorithm used for the simulation

Returns:

new, initialized TwissProbe object

Since:

Sep 6, 2014

getTwissProbe

public static TwissProbe getTwissProbe(java.lang.String strLocId,
                                       AcceleratorSeq seqParent,
                                       IAlgorithm algDynamics)

Create and initialize a new TwissProbe object with the default parameters in the model.params file. The parameters are taken for the location of the provided location ID along the given accelerator hardware sequence. The given algorithm object is also verified and attached to the probe.

Parameters:

strLocId - location of the accelerator where the model parameters are taken

seqParent - accelerator sequence containing the location

algDynamics - algorithm used for the simulation

Returns:

new, initialized TwissProbe object

Since:

Nov 5, 2013

getEnvelopeProbe

public static EnvelopeProbe getEnvelopeProbe(AcceleratorSeq sequence,
                                             IAlgorithm algorithm)

Generate an Envelope probe initialized with the default entrance parameters for the specified sequence. The location used defaults to the sequence's entrance ID.

Parameters:

sequence - the sequence for which to initialize the probe

algorithm - the online model algorithm to use

Returns:

the initialized transfer map probe

getEnvelopeProbe

public static EnvelopeProbe getEnvelopeProbe(java.lang.String locationID,
                                             AcceleratorSeq sequence,
                                             IAlgorithm algorithm)

Generate an Envelope probe initialized with the entrance parameters for the specified location.

Parameters:

locationID - the location ID of the entrance parameters to use

sequence - the sequence for which to initialize the probe

algorithm - the online model algorithm to use

Returns:

the initialized transfer map probe

getLocationIDs

public static java.util.List<java.lang.String> getLocationIDs(Accelerator accelerator)

Get the list of available location IDs ordered alpha-numerically.

Parameters:

accelerator - accelerator object to parse

Returns:

a list of available location IDs.

getLocationRecords

public static java.util.List<GenericRecord> getLocationRecords(Accelerator accelerator)

Get the list of available location records ordered by name.

Parameters:

accelerator - accelerator object to parse

Returns:

a list of available location records.