Base class for all beam line elements. More...

#include <OpalElement.h>

Inherited by OpalBeamStripping, OpalBend, OpalCavity, OpalCCollimator, OpalCyclotron, OpalCyclotronValley, OpalDegrader, OpalDrift, OpalECollimator, OpalFlexibleCollimator, OpalHKicker, OpalHMonitor, OpalInstrument, OpalKicker, OpalMarker, OpalMonitor, OpalMultipole, OpalMultipoleT, OpalMultipoleTCurvedConstRadius, OpalMultipoleTCurvedVarRadius, OpalMultipoleTStraight, OpalOctupole, OpalOffset::OpalGlobalCartesianOffset, OpalOffset::OpalGlobalCylindricalOffset, OpalOffset::OpalLocalCartesianOffset, OpalOffset::OpalLocalCylindricalOffset, OpalParallelPlate, OpalPatch, OpalPepperPot, OpalPolynomialTimeDependence, OpalProbe, OpalQuadrupole, OpalRBend3D, OpalRCollimator, OpalRingDefinition, OpalSBend3D, OpalScalingFFAMagnet, OpalSeparator, OpalSeptum, OpalSextupole, OpalSlit, OpalSolenoid, OpalSource, OpalSplineTimeDependence, OpalSRot, OpalStripper, OpalTravelingWave, OpalVariableRFCavity, OpalVariableRFCavityFringeField, OpalVerticalFFAMagnet, OpalVKicker, OpalVMonitor, OpalWire, and OpalYRot.

Collaboration diagram for OpalElement:

[legend]

Public Types
enum	{ TYPE, APERT, LENGTH, ELEMEDGE, WAKEF, PARTICLEMATTERINTERACTION, ORIGIN, ORIENTATION, X, Y, Z, THETA, PHI, PSI, DX, DY, DZ, DTHETA, DPHI, DPSI, COMMON }
	The common attributes for all elements. More...

enum	ValueFlag { ACTUAL_FLAG, IDEAL_FLAG, ERROR_FLAG }
	Switch for value desired on ATTLIST command. More...

Public Types inherited from Element
enum	ReferenceType { IS_ENTRY, IS_CENTRE, IS_EXIT }
	Reference for element positioning. More...

Public Member Functions
virtual	~OpalElement ()

virtual void	fillRegisteredAttributes (const ElementBase &, ValueFlag)
	Fill in all registered attributes. More...

virtual double	getLength () const
	Return element length. More...

const std::string	getTypeName () const
	Return the element's type name. More...

std::pair < ElementBase::ApertureType, std::vector< double > >	getApert () const

const std::string	getWakeF () const
	Return the element's type name. More...

const std::string	getParticleMatterInteraction () const

const std::string	getWMaterial () const

const std::string	getWakeGeom () const

std::vector< double >	getWakeParam () const

const std::string	getWakeConductivity () const

virtual void	parse (Statement &)
	Parse the element. More...

virtual void	print (std::ostream &) const
	Print the object. More...

virtual void	update ()
	Update the embedded CLASSIC element. More...

virtual void	updateUnknown (ElementBase *)
	Transmit the ``unknown'' (not known to OPAL) attributes to CLASSIC. More...

Public Member Functions inherited from Element
virtual	~Element ()

virtual bool	canReplaceBy (Object *object)
	Test if replacement is allowed. More...

virtual const std::string	getCategory () const
	Return the object category as a string. More...

virtual bool	shouldTrace () const
	Trace flag. More...

virtual bool	shouldUpdate () const
	Update flag. More...

virtual double	getEntrance (ReferenceType) const
	Return arc length from origin to entrance (negative !). More...

virtual double	getExit (ReferenceType) const
	Return arc length from origin to exit (positive !). More...

virtual void	setShared (bool)
	Set shared flag. More...

ElementBase *	getElement () const
	Return the embedded CLASSIC element. More...

void	setElement (ElementBase *)
	Assign new CLASSIC element. More...

Public Member Functions inherited from Object
virtual	~Object ()

virtual Object *	clone (const std::string &name)=0
	Return a clone. More...

void	copyAttributes (const Object &)
	Copy attributes from another object. More...

virtual void	execute ()
	Execute the command. More...

virtual Attribute *	findAttribute (const std::string &name)
	Find an attribute by name. More...

virtual const Attribute *	findAttribute (const std::string &name) const
	Find an attribute by name. More...

virtual Object *	makeTemplate (const std::string &, TokenStream &, Statement &)
	Macro handler function. More...

