xal.model.elem

Interface IElectromagnet

All Known Implementing Classes:

ElectromagnetSeq, IdealHorMagSteeringDipole, IdealMagDipoleFace, IdealMagDipoleFace2, IdealMagFringeQuad, IdealMagFringeQuadFace, IdealMagQuad, IdealMagSectorDipole, IdealMagSectorDipole2, IdealMagSkewQuad, IdealMagSkewQuad3, IdealMagSolenoid, IdealMagSteeringDipole, IdealMagWedgeDipole, IdealMagWedgeDipole2, IdealPermMagQuad, IdealVerMagSteeringDipole, ThickDipole, ThickElectromagnet, ThinElectromagnet

public interface IElectromagnet

This interface defines the common properties of all electromagnet elements.

Field Summary

Fields

Modifier and Type	Field and Description
static int	ORIENT_HOR dipole is oriented to provide action in the horizontal plane
static int	ORIENT_NONE no dipole orientation given - indicates error condition for oriented elements
static int	ORIENT_VER dipole is oriented to provide action in the vertical plane

Method Summary

Modifier and Type	Method and Description
double	getMagField() Get the magnetic field strength of the electromagnet
int	getOrientation() Return the orientation enumeration code.
void	setMagField(double dblField) Set the magnetic field strength of the electromagnet.
void	setOrientation(int enmOrient) Return the orientation enumeration code.

Field Detail

ORIENT_NONE

static final int ORIENT_NONE

no dipole orientation given - indicates error condition for oriented elements

See Also:

Constant Field Values

ORIENT_HOR

static final int ORIENT_HOR

dipole is oriented to provide action in the horizontal plane

See Also:

Constant Field Values

ORIENT_VER

static final int ORIENT_VER

dipole is oriented to provide action in the vertical plane

See Also:

Constant Field Values

Method Detail

getOrientation

int getOrientation()

Return the orientation enumeration code.

Returns:

ORIENT_NONE - no electromagnet orientation (possible error) ORIENT_HOR - magnet oriented for action in x (horizontal) plane ORIENT_VER - magnet oriented for action in y (vertical) plane

getMagField

double getMagField()

Get the magnetic field strength of the electromagnet

Returns:

magnetic field (in Tesla).

setOrientation

void setOrientation(int enmOrient)

Return the orientation enumeration code.

Parameters:

enmOrient - magnet orientation enumeration code

See Also:

getOrientation()

setMagField

void setMagField(double dblField)

Set the magnetic field strength of the electromagnet.

Parameters:

dblField - magnetic field (in Tesla).