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

The SAMPLING definition. More...

#include <OpalSample.h>

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

Public Member Functions

 OpalSample ()
 Exemplar constructor. More...
 
virtual ~OpalSample ()
 
virtual OpalSampleclone (const std::string &name)
 Make clone. More...
 
virtual void execute ()
 Check the OpalSample data. More...
 
void initialize (const std::string &dvarName, double lower, double upper, size_t modulo=1, bool sequence=false)
 
std::string getVariable () const
 
unsigned int getSize () const
 
- 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...
 
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 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 OpalSamplefind (const std::string &name)
 Find sampling method. More...
 

Public Attributes

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

Private Member Functions

 OpalSample (const std::string &name, OpalSample *parent)
 
 OpalSample (const OpalSample &)=delete
 Not implemented. More...
 
void operator= (const OpalSample &)=delete
 

Private Attributes

unsigned int size_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

The SAMPLING definition.

Definition at line 15 of file OpalSample.h.

Constructor & Destructor Documentation

OpalSample::OpalSample ( )

Exemplar constructor.

Definition at line 34 of file OpalSample.cpp.

References Attrib::Distribution::FNAME, Object::itsAttr, Attributes::makeBool(), Attributes::makeReal(), Attributes::makeString(), Object::registerOwnership(), AttributeHandler::STATEMENT, and Attrib::Distribution::TYPE.

Referenced by clone().

Here is the call graph for this function:

virtual OpalSample::~OpalSample ( )
inlinevirtual

Definition at line 22 of file OpalSample.h.

OpalSample::OpalSample ( const OpalSample )
privatedelete

Not implemented.

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

Private copy constructor, called by clone

Definition at line 64 of file OpalSample.cpp.

Member Function Documentation

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

Make clone.

Implements Object.

Definition at line 69 of file OpalSample.cpp.

References OpalSample().

Here is the call graph for this function:

void OpalSample::execute ( )
virtual

Check the OpalSample data.

Reimplemented from Object.

Definition at line 74 of file OpalSample.cpp.

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

Find sampling method.

Definition at line 79 of file OpalSample.cpp.

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

Referenced by SampleCmd::execute().

Here is the call graph for this function:

unsigned int OpalSample::getSize ( ) const
inline

Definition at line 58 of file OpalSample.h.

References size_m.

Referenced by SampleCmd::execute(), and initialize().

std::string OpalSample::getVariable ( ) const

Definition at line 180 of file OpalSample.cpp.

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

Referenced by SampleCmd::execute().

Here is the call graph for this function:

void OpalSample::initialize ( const std::string &  dvarName,
double  lower,
double  upper,
size_t  modulo = 1,
bool  sequence = false 
)
void OpalSample::operator= ( const OpalSample )
privatedelete

Member Data Documentation

std::shared_ptr<SamplingMethod> OpalSample::sampleMethod_m

Definition at line 43 of file OpalSample.h.

Referenced by SampleCmd::execute(), and initialize().

unsigned int OpalSample::size_m
private

Definition at line 54 of file OpalSample.h.

Referenced by getSize(), and initialize().


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