ParticleMatterInteraction Class Reference

#include <ParticleMatterInteraction.h>

Inheritance diagram for ParticleMatterInteraction:

Collaboration diagram for ParticleMatterInteraction:

Public Member Functions
	ParticleMatterInteraction ()
	Exemplar constructor. More...
virtual	~ParticleMatterInteraction ()
virtual bool	canReplaceBy (Object *object)
	Test if replacement is allowed. More...
virtual ParticleMatterInteraction *	clone (const std::string &name)
	Make clone. More...
virtual void	execute ()
	Check the PARTICLEMATTERINTERACTION data. More...
virtual void	update ()
	Update the PARTICLEMATTERINTERACTION data. More...
void	print (std::ostream &os) const
	Print the object. More...
void	initParticleMatterInteractionHandler (ElementBase &element)
void	updateElement (ElementBase *element)
Public Member Functions inherited from Definition
virtual	~Definition ()
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...
Public Member Functions inherited from Object
virtual	~Object ()
void	copyAttributes (const Object &)
	Copy attributes from another object. 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	parse (Statement &)
	Parse the object. More...
virtual void	parseShortcut (Statement &, bool eval=true)
	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...
virtual void	setShared (bool)
	Set/reset 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 ParticleMatterInteraction *	find (const std::string &name)
	Find named PARTICLEMATTERINTERACTION. More...

Public Attributes
ParticleMatterInteractionHandler *	handler_m
Public Attributes inherited from Object
std::vector< Attribute >	itsAttr
	The object attributes. More...

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

Additional Inherited Members
Protected Member Functions inherited from Definition
	Definition (int size, const char *name, const char *help)
	Constructor for exemplars. More...
	Definition (const std::string &name, Definition *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)
Protected Attributes inherited from Object
bool	builtin
	Built-in flag. More...
bool	modified
	Dirty flag. More...
bool	flagged
	Object flag. More...

Detailed Description

Definition at line 34 of file ParticleMatterInteraction.h.

Constructor & Destructor Documentation

ParticleMatterInteraction() [1/3]

ParticleMatterInteraction::ParticleMatterInteraction

(

)

Exemplar constructor.

Definition at line 48 of file ParticleMatterInteraction.cpp.

References Object::builtin, clone(), OpalData::define(), OpalData::getInstance(), Object::itsAttr, Attributes::makeBool(), Attributes::makePredefinedString(), Attributes::makeReal(), Object::registerOwnership(), AttributeHandler::STATEMENT, Attrib::Distribution::TYPE, and update().

Referenced by clone().

Here is the call graph for this function:

~ParticleMatterInteraction()

ParticleMatterInteraction::~ParticleMatterInteraction ( )

virtual

Definition at line 98 of file ParticleMatterInteraction.cpp.

References handler_m.

ParticleMatterInteraction() [2/3]

ParticleMatterInteraction::ParticleMatterInteraction ( const ParticleMatterInteraction &  )

private

ParticleMatterInteraction() [3/3]

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

private

Definition at line 92 of file ParticleMatterInteraction.cpp.

Member Function Documentation

canReplaceBy()

bool ParticleMatterInteraction::canReplaceBy ( Object *  object )

virtual

Test if replacement is allowed.

Reimplemented from Object.

Definition at line 104 of file ParticleMatterInteraction.cpp.

clone()

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

virtual

Make clone.

Implements Object.

Definition at line 110 of file ParticleMatterInteraction.cpp.

References name, and ParticleMatterInteraction().

Referenced by ParticleMatterInteraction(), OpalCCollimator::update(), OpalDegrader::update(), OpalDrift::update(), OpalECollimator::update(), OpalFlexibleCollimator::update(), OpalPepperPot::update(), OpalQuadrupole::update(), OpalRBend::update(), OpalRBend3D::update(), OpalRCollimator::update(), OpalSBend::update(), OpalSlit::update(), and OpalVacuum::update().

