xal.model.elem

Class IdealVerMagSteeringDipole

java.lang.Object

xal.model.elem.Element

xal.model.elem.ThinElement

xal.model.elem.ThinElectromagnet

xal.model.elem.IdealMagSteeringDipole

xal.model.elem.IdealVerMagSteeringDipole

All Implemented Interfaces:

IElectromagnet, IComponent, IElement

public class IdealVerMagSteeringDipole
extends IdealMagSteeringDipole

Represents an ideal magnetic steering dipole in the vertical direction. All the functionality occurs in the base class IdealMagSteeringDipole. This purpose of this class is to avoid the use of the enumeration constants in IElectromagnet which define the orientation. They are brittle being of the legacy construction (with int values) and the mechanism is problematic when generating a model from the SMF Accelerator tree.

Since:

May 13, 2011

Field Summary

Fields inherited from class xal.model.elem.IdealMagSteeringDipole

s_strParamField, s_strParamLenEff, s_strParamOrient, s_strType

Fields inherited from class xal.model.elem.ThinElectromagnet

dblField, enmOrient

Fields inherited from interface xal.model.elem.IElectromagnet

ORIENT_HOR, ORIENT_NONE, ORIENT_VER

Fields inherited from interface xal.model.IElement

LightSpeed, Permeability, Permittivity, UnitCharge

Constructor Summary

Constructors

Constructor and Description
IdealVerMagSteeringDipole() Default constructor - creates a new uninitialized instance of IdealVerMagSteeringDipole.
IdealVerMagSteeringDipole(java.lang.String strId) Create a new instance of IdealVerMagSteeringDipole and specify its instance identifier.
IdealVerMagSteeringDipole(java.lang.String strId, double dblLenEff, double dblFld) Creates a new instance of IdealVerMagSteeringDipole.

Method Summary

Methods inherited from class xal.model.elem.IdealMagSteeringDipole

elapsedTime, energyGain, getAngleKick, getEffLength, getPositionKick, initializeFrom, print, setAngleKick, setEffLength, setPositionKick, transferMap

Methods inherited from class xal.model.elem.ThinElectromagnet

getMagField, getOrientation, setMagField, setOrientation

Methods inherited from class xal.model.elem.ThinElement

elapsedTime, energyGain, getLength, transferMap

Methods inherited from class xal.model.elem.Element

addCloseElements, applyAlignError, backPropagate, backPropagate, compDriftingTime, compProbeLocation, getAlignX, getAlignY, getAlignZ, getCloseElements, getHardwareNodeId, getId, getPosition, getType, getUID, propagate, propagate, setAlign, setAlignX, setAlignY, setAlignZ, setHardwareNodeId, setId, setPosition, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

IdealVerMagSteeringDipole

public IdealVerMagSteeringDipole()

Default constructor - creates a new uninitialized instance of IdealVerMagSteeringDipole. Typically used by automatic lattice generation.

Since:

May 13, 2011

IdealVerMagSteeringDipole

public IdealVerMagSteeringDipole(java.lang.String strId)

Create a new instance of IdealVerMagSteeringDipole and specify its instance identifier.

Parameters:

strId - string instance identifier of element

Since:

May 13, 2011

IdealVerMagSteeringDipole

public IdealVerMagSteeringDipole(java.lang.String strId,
                                 double dblLenEff,
                                 double dblFld)

Creates a new instance of IdealVerMagSteeringDipole. The action of the kicker is completely unspecified.

Parameters:

strId - string identifier of element

dblFld - field strength (in Tesla)

dblLenEff - effective length of dipole magnet

Since:

May 13, 2011