OpalCCollimator Class Reference

#include <OpalCCollimator.h>

Inheritance diagram for OpalCCollimator:

Collaboration diagram for OpalCCollimator:

Public Types
enum	{   XSTART = COMMON , XEND , YSTART , YEND ,   ZSTART , ZEND , WIDTH , SIZE }
	The attributes of class OpalCCollimator. More...
Public Types inherited from OpalElement
enum	{   TYPE , APERT , LENGTH , ELEMEDGE ,   WAKEF , PARTICLEMATTERINTERACTION , ORIGIN , ORIENTATION ,   X , Y , Z , THETA ,   PHI , PSI , DX , DY ,   DZ , DTHETA , DPHI , DPSI ,   OUTFN , DELETEONTRANSVERSEEXIT , COMMON }
	The common attributes for all elements. More...
Public Types inherited from Element
enum	ReferenceType { IS_ENTRY , IS_CENTRE , IS_EXIT }
	Reference for element positioning. More...

Public Member Functions
	OpalCCollimator ()
	Exemplar constructor.
virtual	~OpalCCollimator ()
virtual OpalCCollimator *	clone (const std::string &name)
	Make clone.
virtual void	update ()
	Update the embedded CLASSIC collimator.
Public Member Functions inherited from OpalElement
virtual	~OpalElement ()
virtual double	getLength () const
	Return element length.
const std::string	getTypeName () const
	Return the element's type name.
std::pair< ApertureType, std::vector< double > >	getApert () const
const std::string	getWakeF () const
	Return the element's type name.
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.
virtual void	print (std::ostream &) const
	Print the object.
