Package xal.smf.attr

Class ApertureBucket

java.lang.Object

xal.smf.attr.AttributeBucket

xal.smf.attr.ApertureBucket

All Implemented Interfaces:

Serializable, DataListener

public class ApertureBucket
extends AttributeBucket

The aperture bucket defines the inner geometry of the elements.

For elements with constant aperture, set a single value for x and y.

For elements with more complicated geometry, use the array "pos" to define the apertures "x" and "y" (also arrays of the same length) at different points in the element. The first and last points should correspond to the ends of the element.

Version:

1.0, 2.0

Author:

Christopher K. Allen, Juan F. Esteban Müller <JuanF.EstebanMuller@esss.se>

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class xal.smf.attr.AttributeBucket

AttributeBucket.MissingAttributeException

Field Summary

Fields

Modifier and Type	Field	Description
static final int	DIAMOND
static final int	ELLIPSE
static final int	IRREGULAR
static final int	RECTANGLE
static final String	TYPE
static final int	UNKNOWN

Constructor Summary

Constructors

Constructor	Description
ApertureBucket()	Creates new ApertureBucket

Method Summary

Modifier and Type	Method	Description
double[]	getAperPos()
double[]	getAperX()
double[]	getAperY()
String[]	getAttrNames()
int	getShape()
String	getType()	Furnish a unique type id
void	setAperPos(double dblVal)
void	setAperPos(double[] dblArr)
void	setAperX(double dblVal)
void	setAperX(double[] dblArr)
void	setAperY(double dblVal)
void	setAperY(double[] dblArr)
void	setShape(int intVal)

Methods inherited from class xal.smf.attr.AttributeBucket

checkAttribute, dataLabel, getAttr, getAttrDescription, parseAttrValue, registerAttribute, registerAttribute, setAttrValue, setAttrValue, setAttrValue, setAttrValue, setAttrValue, setAttrValue, setAttrValue, setAttrValue, setAttrValue, setAttrValue, update, write

Methods inherited from class java.lang.Object

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

Field Details

UNKNOWN

public static final int UNKNOWN

See Also:

• Constant Field Values

ELLIPSE

public static final int ELLIPSE

See Also:

• Constant Field Values

RECTANGLE

public static final int RECTANGLE

See Also:

• Constant Field Values

DIAMOND

public static final int DIAMOND

See Also:

• Constant Field Values

IRREGULAR

public static final int IRREGULAR

See Also:

• Constant Field Values

TYPE

public static final String TYPE

See Also:

• Constant Field Values

Constructor Details

ApertureBucket

public ApertureBucket()

Creates new ApertureBucket

Method Details

getType

public String getType()

Furnish a unique type id

Specified by:

getType in class AttributeBucket

getAttrNames

public String[] getAttrNames()

Overrides:

getAttrNames in class AttributeBucket

getShape

public int getShape()

getAperX

public double[] getAperX()

getAperY

public double[] getAperY()

getAperPos

public double[] getAperPos()

setShape

public void setShape(int intVal)

setAperX

public void setAperX(double dblVal)

setAperY

public void setAperY(double dblVal)

setAperPos

public void setAperPos(double dblVal)

setAperX

public void setAperX(double[] dblArr)

setAperY

public void setAperY(double[] dblArr)

setAperPos

public void setAperPos(double[] dblArr)