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

#include <StringConstant.h>

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

Public Member Functions

 StringConstant ()
 Exemplar constructor. More...
 
virtual ~StringConstant ()
 
virtual bool canReplaceBy (Object *object)
 Test if object can be replaced. More...
 
virtual StringConstantclone (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 std::string getString () 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 getReal () const
 Return real 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...
 
Attributevalue ()
 Return the attribute representing the value of the definition. More...
 
const Attributevalue () const
 Return the attribute representing the value of the definition. 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...
 

Private Member Functions

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

Additional Inherited Members

- Public Attributes inherited from Object
std::vector< AttributeitsAttr
 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
 
RCObjectoperator= (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 StringConstant.h.

Constructor & Destructor Documentation

◆ StringConstant() [1/4]

StringConstant::StringConstant ( )

◆ ~StringConstant()

StringConstant::~StringConstant ( )
virtual

Definition at line 283 of file StringConstant.cpp.

◆ StringConstant() [2/4]

StringConstant::StringConstant ( const StringConstant )
private

◆ StringConstant() [3/4]

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

Definition at line 269 of file StringConstant.cpp.

◆ StringConstant() [4/4]

StringConstant::StringConstant ( const std::string &  name,
StringConstant parent,
const std::string &  value 
)
private

Definition at line 274 of file StringConstant.cpp.

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

Here is the call graph for this function:

Member Function Documentation

◆ canReplaceBy()

bool StringConstant::canReplaceBy ( Object object)
virtual

Test if object can be replaced.

Reimplemented from Object.

Definition at line 287 of file StringConstant.cpp.

◆ clone()

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

Make clone.

Implements Object.

Definition at line 292 of file StringConstant.cpp.

References name, and StringConstant().

Here is the call graph for this function:

◆ getString()

std::string StringConstant::getString ( ) const
virtual

Return value.

Reimplemented from ValueDefinition.

Definition at line 297 of file StringConstant.cpp.

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

Referenced by OpalData::getVariableData(), and Expressions::parseStringValue().

Here is the call graph for this function:

◆ operator=()

void StringConstant::operator= ( const StringConstant )
private

◆ print()

void StringConstant::print ( std::ostream &  os) const
virtual

Print the constant.

Reimplemented from Object.

Definition at line 302 of file StringConstant.cpp.

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

Here is the call graph for this function:

◆ printValue()

void StringConstant::printValue ( std::ostream &  os) const
virtual

Print its value.

Reimplemented from Object.

Definition at line 307 of file StringConstant.cpp.

References Object::itsAttr.


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