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

The WAKE definition. More...

#include <OpalWake.h>

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

Public Member Functions

 OpalWake ()
 Exemplar constructor. More...
 
virtual ~OpalWake ()
 
virtual bool canReplaceBy (Object *object)
 Test if replacement is allowed. More...
 
virtual OpalWakeclone (const std::string &name)
 Make clone. More...
 
virtual void execute ()
 Check the WAKE data. More...
 
virtual void update ()
 Update the WAKE data. More...
 
void print (std::ostream &os) const
 Print the object. More...
 
int getNumberOfBins ()
 
void initWakefunction (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 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 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 &)
 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 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 OpalWakefind (const std::string &name)
 Find named WAKE. More...
 

Public Attributes

WakeFunctionwf_m
 
- Public Attributes inherited from Object
std::vector< AttributeitsAttr
 The object attributes (see Attribute.hh). More...
 

Private Member Functions

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

Private Attributes

PartData reference
 
ElementBaseitsElement_m
 

Static Private Attributes

static const double energy_scale
 

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

The WAKE definition.

Definition at line 34 of file OpalWake.h.

Constructor & Destructor Documentation

OpalWake::OpalWake ( )
OpalWake::~OpalWake ( )
virtual

Definition at line 114 of file OpalWake.cpp.

References wf_m.

OpalWake::OpalWake ( const OpalWake )
private
OpalWake::OpalWake ( const std::string &  name,
OpalWake parent 
)
private

Definition at line 108 of file OpalWake.cpp.

Member Function Documentation

bool OpalWake::canReplaceBy ( Object object)
virtual

Test if replacement is allowed.

Reimplemented from Object.

Definition at line 120 of file OpalWake.cpp.

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

Make clone.

Implements Object.

Definition at line 126 of file OpalWake.cpp.

References OpalWake().

Referenced by OpalWake().

Here is the call graph for this function:

void OpalWake::execute ( )
virtual

Check the WAKE data.

Reimplemented from Object.

Definition at line 131 of file OpalWake.cpp.

References update().

Here is the call graph for this function:

OpalWake * OpalWake::find ( const std::string &  name)
static
int OpalWake::getNumberOfBins ( )

Definition at line 146 of file OpalWake.cpp.

References Attributes::getReal(), Object::itsAttr, and Attrib::Distribution::NBIN.

Here is the call graph for this function:

void OpalWake::initWakefunction ( ElementBase element)
void OpalWake::operator= ( const OpalWake )
private
void OpalWake::print ( std::ostream &  msg) const
virtual

Print the object.

Reimplemented from Object.

Definition at line 241 of file OpalWake.cpp.

References endl(), Object::getOpalName(), Attributes::getReal(), Object::itsAttr, and Attrib::Distribution::NBIN.

Referenced by operator<<().

Here is the call graph for this function:

void OpalWake::update ( )
virtual

Update the WAKE data.

Reimplemented from Object.

Definition at line 151 of file OpalWake.cpp.

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

Referenced by execute(), and OpalWake().

Here is the call graph for this function:

Member Data Documentation

const double OpalWake::energy_scale
staticprivate

Definition at line 80 of file OpalWake.h.

ElementBase* OpalWake::itsElement_m
private

Definition at line 83 of file OpalWake.h.

Referenced by initWakefunction().

PartData OpalWake::reference
private

Definition at line 77 of file OpalWake.h.

WakeFunction* OpalWake::wf_m

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