Package xal.model

Class Sector

java.lang.Object

xal.model.elem.ElementSeq

xal.model.Sector

All Implemented Interfaces:

Iterable<IComponent>, IComponent, IComposite

public class Sector
extends ElementSeq

Represents a logical sector of beamline. This is essentially a semantic concept since it simply extends the ElementSeq base class.

Since:

May 20, 2004

Author:

Christopher K. Allen

Field Summary

Fields

Modifier and Type	Field	Description
static final String	TYPE	the string type identifier for all Sector objects

Fields inherited from class xal.model.elem.ElementSeq

SIZE_DEF_RESERVE

Constructor Summary

Constructors

Constructor	Description
Sector()	Default constructor.
Sector(String strId)	Create new Sector object and initialize the string identifier.
Sector(String strId, int szReserve)	Create new Sector object specifying the amount of storage to reserve for the direct child components.

Method Summary

Methods inherited from class xal.model.elem.ElementSeq

addChild, backPropagate, backPropagate, childIterator, compDependParams, concatenateEquals, getAlignX, getAlignY, getAlignZ, getAllElements, getChild, getChildCount, getComments, getElementList, getForwardCompList, getHardwareNodeId, getId, getLatticePosition, getLeafCount, getLength, getParent, getPhiX, getPhiY, getPhiZ, getPosition, getReverseCompList, getType, globalBackIterator, globalIterator, initializeFrom, iterator, localBackIterator, localIterator, print, propagate, propagate, remove, setAlign, setAlignX, setAlignY, setAlignZ, setComments, setCompList, setDirty, setHardwareNodeId, setId, setParent, setPhiX, setPhiY, setPhiZ, toString, toStringLegacy

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Details

TYPE

public static final String TYPE

the string type identifier for all Sector objects

See Also:

• Constant Field Values

Constructor Details

Sector

public Sector()

Default constructor. The Sector object is empty and has no string identifier.

Sector

public Sector(String strId)

Create new Sector object and initialize the string identifier.

Parameters:

strId - string identifier of this sector

Sector

public Sector(String strId,
 int szReserve)

Create new Sector object specifying the amount of storage to reserve for the direct child components. (If not specified a default value is used.)

Parameters:

strId - string identifier of this sector

szReserve - number of storage positions to reserve for children