Here is the call graph for this function:

execute()

void ParticleMatterInteraction::execute ( )

virtual

Check the PARTICLEMATTERINTERACTION data.

Reimplemented from Object.

Definition at line 115 of file ParticleMatterInteraction.cpp.

References update().

Here is the call graph for this function:

find()

ParticleMatterInteraction * ParticleMatterInteraction::find ( const std::string &  name )

static

Find named PARTICLEMATTERINTERACTION.

Definition at line 120 of file ParticleMatterInteraction.cpp.

References OpalData::find(), OpalData::getInstance(), and name.

Referenced by OpalCCollimator::update(), OpalDegrader::update(), OpalDrift::update(), OpalECollimator::update(), OpalFlexibleCollimator::update(), OpalPepperPot::update(), OpalQuadrupole::update(), OpalRBend::update(), OpalRBend3D::update(), OpalRCollimator::update(), OpalSBend::update(), OpalSlit::update(), and OpalVacuum::update().

Here is the call graph for this function:

initParticleMatterInteractionHandler()

void ParticleMatterInteraction::initParticleMatterInteractionHandler

(

ElementBase &

element

)

Definition at line 136 of file ParticleMatterInteraction.cpp.

References endl(), Attributes::getBool(), Object::getOpalName(), Attributes::getReal(), Attributes::getString(), gmsg, handler_m, Object::itsAttr, and Attrib::Distribution::TYPE.

Referenced by OpalCCollimator::update(), OpalDegrader::update(), OpalDrift::update(), OpalECollimator::update(), OpalFlexibleCollimator::update(), OpalPepperPot::update(), OpalQuadrupole::update(), OpalRBend::update(), OpalRBend3D::update(), OpalRCollimator::update(), OpalSBend::update(), OpalSlit::update(), and OpalVacuum::update().

Here is the call graph for this function:

operator=()

void ParticleMatterInteraction::operator= ( const ParticleMatterInteraction &  )

private

print()

void ParticleMatterInteraction::print ( std::ostream &  msg ) const

virtual

Print the object.

Reimplemented from Object.

Definition at line 159 of file ParticleMatterInteraction.cpp.

References endl(), ParticleMatterInteractionHandler::getElement(), ElementBase::getName(), Object::getOpalName(), Attributes::getReal(), Attributes::getString(), handler_m, Object::itsAttr, and Attrib::Distribution::TYPE.

Referenced by operator<<().

Here is the call graph for this function:

update()

void ParticleMatterInteraction::update ( )

virtual

Update the PARTICLEMATTERINTERACTION data.

Reimplemented from Object.

Definition at line 130 of file ParticleMatterInteraction.cpp.

References Object::getOpalName(), and Object::setOpalName().

Referenced by execute(), and ParticleMatterInteraction().

Here is the call graph for this function:

updateElement()

void ParticleMatterInteraction::updateElement

(

ElementBase *

element

)

Definition at line 155 of file ParticleMatterInteraction.cpp.

References handler_m, and ParticleMatterInteractionHandler::updateElement().

Here is the call graph for this function:

Member Data Documentation

handler_m

ParticleMatterInteractionHandler* ParticleMatterInteraction::handler_m

Definition at line 64 of file ParticleMatterInteraction.h.

Referenced by initParticleMatterInteractionHandler(), print(), OpalCCollimator::update(), OpalDegrader::update(), OpalDrift::update(), OpalECollimator::update(), OpalFlexibleCollimator::update(), OpalPepperPot::update(), OpalQuadrupole::update(), OpalRBend::update(), OpalRBend3D::update(), OpalRCollimator::update(), OpalSBend::update(), OpalSlit::update(), OpalVacuum::update(), updateElement(), and ~ParticleMatterInteraction().

---

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

• /Users/gsell/src/OPAL/src/src/Structure/ParticleMatterInteraction.h
• /Users/gsell/src/OPAL/src/src/Structure/ParticleMatterInteraction.cpp