OPAL (Object Oriented Parallel Accelerator Library) 2022.1
OPAL
Public Member Functions | Static Public Member Functions | Public Attributes | Private Types | Private Member Functions | Private Attributes | List of all members
ParticleMatterInteraction Class Reference

#include <ParticleMatterInteraction.h>

Inheritance diagram for ParticleMatterInteraction:
Inheritance graph
[legend]
Collaboration diagram for ParticleMatterInteraction:
Collaboration graph
[legend]

Public Member Functions

 ParticleMatterInteraction ()
 Exemplar constructor. More...
 
virtual ~ParticleMatterInteraction ()
 
virtual bool canReplaceBy (Object *object)
 Test if replacement is allowed. More...
 
virtual ParticleMatterInteractionclone (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 ()
 
virtual bool canReplaceBy (Object *object)
 Test if replacement is allowed. More...
 
virtual Objectclone (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 AttributefindAttribute (const std::string &name)
 Find an attribute by name. More...
 
virtual const AttributefindAttribute (const std::string &name) const
 Find an attribute by name. More...
 
virtual const std::string getCategory () const =0
 Return the object category as a string. More...
 
virtual bool shouldTrace () const =0
 Trace flag. More...
 
virtual bool shouldUpdate () const =0
 Update flag. More...
 
virtual ObjectmakeTemplate (const std::string &, TokenStream &, Statement &)
 Macro handler function. More...
 
virtual ObjectmakeInstance (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 print (std::ostream &) const
 Print the object. 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...
 
virtual void update ()
 Update this object. 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 ObjectgetBaseObject () const
 Return the object's base type object. More...
 
const std::string & getOpalName () const
 Return object name. More...
 
ObjectgetParent () 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 ParticleMatterInteractionfind (const std::string &name)
 Find named PARTICLEMATTERINTERACTION. More...
 

Public Attributes

ParticleMatterInteractionHandlerhandler_m
 
- Public Attributes inherited from Object
std::vector< AttributeitsAttr
 The object attributes. More...
 

Private Types

enum class  InteractionType : unsigned short { SCATTERING , BEAMSTRIPPING }
 

Private Member Functions

 ParticleMatterInteraction (const ParticleMatterInteraction &)
 
void operator= (const ParticleMatterInteraction &)
 
 ParticleMatterInteraction (const std::string &name, ParticleMatterInteraction *parent)
 
void getInteractionType ()
 

Private Attributes

InteractionType type_m
 

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
 
RCObjectoperator= (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.

Member Enumeration Documentation

◆ InteractionType

enum class ParticleMatterInteraction::InteractionType : unsigned short
strongprivate
Enumerator
SCATTERING 
BEAMSTRIPPING 

Definition at line 66 of file ParticleMatterInteraction.h.

Constructor & Destructor Documentation

◆ ParticleMatterInteraction() [1/3]

ParticleMatterInteraction::ParticleMatterInteraction ( )

◆ ~ParticleMatterInteraction()

ParticleMatterInteraction::~ParticleMatterInteraction ( )
virtual

Definition at line 102 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 96 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 108 of file ParticleMatterInteraction.cpp.

◆ clone()

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

◆ execute()

void ParticleMatterInteraction::execute ( )
virtual

Check the PARTICLEMATTERINTERACTION data.

Reimplemented from Object.

Definition at line 119 of file ParticleMatterInteraction.cpp.

References update().

Here is the call graph for this function:

◆ find()

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

◆ getInteractionType()

void ParticleMatterInteraction::getInteractionType ( )
private

Definition at line 141 of file ParticleMatterInteraction.cpp.

References BEAMSTRIPPING, Attributes::getString(), Object::itsAttr, SCATTERING, Attrib::Distribution::TYPE, and type_m.

Referenced by initParticleMatterInteractionHandler().

Here is the call graph for this function:

◆ initParticleMatterInteractionHandler()

void ParticleMatterInteraction::initParticleMatterInteractionHandler ( ElementBase element)

◆ operator=()

void ParticleMatterInteraction::operator= ( const ParticleMatterInteraction )
private

◆ print()

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

◆ update()

void ParticleMatterInteraction::update ( )
virtual

Update the PARTICLEMATTERINTERACTION data.

Reimplemented from Object.

Definition at line 136 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 180 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

◆ type_m

InteractionType ParticleMatterInteraction::type_m
private

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