virtual Object *	makeInstance (const std::string &name, Statement &, const Parser *)
	Macro handler function. More...

virtual void	parseShortcut (Statement &)
	Parser for single-attribute commands. More...

virtual void	printValue (std::ostream &) const

virtual void	printHelp (std::ostream &) const
	Print help. More...

virtual void	replace (Object oldObject, Object newObject)
	Replace references. More...

bool	isBuiltin () const
	True, if [b]this[/b] is a built-in object. More...

virtual bool	isShared () const
	Shared flag. More...

void	setDirty (bool)
	Set/reset the [b]modified[/b] flag. More...

bool	isDirty () const
	True, if the [b]modified[/b] flag is set. More...

void	setFlag (bool)
	Flag/unflag this object, e. g. to control output of objects for. More...

bool	isFlagged () const
	True, if [b]this[/b] is flagged by setFlag(true). More...

const Object *	getBaseObject () const
	Return the object's base type object. More...

const std::string &	getOpalName () const
	Return object name. More...

Object *	getParent () const
	Return parent pointer. More...

bool	isTreeMember (const Object *subTree) const
	Test for tree membership. More...

void	setOpalName (const std::string &name)
	Set object name. More...

void	setParent (Object *)
	Set parent object. More...

void	clear ()
	Clear the occurrence counter. More...

int	increment ()
	Increment and return the occurrence counter. More...

int	occurrenceCount ()
	Return the occurrence counter. More...

void	registerReference (Invalidator *a)
	Register a reference to this object. More...

void	unregisterReference (Invalidator *a)
	Unegister a reference to this object. More...

void	registerOwnership (const AttributeHandler::OwnerType &itsClass) const

Public Member Functions inherited from RCObject
int	addReference () const
	Increment reference count. More...

int	removeReference () const
	Decrement the reference count. More...

bool	isShared () const
	Test for sharing. More...

Static Public Member Functions
static AttCell *	findRegisteredAttribute (const std::string &name)
	Find a registered attribute. More...

static void	setRegisteredAttribute (const std::string &, double)
	Store a registered real attribute. More...

static void	setRegisteredAttribute (const std::string &, const std::string &)
	Store a registered string attribute. More...

Static Public Member Functions inherited from Element
static Element *	find (const std::string &name)
	Find named Element. More...

Protected Member Functions
	OpalElement (int size, const char name, const char help)
	Exemplar constructor. More...

	OpalElement (const std::string &name, OpalElement *parent)
	Clone constructor. More...

void	registerOwnership () const

Protected Member Functions inherited from Element
	Element (int size, const char name, const char help)
	Constructor for exemplars. More...

	Element (const std::string &name, Element *parent)
	Constructor for clones. More...

Protected Member Functions inherited from Object
	Object (int size, const char name, const char help)
	Constructor for exemplars. More...

	Object (const std::string &name, Object *parent)
	Constructor for clones. More...

Protected Member Functions inherited from RCObject
	RCObject ()
	Default constructor. More...

	RCObject (const RCObject &)
	Copy constructor. More...

virtual	~RCObject ()=0

RCObject &	operator= (const RCObject &right)

Static Protected Member Functions
static void	printMultipoleStrength (std::ostream &os, int order, int &len, const std::string &sName, const std::string &tName, const Attribute &length, const Attribute &vNorm, const Attribute &vSkew)
	Print multipole components in OPAL-8 format. More...

static void	printAttribute (std::ostream &os, const std::string &name, const std::string &image, int &len)
	Print an attribute with a OPAL-8 name (as an expression). More...

static void	printAttribute (std::ostream &os, const std::string &name, double value, int &len)
	Print an attribute with a OPAL-8 name (as a constant). More...

static AttCell *	registerRealAttribute (const std::string &name)
	Register a ``real'' element attribute. More...

static AttCell *	registerStringAttribute (const std::string &name)
	Register a ``string'' element attribute. More...

Static Protected Attributes
static std::map< std::string, OwnPtr< AttCell > >	attributeRegistry
	The registry for named attributes. More...

Private Member Functions
	OpalElement ()

void	operator= (const OpalElement &)

Private Attributes
int	itsSize

Additional Inherited Members
Public Attributes inherited from Object
std::vector< Attribute >	itsAttr
	The object attributes (see Attribute.hh). More...

Protected Attributes inherited from Object
bool	builtin
	Built-in flag. More...

bool	modified
	Dirty flag. More...

bool	flagged
	Object flag. More...

Detailed Description

Base class for all beam line elements.

Definition at line 41 of file OpalElement.h.

