OPALX (Object Oriented Parallel Accelerator Library for Exascale) MINIorX
OPALX
Attributes::Real Class Reference

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

#include <Real.h>

Inheritance diagram for Attributes::Real:
Inheritance graph
Collaboration diagram for Attributes::Real:
Collaboration graph

Public Types

enum  OwnerType {
  ELEMENT , COMMAND , SUB_COMMAND , STATEMENT ,
  NONE
}
 

Public Member Functions

 Real (const std::string &name, const std::string &help)
 Constructor. More...
 
virtual ~Real ()
 
virtual const std::string & getType () const
 Return attribute type string `‘real’'. More...
 
virtual void parse (Attribute &, Statement &, bool) const
 Parse the attribute. More...
 
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 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...
 
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 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 Attributes

const std::string itsName
 Attribute name. More...
 
const std::string itsHelp
 Help text. More...
 
std::shared_ptr< AttributeBaseitsDefault
 Default value. More...
 
bool is_deferred
 Defer flag. More...
 
bool is_readonly
 Read-only flag. More...
 

Private Member Functions

 Real ()
 
 Real (const Real &)
 
void operator= (const Real &)
 

Private Attributes

int refCount
 

Static Private Attributes

static std::multimap< std::string, std::pair< OwnerType, std::string > > attributeOwnerDictionary_s
 

Detailed Description

Parser for an attribute of type real.

Definition at line 31 of file Real.h.

Member Enumeration Documentation

◆ OwnerType

Enumerator
ELEMENT 
COMMAND 
SUB_COMMAND 
STATEMENT 
NONE 

Definition at line 120 of file AttributeHandler.h.

Constructor & Destructor Documentation

◆ Real() [1/3]

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

Constructor.

Definition at line 40 of file Real.cpp.

◆ ~Real()

Attributes::Real::~Real ( )
virtual

Definition at line 45 of file Real.cpp.

◆ Real() [2/3]

Attributes::Real::Real ( )
private

◆ Real() [3/3]

Attributes::Real::Real ( const Real )
private

Member Function Documentation

◆ addAttributeOwner()

void AttributeHandler::addAttributeOwner ( const std::string &  owner,
const OwnerType type,
const std::string &  name 
)
staticinherited

◆ addReference()

int RCObject::addReference ( ) const
inlineinherited

Increment reference count.

Definition at line 83 of file RCObject.h.

References RCObject::refCount.

Referenced by Pointer< Object >::operator=(), and Pointer< Object >::unique().

◆ clone()

AttributeHandler * AttributeHandler::clone ( ) const
virtualinherited

Make clone.

Definition at line 43 of file AttributeHandler.cpp.

◆ getDefault()

AttributeBase * AttributeHandler::getDefault ( ) const
virtualinherited

Return default value.

Definition at line 49 of file AttributeHandler.cpp.

References AttributeHandler::itsDefault, and AttributeHandler::itsName.

◆ getHelp()

const std::string & AttributeHandler::getHelp ( ) const
virtualinherited

Return help string.

Definition at line 59 of file AttributeHandler.cpp.

References AttributeHandler::itsHelp.

◆ getName()

const std::string & AttributeHandler::getName ( ) const
virtualinherited

Return attribute name.

Definition at line 64 of file AttributeHandler.cpp.

References AttributeHandler::itsName.

◆ getOwner()

std::multimap< AttributeHandler::OwnerType, std::string > AttributeHandler::getOwner ( const std::string &  att)
staticinherited

Definition at line 108 of file AttributeHandler.cpp.

References AttributeHandler::attributeOwnerDictionary_s.

Referenced by OpalParser::getHint().

◆ getType()

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

Return attribute type string `‘real’'.

Implements AttributeHandler.

Definition at line 49 of file Real.cpp.

◆ isDeferred()

bool AttributeHandler::isDeferred ( ) const
inherited

Return defer flag.

Definition at line 78 of file AttributeHandler.cpp.

References AttributeHandler::is_deferred.

Referenced by parse().

◆ isReadOnly()

bool AttributeHandler::isReadOnly ( ) const
inherited

Return read-only flag.

Definition at line 88 of file AttributeHandler.cpp.

References AttributeHandler::is_readonly.

◆ isShared()

bool RCObject::isShared ( ) const
inlineinherited

Test for sharing.

Definition at line 93 of file RCObject.h.

References RCObject::refCount.

◆ operator=()

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

◆ parse()

void Attributes::Real::parse ( Attribute attr,
Statement statement,
bool  eval 
) const
virtual

Parse the attribute.

Implements AttributeHandler.

Definition at line 55 of file Real.cpp.

References Expressions::Scalar< T >::evaluate(), Expressions::Scalar< T >::isConstant(), AttributeHandler::isDeferred(), Expressions::parseReal(), and Attribute::set().

Here is the call graph for this function:

◆ parseComponent()

void AttributeHandler::parseComponent ( Attribute a,
Statement s,
bool  eval,
int  i 
) const
virtualinherited

◆ removeReference()

int RCObject::removeReference ( ) const
inlineinherited

Decrement the reference count.

Definition at line 88 of file RCObject.h.

References RCObject::refCount.

◆ setDeferred()

void AttributeHandler::setDeferred ( bool  flag)
inherited

Set or reset defer flag.

Definition at line 83 of file AttributeHandler.cpp.

References AttributeHandler::is_deferred.

◆ setPredefinedValues()

void AttributeHandler::setPredefinedValues ( const std::set< std::string > &  predefinedValues,
const std::string &  defaultValue 
)
inherited

Add predefined strings values to the help.

Definition at line 97 of file AttributeHandler.cpp.

References AttributeHandler::itsHelp.

Referenced by Attributes::PredefinedString::PredefinedString().

◆ setReadOnly()

void AttributeHandler::setReadOnly ( bool  flag)
inherited

Set or reset read-only flag.

Definition at line 93 of file AttributeHandler.cpp.

References AttributeHandler::is_readonly.

Member Data Documentation

◆ attributeOwnerDictionary_s

std::multimap< std::string, std::pair< AttributeHandler::OwnerType, std::string > > AttributeHandler::attributeOwnerDictionary_s
staticprivateinherited

◆ is_deferred

bool AttributeHandler::is_deferred
protectedinherited

◆ is_readonly

bool AttributeHandler::is_readonly
protectedinherited

Read-only flag.

Definition at line 144 of file AttributeHandler.h.

Referenced by AttributeHandler::isReadOnly(), and AttributeHandler::setReadOnly().

◆ itsDefault

std::shared_ptr<AttributeBase> AttributeHandler::itsDefault
protectedinherited

Default value.

Definition at line 138 of file AttributeHandler.h.

Referenced by AttributeHandler::getDefault().

◆ itsHelp

const std::string AttributeHandler::itsHelp
protectedinherited

◆ itsName

const std::string AttributeHandler::itsName
protectedinherited

◆ refCount

int RCObject::refCount
mutableprivateinherited

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