#include <RealConstant.h>

Inheritance diagram for RealConstant:

[legend]

Collaboration diagram for RealConstant:

[legend]

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

	RealConstant (const std::string &name, RealConstant *parent, double value)
	Constructor for built-in constants. More...

virtual	~RealConstant ()

virtual bool	canReplaceBy (Object *object)
	Test if object can be replaced. More...

virtual RealConstant *	clone (const std::string &name)
	Make clone. More...

virtual void	print (std::ostream &) const
	Print the constant. More...

virtual void	printValue (std::ostream &os) const
	Print its value. More...

virtual double	getReal () const
	Return value. More...

Public Member Functions inherited from ValueDefinition
virtual	~ValueDefinition ()

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...

virtual bool	getBool () const
	Return logical value. More...

virtual bool	getBoolComponent (int) const
	Return indexed logical value. More...

virtual double	getRealComponent (int) const
	Return indexed real value. More...

virtual std::string	getString () const
	Return string value. More...

virtual std::string	getStringComponent (int) const
	Return indexed string value. More...

Attribute &	value ()
	Return the attribute representing the value of the definition. More...

const Attribute &	value () const
	Return the attribute representing the value of the definition. More...

Public Member Functions inherited from Object
virtual	~Object ()

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 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	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...

Private Member Functions
	RealConstant (const RealConstant &)

void	operator= (const RealConstant &)

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

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

Protected Member Functions inherited from ValueDefinition
	ValueDefinition (int size, const char name, const char help)
	Constructor for exemplars. More...

	ValueDefinition (const std::string &name, ValueDefinition *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 ValueDefinition
const std::string	itsPrefix
	The declaration prefix. More...

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 24 of file RealConstant.h.

Constructor & Destructor Documentation

◆ RealConstant() [1/4]

RealConstant::RealConstant ( )

Exemplar constructor.

Definition at line 31 of file RealConstant.cpp.

References Physics::amu, Physics::c, OpalData::create(), Physics::deg2rad, Physics::e, OpalData::getInstance(), Object::itsAttr, Physics::m_alpha, Physics::m_c, Physics::m_d, Physics::m_e, Physics::m_h2p, Physics::m_hm, Physics::m_mu, Physics::m_p, Physics::m_u, Physics::m_xe, Attributes::makeReal(), IpplInfo::myNode(), OPAL_VERSION_MAJOR, OPAL_VERSION_MINOR, OPAL_VERSION_PATCH, Physics::pi, Physics::rad2deg, Object::registerOwnership(), AttributeHandler::STATEMENT, and Physics::two_pi.

Referenced by clone().

Here is the call graph for this function:

◆ RealConstant() [2/4]

RealConstant::RealConstant	(	const std::string &	name,
		RealConstant *	parent,
		double	value
	)

Constructor for built-in constants.

Definition at line 74 of file RealConstant.cpp.

References Object::builtin, Object::itsAttr, Attributes::setReal(), and ValueDefinition::value().

Here is the call graph for this function:

◆ ~RealConstant()

RealConstant::~RealConstant ( )

virtual

Definition at line 83 of file RealConstant.cpp.

◆ RealConstant() [3/4]

RealConstant::RealConstant ( const RealConstant & )

private

◆ RealConstant() [4/4]

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

private

Definition at line 69 of file RealConstant.cpp.

Member Function Documentation

◆ canReplaceBy()

bool RealConstant::canReplaceBy ( Object * object )

virtual

Test if object can be replaced.

Reimplemented from Object.

Definition at line 87 of file RealConstant.cpp.

◆ clone()

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

virtual

Make clone.

Implements Object.

Definition at line 92 of file RealConstant.cpp.

References name, and RealConstant().

Here is the call graph for this function:

◆ getReal()

double RealConstant::getReal ( ) const

virtual

Return value.

Reimplemented from ValueDefinition.

Definition at line 97 of file RealConstant.cpp.

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

Here is the call graph for this function:

◆ operator=()

void RealConstant::operator= ( const RealConstant & )

private

◆ print()

void RealConstant::print ( std::ostream & os ) const

virtual

Print the constant.

Reimplemented from Object.

Definition at line 102 of file RealConstant.cpp.

References endl(), Object::getOpalName(), and Object::itsAttr.

Here is the call graph for this function:

◆ printValue()

void RealConstant::printValue ( std::ostream & os ) const

virtual

Print its value.

Reimplemented from Object.

Definition at line 107 of file RealConstant.cpp.

References Object::itsAttr.

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

/Users/gsell/src/OPAL/src/src/ValueDefinitions/RealConstant.h
/Users/gsell/src/OPAL/src/src/ValueDefinitions/RealConstant.cpp

Public Member Functions

Private Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ RealConstant() [1/4]

◆ RealConstant() [2/4]

◆ ~RealConstant()

◆ RealConstant() [3/4]

◆ RealConstant() [4/4]

Member Function Documentation

◆ canReplaceBy()

◆ clone()

◆ getReal()

◆ operator=()

◆ print()

◆ printValue()