xal.extension.extlatgen

Class MadGenerator

java.lang.Object

xal.extension.extlatgen.MadGenerator

public class MadGenerator
extends java.lang.Object

MadGenerator generates MAD input file from XAL lattice view. Usage: create a MadGenerator object with an XAL lattice as input, then call the method createMadInput() which one can specify either DESIGN or LIVE data as argument.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.List<AcceleratorSeq>	_sequenceChain
protected double[]	beamci beam initial condition
protected java.lang.String	myLatticeName
protected Probe<?>	myProbe Probe for initial condition
static int	PARAMSRC_DESIGN for design values
static int	PARAMSRC_LIVE for live data from the machine
protected double	Q sign of particle charge

Constructor Summary

Constructors

Constructor and Description
MadGenerator(java.util.List<AcceleratorSeq> sequenceChain, EnvelopeProbe envProbe) Constructor
MadGenerator(java.util.List<AcceleratorSeq> sequenceChain, TransferMapProbe envProbe) Constructor
MadGenerator(java.lang.String latticeName, java.util.List<AcceleratorSeq> sequenceChain, EnvelopeProbe envProbe) Constructor
MadGenerator(java.lang.String latticeName, java.util.List<AcceleratorSeq> sequenceChain, Probe<?> envProbe) Constructor
MadGenerator(java.lang.String latticeName, java.util.List<AcceleratorSeq> sequenceChain, TransferMapProbe envProbe) Constructor

Method Summary

Modifier and Type	Method and Description
Lattice	createLattice(AcceleratorSeq accSeq) create an XAL intermediate lattice
void	createMadInput(AbstractDeviceDataSource deviceDataSource) generate the MAD input file
void	createMadInput(AbstractDeviceDataSource deviceDataSource, java.io.File outputFile) generate the MAD input file
java.lang.String	formatName(java.lang.String name) strip the leading sequence and device category identifier (i.e.
void	setBeamCI(double[] newBeamCI) set the beam initial condition
void	setUseDesignBendAngles(boolean useDesignBendAngles) Set whether to use the design bend angles independent of the specified data source

Methods inherited from class java.lang.Object

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

Field Detail

myProbe

protected Probe<?> myProbe

Probe for initial condition

_sequenceChain

protected java.util.List<AcceleratorSeq> _sequenceChain

PARAMSRC_DESIGN

public static final int PARAMSRC_DESIGN

for design values

See Also:

Constant Field Values

PARAMSRC_LIVE

public static final int PARAMSRC_LIVE

for live data from the machine

See Also:

Constant Field Values

myLatticeName

protected java.lang.String myLatticeName

Q

protected double Q

sign of particle charge

beamci

protected double[] beamci

beam initial condition

Constructor Detail

MadGenerator

public MadGenerator(java.util.List<AcceleratorSeq> sequenceChain,
                    TransferMapProbe envProbe)

Constructor

Parameters:

sequenceChain - sequence list

envProbe - envelope probe

MadGenerator

public MadGenerator(java.util.List<AcceleratorSeq> sequenceChain,
                    EnvelopeProbe envProbe)

Constructor

MadGenerator

public MadGenerator(java.lang.String latticeName,
                    java.util.List<AcceleratorSeq> sequenceChain,
                    TransferMapProbe envProbe)

Constructor

Parameters:

latticeName - lattice name (if there is one)

sequenceChain - sequence list

envProbe - envelope probe

MadGenerator

public MadGenerator(java.lang.String latticeName,
                    java.util.List<AcceleratorSeq> sequenceChain,
                    EnvelopeProbe envProbe)

Constructor

MadGenerator

public MadGenerator(java.lang.String latticeName,
                    java.util.List<AcceleratorSeq> sequenceChain,
                    Probe<?> envProbe)

Constructor

Method Detail

setUseDesignBendAngles

public void setUseDesignBendAngles(boolean useDesignBendAngles)

Set whether to use the design bend angles independent of the specified data source

setBeamCI

public void setBeamCI(double[] newBeamCI)

set the beam initial condition

createMadInput

public void createMadInput(AbstractDeviceDataSource deviceDataSource)
                    throws java.io.IOException

generate the MAD input file

Parameters:

deviceDataSource - data source for the device's fields

Throws:

java.io.IOException

createMadInput

public void createMadInput(AbstractDeviceDataSource deviceDataSource,
                           java.io.File outputFile)
                    throws java.io.IOException

generate the MAD input file

Parameters:

deviceDataSource - data source for the device's fields

Throws:

java.io.IOException

formatName

public java.lang.String formatName(java.lang.String name)

strip the leading sequence and device category identifier (i.e. Ring_Mag:), replace any "-" or ":" with "_" in the device name or beamline name

createLattice

public Lattice createLattice(AcceleratorSeq accSeq)

create an XAL intermediate lattice

Parameters:

accSeq - accelerator sequence for the lattice

Returns:

XAL intermediate lattice