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

Parser for an attribute of type string. More...

#include <String.h>

Inheritance diagram for Attributes::String:
Inheritance graph
[legend]
Collaboration diagram for Attributes::String:
Collaboration graph
[legend]

Public Member Functions

 String (const std::string &name, const std::string &help)
 Constructor. More...
 
virtual ~String ()
 
virtual const std::string & getType () const
 Return attribute type string `‘string’'. More...
 
virtual void parse (Attribute &, Statement &, bool) const
 Parse the attribute. More...
 
- Public Member Functions inherited from AttributeHandler
 AttributeHandler (const std::string &name, const std::string &help, AttributeBase *def)
 Constructor. More...
 
virtual ~AttributeHandler ()
 
virtual AttributeHandlerclone () const
 Make clone. More...
 
virtual AttributeBasegetDefault () const
 Return default value. More...
 
virtual const std::string & getHelp () const
 Return help string. More...
 
virtual const std::string & getName () const
 Return attribute name. More...
 
virtual const std::string & getType () const =0
 Return attribute type. More...
 
virtual void parse (Attribute &a, Statement &s, bool eval) const =0
 Parse new value. More...
 
virtual void parseComponent (Attribute &a, Statement &s, bool eval, int i) const
 Parse component value. More...
 
bool isDeferred () const
 Return defer flag. More...
 
void setDeferred (bool)
 Set or reset defer flag. More...
 
bool isReadOnly () const
 Return read-only flag. More...
 
void setReadOnly (bool)
 Set or reset read-only flag. More...
 
void setPredefinedValues (const std::set< std::string > &, const std::string &)
 Add predefined strings values to the help. More...
 
- 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

 String ()
 
 String (const String &)
 
void operator= (const String &)
 

Additional Inherited Members

- Public Types inherited from AttributeHandler
enum  OwnerType {
  ELEMENT , COMMAND , SUB_COMMAND , STATEMENT ,
  NONE
}
 
- Static Public Member Functions inherited from AttributeHandler
static std::multimap< OwnerType, std::string > getOwner (const std::string &att)
 
static void addAttributeOwner (const std::string &owner, const OwnerType &type, const std::string &name)
 
- 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 AttributeHandler
const std::string itsName
 Attribute name. More...
 
const std::string itsHelp
 Help text. More...
 
Pointer< AttributeBaseitsDefault
 Default value. More...
 
bool is_deferred
 Defer flag. More...
 
bool is_readonly
 Read-only flag. More...
 

Detailed Description

Parser for an attribute of type string.

Definition at line 31 of file String.h.

Constructor & Destructor Documentation

◆ String() [1/3]

Attributes::String::String ( const std::string &  name,
const std::string &  help 
)

Constructor.

Definition at line 33 of file String.cpp.

◆ ~String()

Attributes::String::~String ( )
virtual

Definition at line 38 of file String.cpp.

◆ String() [2/3]

Attributes::String::String ( )
private

◆ String() [3/3]

Attributes::String::String ( const String )
private

Member Function Documentation

◆ getType()

const std::string & Attributes::String::getType ( ) const
virtual

Return attribute type string `‘string’'.

Implements AttributeHandler.

Definition at line 42 of file String.cpp.

◆ operator=()

void Attributes::String::operator= ( const String )
private

◆ parse()

void Attributes::String::parse ( Attribute attr,
Statement stat,
bool   
) const
virtual

Parse the attribute.

Implements AttributeHandler.

Definition at line 48 of file String.cpp.

References Expressions::parseStringValue(), and Attribute::set().

Here is the call graph for this function:

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