Package org.scictrl.mp.orbitcorrect.model.optics

Class Aperture

java.lang.Object

org.scictrl.mp.orbitcorrect.model.optics.AbstractDataBushElement

org.scictrl.mp.orbitcorrect.model.optics.AbstractOpticalElement

org.scictrl.mp.orbitcorrect.model.optics.AbstractTransferElement

org.scictrl.mp.orbitcorrect.model.optics.Aperture

All Implemented Interfaces:

Cloneable, ISimpleElement

public class Aperture
extends AbstractTransferElement

Aperture is drift space element. It has lead shields, which can be moved toward the beam and stops outer electrons.

Author:

igor@scictrl.com

Field Summary

Fields

Modifier and Type	Field	Description
static final int	PR_X_SIZE	Constant PR_X_SIZE=6
static final int	PR_Z_SIZE	Constant PR_Z_SIZE=7

Fields inherited from class org.scictrl.mp.orbitcorrect.model.optics.AbstractTransferElement

length, matrices, matrix, PR_LENGTH

Fields inherited from class org.scictrl.mp.orbitcorrect.model.optics.AbstractOpticalElement

PR_POSITION, PR_REL_FROM, PR_REL_POSITION

Fields inherited from class org.scictrl.mp.orbitcorrect.model.optics.AbstractDataBushElement

lastActionResult, owner, PR_ELEMENT_NAME, PR_VIRTUAL

Constructor Summary

Constructors

Constructor	Description
Aperture(String name)	Aperture constructor that takes only name as parameter.
Aperture(String name, boolean virtual, double position, double relpos, String relFrom, double length, double xSize, double zSize)	Constructs the Aperture with specified parameters.

Method Summary

Modifier and Type	Method	Description
DBElementDescriptor	descriptor()	Returns the descriptor object for this element.
int	elType()	Returns the code of element's type.
double	getXsize()	This method returns aperture of lead shields in x direction.
double	getZsize()	Getter for the field zsize.
void	setWith(Object[] par)	Sets parameters values of this element to those in parameter array.
void	setXsize(double newValue)	This method sets aperture in x direction.
void	setZsize(double newValue)	This method sets aperture in z direction.
String	toString()	Returns the string representation of this element.

Methods inherited from class org.scictrl.mp.orbitcorrect.model.optics.AbstractTransferElement

clone, getAlpha1, getAlpha2, getBeta1, getBeta2, getDispersion1, getDispersion2, getLength, getMatrix, getQ1, getQ2, newMatrix, newMatrix, setLength

Methods inherited from class org.scictrl.mp.orbitcorrect.model.optics.AbstractOpticalElement

getAlpha, getBeta, getDispersion, getIndex, getPosition, getQ, getRelFrom, getRelPosition, setPosition, setRelFrom, setRelPosition

Methods inherited from class org.scictrl.mp.orbitcorrect.model.optics.AbstractDataBushElement

equals, getLastActionResult, getName, getOwner, getVirtual, hashCode, isInitialized, isVirtual, setVirtual, throwISE

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

PR_X_SIZE

public static final int PR_X_SIZE

Constant PR_X_SIZE=6

See Also:

• Constant Field Values

PR_Z_SIZE

public static final int PR_Z_SIZE

Constant PR_Z_SIZE=7

See Also:

• Constant Field Values

Constructor Details

Aperture

public Aperture(String name)

Aperture constructor that takes only name as parameter.

Parameters:

name - a String object

Aperture

public Aperture(String name,
 boolean virtual,
 double position,
 double relpos,
 String relFrom,
 double length,
 double xSize,
 double zSize)

Constructs the Aperture with specified parameters.

Parameters:

name - a String object

virtual - a boolean

position - a double

relpos - a double

relFrom - a String object

length - a double

xSize - a double

zSize - a double

Method Details

descriptor

public DBElementDescriptor descriptor()

Returns the descriptor object for this element. DBElementDescriptor helps manipulating DataBush elements dynamically.

descriptor.

Specified by:

descriptor in class AbstractDataBushElement

Returns:

the descriptor object for this element.

See Also:

• AbstractDataBushElement.descriptor()

elType

public int elType()

Returns the code of element's type.

elType.

Specified by:

elType in class AbstractDataBushElement

Returns:

the code of element's type.

See Also:

• AbstractDataBushElement.elType()

getXsize

public double getXsize()

This method returns aperture of lead shields in x direction.

Returns:

a double

getZsize

public double getZsize()

Getter for the field zsize.

Returns:

double

setWith

public void setWith(Object[] par)
             throws IllegalStateException

Sets parameters values of this element to those in parameter array. As parameter must be used such array as for dynamical construction of new instance of this class. Current values are overriden for each not null object in array.

setWith.

setWith.

setWith.

Overrides:

setWith in class AbstractTransferElement

Parameters:

par - an array of Object objects

Throws:

IllegalStateException - if element is initialized and inside DataBush.

See Also:

• AbstractDataBushElement.setWith(java.lang.Object[])

setXsize

public void setXsize(double newValue)

This method sets aperture in x direction.

Parameters:

newValue - a double

See Also:

• getXsize()

setZsize

public void setZsize(double newValue)

This method sets aperture in z direction.

Parameters:

newValue - a double

See Also:

• getZsize()

toString

public String toString()

Returns the string representation of this element. Returns string describing this element. String is formated in input-file code. Returns a String that represents the value of this object.

toString.

toString.

Specified by:

toString in interface ISimpleElement

Overrides:

toString in class AbstractTransferElement

See Also:

• AbstractDataBushElement.toString()