virtual void	updateUnknown (ElementBase *)
	Transmit the `‘unknown’' (not known to OPAL) attributes to CLASSIC.
Public Member Functions inherited from Element
virtual	~Element ()
virtual bool	canReplaceBy (Object *object)
	Test if replacement is allowed.
virtual const std::string	getCategory () const
	Return the object category as a string.
virtual bool	shouldTrace () const
	Trace flag.
virtual bool	shouldUpdate () const
	Update flag.
virtual double	getEntrance (ReferenceType) const
	Return arc length from origin to entrance (negative !).
virtual double	getExit (ReferenceType) const
	Return arc length from origin to exit (positive !).
virtual void	setShared (bool)
	Set shared flag.
ElementBase *	getElement () const
	Return the embedded CLASSIC element.
void	setElement (ElementBase *)
	Assign new CLASSIC element.
Public Member Functions inherited from Object
virtual	~Object ()
void	copyAttributes (const Object &)
	Copy attributes from another object.
virtual void	execute ()
	Execute the command.
virtual Attribute *	findAttribute (const std::string &name)
	Find an attribute by name.
virtual const Attribute *	findAttribute (const std::string &name) const
	Find an attribute by name.
virtual Object *	makeTemplate (const std::string &, TokenStream &, Statement &)
	Macro handler function.
virtual Object *	makeInstance (const std::string &name, Statement &, const Parser *)
	Macro handler function.
virtual void	parseShortcut (Statement &, bool eval=true)
	Parser for single-attribute commands.
virtual void	printValue (std::ostream &) const
virtual void	printHelp (std::ostream &) const
	Print help.
virtual void	replace (Object *oldObject, Object *newObject)
	Replace references.
bool	isBuiltin () const
	True, if [b]this[/b] is a built-in object.
virtual bool	isShared () const
	Shared flag.
void	setDirty (bool)
	Set/reset the [b]modified[/b] flag.
bool	isDirty () const
	True, if the [b]modified[/b] flag is set.
void	setFlag (bool)
	Flag/unflag this object, e. g. to control output of objects for.
bool	isFlagged () const
	True, if [b]this[/b] is flagged by setFlag(true).
const Object *	getBaseObject () const
	Return the object's base type object.
const std::string &	getOpalName () const
	Return object name.
Object *	getParent () const
	Return parent pointer.
bool	isTreeMember (const Object *subTree) const
	Test for tree membership.
void	setOpalName (const std::string &name)
	Set object name.
void	setParent (Object *)
	Set parent object.
void	clear ()
	Clear the occurrence counter.
int	increment ()
	Increment and return the occurrence counter.
int	occurrenceCount ()
	Return the occurrence counter.
void	registerReference (Invalidator *a)
	Register a reference to this object.
void	unregisterReference (Invalidator *a)
	Unegister a reference to this object.
void	registerOwnership (const AttributeHandler::OwnerType &itsClass) const
Public Member Functions inherited from RCObject
int	addReference () const
	Increment reference count.
int	removeReference () const
	Decrement the reference count.
bool	isShared () const
	Test for sharing.

Private Member Functions
	OpalCCollimator (const OpalCCollimator &)
void	operator= (const OpalCCollimator &)
	OpalCCollimator (const std::string &name, OpalCCollimator *parent)

Private Attributes
ParticleMatterInteraction *	parmatint_m

Additional Inherited Members
Static Public Member Functions inherited from Element
static Element *	find (const std::string &name)
	Find named Element.
Public Attributes inherited from Object
std::vector< Attribute >	itsAttr
	The object attributes.
Protected Member Functions inherited from OpalElement
	OpalElement (int size, const char *name, const char *help)
	Exemplar constructor.
	OpalElement (const std::string &name, OpalElement *parent)
	Clone constructor.
void	registerOwnership () const
Protected Member Functions inherited from Element
	Element (int size, const char *name, const char *help)
	Constructor for exemplars.
	Element (const std::string &name, Element *parent)
	Constructor for clones.
Protected Member Functions inherited from Object
	Object (int size, const char *name, const char *help)
	Constructor for exemplars.
	Object (const std::string &name, Object *parent)
	Constructor for clones.
Protected Member Functions inherited from RCObject
	RCObject ()
	Default constructor.
	RCObject (const RCObject &)
	Copy constructor.
virtual	~RCObject ()=0
RCObject &	operator= (const RCObject &right)
Static Protected Member Functions inherited from OpalElement
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.
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).
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).
Protected Attributes inherited from Object
bool	builtin
	Built-in flag.
bool	modified
	Dirty flag.
bool	flagged
	Object flag.

Detailed Description

Definition at line 25 of file OpalCCollimator.h.

Member Enumeration Documentation

anonymous enum

anonymous enum

The attributes of class OpalCCollimator.

Enumerator
XSTART
XEND
YSTART
YEND
ZSTART
ZEND
WIDTH
SIZE

Definition at line 30 of file OpalCCollimator.h.

Constructor & Destructor Documentation

OpalCCollimator() [1/3]

OpalCCollimator::OpalCCollimator

(

)

Exemplar constructor.

Definition at line 25 of file OpalCCollimator.cpp.

References Object::itsAttr, Attributes::makeReal(), OpalElement::registerOwnership(), Element::setElement(), WIDTH, XEND, XSTART, YEND, YSTART, ZEND, and ZSTART.

Referenced by clone().

Here is the call graph for this function:

~OpalCCollimator()

OpalCCollimator::~OpalCCollimator ( )

virtual

Definition at line 57 of file OpalCCollimator.cpp.

References parmatint_m.

OpalCCollimator() [2/3]

OpalCCollimator::OpalCCollimator ( const OpalCCollimator &  )

private

OpalCCollimator() [3/3]

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

private

Definition at line 50 of file OpalCCollimator.cpp.

References name, and Element::setElement().

Here is the call graph for this function:

Member Function Documentation

clone()

OpalCCollimator * OpalCCollimator::clone ( const std::string &  name )

virtual

Make clone.

Implements Object.

Definition at line 63 of file OpalCCollimator.cpp.

References name, and OpalCCollimator().

Here is the call graph for this function:

operator=()

void OpalCCollimator::operator= ( const OpalCCollimator &  )

private

update()

void OpalCCollimator::update ( )

virtual

Update the embedded CLASSIC collimator.

Reimplemented from OpalElement.

Definition at line 68 of file OpalCCollimator.cpp.

References ParticleMatterInteraction::clone(), ParticleMatterInteraction::find(), Element::getElement(), Attributes::getReal(), Attributes::getString(), ParticleMatterInteraction::handler_m, ParticleMatterInteraction::initParticleMatterInteractionHandler(), Object::itsAttr, OpalElement::LENGTH, Units::mm2m, OpalElement::OUTFN, parmatint_m, OpalElement::PARTICLEMATTERINTERACTION, CCollimator::setDimensions(), ElementBase::setElementLength(), ElementBase::setOutputFN(), ElementBase::setParticleMatterInteraction(), OpalElement::update(), OpalElement::updateUnknown(), WIDTH, XEND, XSTART, YEND, YSTART, ZEND, and ZSTART.

Here is the call graph for this function:

Member Data Documentation

parmatint_m

ParticleMatterInteraction* OpalCCollimator::parmatint_m

private

Definition at line 60 of file OpalCCollimator.h.

Referenced by update(), and ~OpalCCollimator().

---

The documentation for this class was generated from the following files:

• src/Elements/OpalCCollimator.h
• src/Elements/OpalCCollimator.cpp