Member Enumeration Documentation

anonymous enum

The common attributes for all elements.

Enumerator
TYPE
APERT
LENGTH
ELEMEDGE
WAKEF
PARTICLEMATTERINTERACTION
ORIGIN
ORIENTATION
X
Y
Z
THETA
PHI
PSI
DX
DY
DZ
DTHETA
DPHI
DPSI
COMMON

Definition at line 46 of file OpalElement.h.

enum OpalElement::ValueFlag

Switch for value desired on ATTLIST command.

Enumerator
ACTUAL_FLAG
IDEAL_FLAG
ERROR_FLAG

Definition at line 71 of file OpalElement.h.

Constructor & Destructor Documentation

OpalElement::~OpalElement ( )

virtual

Definition at line 138 of file OpalElement.cpp.

OpalElement::OpalElement	(	int	size,
		const char *	name,
		const char *	help
	)

protected

Exemplar constructor.

Definition at line 49 of file OpalElement.cpp.

References AttributeHandler::addAttributeOwner(), APERT, COMMON, DPHI, DPSI, DTHETA, DX, DY, DZ, ELEMEDGE, AttributeHandler::ELEMENT, Object::itsAttr, LENGTH, Attributes::makeReal(), Attributes::makeRealArray(), Attributes::makeString(), ORIENTATION, ORIGIN, PARTICLEMATTERINTERACTION, PHI, PSI, registerRealAttribute(), registerStringAttribute(), THETA, TYPE, WAKEF, X, Y, and Z.

Here is the call graph for this function:

OpalElement::OpalElement	(	const std::string &	name,
		OpalElement *	parent
	)

protected

Clone constructor.

Definition at line 133 of file OpalElement.cpp.

OpalElement::OpalElement ( )

private

Member Function Documentation

void OpalElement::fillRegisteredAttributes	(	const ElementBase &	base,
		ValueFlag
	)

virtual

Fill in all registered attributes.

Reimplemented in OpalCyclotron, OpalVariableRFCavityFringeField, OpalMultipoleT, OpalMultipoleTCurvedConstRadius, OpalMultipoleTCurvedVarRadius, OpalCavity, OpalVariableRFCavity, OpalMultipoleTStraight, OpalRingDefinition, OpalScalingFFAMagnet, OpalOffset::OpalLocalCartesianOffset, OpalOffset::OpalGlobalCartesianOffset, OpalOffset::OpalLocalCylindricalOffset, OpalTravelingWave, OpalKicker, OpalOffset::OpalGlobalCylindricalOffset, OpalSBend3D, OpalPolynomialTimeDependence, OpalSplineTimeDependence, OpalVKicker, OpalQuadrupole, OpalRBend3D, OpalStripper, OpalCCollimator, OpalMultipole, OpalOctupole, OpalParallelPlate, OpalPepperPot, OpalProbe, OpalSextupole, OpalSeptum, OpalFlexibleCollimator, OpalHKicker, OpalWire, OpalDegrader, OpalECollimator, OpalRCollimator, OpalSlit, OpalSolenoid, OpalCyclotronValley, OpalSeparator, OpalSRot, OpalYRot, OpalVerticalFFAMagnet, OpalBeamStripping, OpalRBend, OpalSBend, and OpalSource.

Definition at line 143 of file OpalElement.cpp.

References attributeRegistry, AttributeSet::begin(), Quaternion::conjugate(), AttributeSet::end(), Euclid3D::getAll(), Object::getBaseObject(), ElementBase::getCSTrafoGlobal2Local(), ElementBase::getElementLength(), ElementBase::getMisalignment(), Object::getOpalName(), CoordinateSystemTrafo::getOrigin(), Object::getParent(), CoordinateSystemTrafo::getRotation(), Util::getTaitBryantAngles(), getTypeName(), and AlignWrapper::offset().

Here is the call graph for this function:

AttCell * OpalElement::findRegisteredAttribute ( const std::string & name )

static

Find a registered attribute.

Definition at line 195 of file OpalElement.cpp.

References attributeRegistry, and name.

Referenced by AttList::writeTable().

std::pair< ElementBase::ApertureType, std::vector< double > > OpalElement::getApert ( ) const

Definition at line 219 of file OpalElement.cpp.

References APERT, ElementBase::CONIC_ELLIPTICAL, ElementBase::CONIC_RECTANGULAR, ElementBase::ELLIPTICAL, Attributes::getString(), Object::itsAttr, and ElementBase::RECTANGULAR.

Referenced by Aperture::calcul(), Aperture::run(), and update().

