#include <OpalSample.h>

Inheritance diagram for OpalSample:

[legend]

Collaboration diagram for OpalSample:

[legend]

Public Member Functions
	OpalSample ()
	Exemplar constructor. More...

virtual	~OpalSample ()

virtual OpalSample *	clone (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...

virtual Object *	clone (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 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 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 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	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 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 OpalSample *	find (const std::string &name)
	Find sampling method. More...

Public Attributes
std::shared_ptr< SamplingMethod >	sampleMethod_m

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

Private Types
enum class	OpalSampleMethod : unsigned short { UNIFORM_INT , UNIFORM , GAUSSIAN , FROMFILE , LATIN_HYPERCUBE , RANDOM_SEQUENCE_UNIFORM_INT , RANDOM_SEQUENCE_UNIFORM }

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

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 31 of file OpalSample.h.

Member Enumeration Documentation

◆ OpalSampleMethod

enum class OpalSample::OpalSampleMethod : unsigned short

strongprivate

Enumerator
UNIFORM_INT
UNIFORM
GAUSSIAN
FROMFILE
LATIN_HYPERCUBE
RANDOM_SEQUENCE_UNIFORM_INT
RANDOM_SEQUENCE_UNIFORM

Definition at line 61 of file OpalSample.h.

Constructor & Destructor Documentation

◆ OpalSample() [1/3]

OpalSample::OpalSample ( )

Exemplar constructor.

Definition at line 52 of file OpalSample.cpp.

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

Referenced by clone().

Here is the call graph for this function:

◆ ~OpalSample()

virtual OpalSample::~OpalSample ( )

inlinevirtual

Definition at line 37 of file OpalSample.h.

◆ OpalSample() [2/3]

OpalSample::OpalSample ( const OpalSample & )

privatedelete

Not implemented.

◆ OpalSample() [3/3]

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

private

Private copy constructor, called by clone

Definition at line 89 of file OpalSample.cpp.

Member Function Documentation

◆ clone()

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

virtual

Make clone.

Implements Object.

Definition at line 94 of file OpalSample.cpp.

References name, and OpalSample().

Here is the call graph for this function:

◆ execute()

void OpalSample::execute ( )

virtual

Check the OpalSample data.

Reimplemented from Object.

Definition at line 99 of file OpalSample.cpp.

◆ find()

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

static

Find sampling method.

Definition at line 104 of file OpalSample.cpp.

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

Referenced by SampleCmd::execute().

Here is the call graph for this function:

◆ getSize()

unsigned int OpalSample::getSize ( ) const

inline

Definition at line 82 of file OpalSample.h.

References size_m.

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

◆ getVariable()

std::string OpalSample::getVariable ( ) const

Definition at line 232 of file OpalSample.cpp.

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

Referenced by SampleCmd::execute().

Here is the call graph for this function:

◆ initialize()

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

Definition at line 115 of file OpalSample.cpp.

References Attrib::Distribution::FNAME, Hypervolume::FromFile(), FROMFILE, GAUSSIAN, Attributes::getBool(), Attributes::getReal(), getSize(), Attributes::getString(), Object::itsAttr, LATIN_HYPERCUBE, RANDOM_SEQUENCE_UNIFORM, RANDOM_SEQUENCE_UNIFORM_INT, sampleMethod_m, Options::seed, size_m, Attrib::Distribution::TYPE, UNIFORM, and UNIFORM_INT.

Referenced by SampleCmd::execute().

Here is the call graph for this function:

◆ operator=()

void OpalSample::operator= ( const OpalSample & )

privatedelete

Member Data Documentation

◆ sampleMethod_m

std::shared_ptr<SamplingMethod> OpalSample::sampleMethod_m

Definition at line 58 of file OpalSample.h.

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

◆ size_m

unsigned int OpalSample::size_m

private

Definition at line 78 of file OpalSample.h.

Referenced by getSize(), and initialize().

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

/Users/gsell/src/OPAL/src/src/Sample/OpalSample.h
/Users/gsell/src/OPAL/src/src/Sample/OpalSample.cpp

Public Member Functions

Static Public Member Functions

Public Attributes

Private Types

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ OpalSampleMethod

Constructor & Destructor Documentation

◆ OpalSample() [1/3]

◆ ~OpalSample()

◆ OpalSample() [2/3]

◆ OpalSample() [3/3]

Member Function Documentation

◆ clone()

◆ execute()

◆ find()

◆ getSize()

◆ getVariable()

◆ initialize()

◆ operator=()

Member Data Documentation

◆ sampleMethod_m

◆ size_m