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

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

#include <Real.h>

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

Public Types

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

Public Member Functions

 Real (const std::string &name, const std::string &help)
 Constructor.
virtual ~Real ()
virtual const std::string & getType () const
 Return attribute type string ``real''.
virtual void parse (Attribute &, Statement &, bool) const
 Parse the attribute.
virtual AttributeHandlerclone () const
 Make clone.
virtual AttributeBasegetDefault () const
 Return default value.
virtual const std::string & getHelp () const
 Return help string.
virtual const std::string & getName () const
 Return attribute name.
virtual void parseComponent (Attribute &a, Statement &s, bool eval, int i) const
 Parse component value.
bool isDeferred () const
 Return defer flag.
void setDeferred (bool)
 Set or reset defer flag.
bool isReadOnly () const
 Return read-only flag.
void setReadOnly (bool)
 Set or reset read-only flag.
void setPredefinedValues (const std::set< std::string > &, const std::string &)
 Add predefined strings values to the help.
int addReference () const
 Increment reference count.
int removeReference () const
 Decrement the reference count.
bool isShared () const
 Test for sharing.

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.
const std::string itsHelp
 Help text.
std::shared_ptr< AttributeBaseitsDefault
 Default value.
bool is_deferred
 Defer flag.
bool is_readonly
 Read-only flag.

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.

References AttributeHandler::AttributeHandler().

Referenced by operator=(), and Real().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ ~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

References Real().

Here is the call graph for this function:

Member Function Documentation

◆ addAttributeOwner()

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

Definition at line 124 of file AttributeHandler.cpp.

References attributeOwnerDictionary_s.

Referenced by OpalElement::OpalElement(), Object::registerOwnership(), OpalElement::registerOwnership(), and TrackCmd::TrackCmd().

Here is the caller graph for this function:

◆ addReference()

int RCObject::addReference ( ) const
inlineinherited

Increment reference count.

Definition at line 83 of file RCObject.h.

References refCount.

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

Here is the caller graph for this function:

◆ clone()

AttributeHandler * AttributeHandler::clone ( ) const
virtualinherited

Make clone.

Definition at line 43 of file AttributeHandler.cpp.

References AttributeHandler().

Here is the call graph for this function:

◆ getDefault()

AttributeBase * AttributeHandler::getDefault ( ) const
virtualinherited

Return default value.

Definition at line 49 of file AttributeHandler.cpp.

References itsDefault, and itsName.

◆ getHelp()

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

Return help string.

Definition at line 59 of file AttributeHandler.cpp.

References itsHelp.

◆ getName()

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

Return attribute name.

Definition at line 64 of file AttributeHandler.cpp.

References itsName.

◆ getOwner()

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

Definition at line 108 of file AttributeHandler.cpp.

References attributeOwnerDictionary_s.

Referenced by OpalParser::getHint().

Here is the caller graph for this function:

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

Referenced by Attributes::Real::parse().

Here is the caller graph for this function:

◆ isReadOnly()

bool AttributeHandler::isReadOnly ( ) const
inherited

Return read-only flag.

Definition at line 88 of file AttributeHandler.cpp.

References is_readonly.

◆ isShared()

bool RCObject::isShared ( ) const
inlineinherited

Test for sharing.

Definition at line 93 of file RCObject.h.

References refCount.

◆ operator=()

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

References Real().

Here is the call graph for this function:

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

◆ setDeferred()

void AttributeHandler::setDeferred ( bool flag)
inherited

Set or reset defer flag.

Definition at line 83 of file AttributeHandler.cpp.

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

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

Here is the caller graph for this function:

◆ setReadOnly()

void AttributeHandler::setReadOnly ( bool flag)
inherited

Set or reset read-only flag.

Definition at line 93 of file AttributeHandler.cpp.

References is_readonly.

Member Data Documentation

◆ attributeOwnerDictionary_s

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

Definition at line 153 of file AttributeHandler.h.

Referenced by addAttributeOwner(), and getOwner().

◆ 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 setReadOnly().

◆ itsDefault

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

Default value.

Definition at line 138 of file AttributeHandler.h.

Referenced by AttributeHandler(), and getDefault().

◆ itsHelp

const std::string AttributeHandler::itsHelp
protectedinherited

Help text.

Definition at line 135 of file AttributeHandler.h.

Referenced by AttributeHandler(), getHelp(), and setPredefinedValues().

◆ itsName

const std::string AttributeHandler::itsName
protectedinherited

Attribute name.

Definition at line 132 of file AttributeHandler.h.

Referenced by AttributeHandler(), getDefault(), getName(), and parseComponent().

◆ refCount

int RCObject::refCount
mutableprivateinherited

Definition at line 76 of file RCObject.h.

Referenced by addReference(), isShared(), RCObject(), RCObject(), and removeReference().


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