Here is the call graph for this function:

double OpalElement::getLength ( ) const

virtual

Return element length.

Implements Element.

Definition at line 372 of file OpalElement.cpp.

References Attributes::getReal(), Object::itsAttr, and LENGTH.

Referenced by OpalSBend::fillRegisteredAttributes(), OpalRBend::fillRegisteredAttributes(), OpalOctupole::fillRegisteredAttributes(), OpalMultipole::fillRegisteredAttributes(), OpalSextupole::fillRegisteredAttributes(), OpalQuadrupole::fillRegisteredAttributes(), and OpalMultipole::update().

Here is the call graph for this function:

const std::string OpalElement::getParticleMatterInteraction ( ) const

Definition at line 391 of file OpalElement.cpp.

References Object::findAttribute(), and Attributes::getString().

Here is the call graph for this function:

const std::string OpalElement::getTypeName ( ) const

Return the element's type name.

Definition at line 377 of file OpalElement.cpp.

References Object::findAttribute(), and Attributes::getString().

Referenced by fillRegisteredAttributes(), and Selector::handleElement().

Here is the call graph for this function:

const std::string OpalElement::getWakeConductivity ( ) const

const std::string OpalElement::getWakeF ( ) const

Return the element's type name.

Functions to get the wake field parametes

Definition at line 386 of file OpalElement.cpp.

References Object::findAttribute(), and Attributes::getString().

Here is the call graph for this function:

const std::string OpalElement::getWakeGeom ( ) const

std::vector<double> OpalElement::getWakeParam ( ) const

const std::string OpalElement::getWMaterial ( ) const

void OpalElement::operator= ( const OpalElement & )

private

void OpalElement::parse ( Statement & stat )

virtual

Parse the element.

Reimplemented from Object.

Definition at line 396 of file OpalElement.cpp.

References Statement::delimiter(), Object::findAttribute(), name, Attribute::parse(), Attribute::parseComponent(), Expressions::parseDelimiter(), Expressions::parseRealConst(), Expressions::parseString(), Round(), and Attribute::setDefault().

Here is the call graph for this function:

void OpalElement::print ( std::ostream & os ) const

virtual

Print the object.

Reimplemented from Object.

Reimplemented in OpalMultipoleT, OpalMultipoleTCurvedConstRadius, OpalMultipoleTCurvedVarRadius, OpalRingDefinition, OpalMultipoleTStraight, OpalOffset::OpalLocalCartesianOffset, OpalOffset::OpalGlobalCartesianOffset, OpalOffset::OpalLocalCylindricalOffset, OpalOffset::OpalGlobalCylindricalOffset, OpalPolynomialTimeDependence, OpalSplineTimeDependence, OpalBend, OpalRBend3D, OpalQuadrupole, OpalMultipole, OpalOctupole, OpalSextupole, and OpalMarker.

Definition at line 431 of file OpalElement.cpp.

References endl(), Object::getOpalName(), and Object::getParent().

Referenced by OpalMarker::print(), OpalOctupole::print(), OpalSextupole::print(), OpalMultipole::print(), OpalQuadrupole::print(), OpalRBend3D::print(), OpalBend::print(), OpalSplineTimeDependence::print(), OpalPolynomialTimeDependence::print(), OpalOffset::OpalGlobalCylindricalOffset::print(), OpalOffset::OpalLocalCylindricalOffset::print(), OpalOffset::OpalGlobalCartesianOffset::print(), OpalOffset::OpalLocalCartesianOffset::print(), OpalMultipoleTStraight::print(), OpalRingDefinition::print(), OpalMultipoleTCurvedConstRadius::print(), OpalMultipoleTCurvedVarRadius::print(), and OpalMultipoleT::print().

Here is the call graph for this function:

void OpalElement::printAttribute	(	std::ostream &	os,
		const std::string &	name,
		const std::string &	image,
		int &	len
	)

staticprotected

Print an attribute with a OPAL-8 name (as an expression).

Definition at line 665 of file OpalElement.cpp.

void OpalElement::printAttribute	(	std::ostream &	os,
		const std::string &	name,
		double	value,
		int &	len
	)

staticprotected

Print an attribute with a OPAL-8 name (as a constant).

Definition at line 677 of file OpalElement.cpp.

void OpalElement::printMultipoleStrength	(	std::ostream &	os,
		int	order,
		int &	len,
		const std::string &	sName,
		const std::string &	tName,
		const Attribute &	length,
		const Attribute &	vNorm,
		const Attribute &	vSkew
	)