OPAL (Object Oriented Parallel Accelerator Library) 2024.2
OPAL
Attributes::BoolArray Class Reference

Parser for an attribute of type logical array. More...

#include <BoolArray.h>

Inheritance diagram for Attributes::BoolArray:
Collaboration diagram for Attributes::BoolArray:

Public Types

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

Public Member Functions

 BoolArray (const std::string &name, const std::string &help)
 Constructor.
virtual ~BoolArray ()
virtual const std::string & getType () const
 Return attribute type string ``logical array''.
virtual void parse (Attribute &, Statement &, bool) const
 Parse the attribute.
virtual void parseComponent (Attribute &, Statement &, bool, int) const
 Parse a component of the array.
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.
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.
Pointer< AttributeBaseitsDefault
 Default value.
bool is_deferred
 Defer flag.
bool is_readonly
 Read-only flag.

Private Member Functions

 BoolArray ()
 BoolArray (const BoolArray &)
void operator= (const BoolArray &)

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

Definition at line 32 of file BoolArray.h.

Member Enumeration Documentation

◆ OwnerType

Enumerator
ELEMENT 
COMMAND 
SUB_COMMAND 
STATEMENT 
NONE 

Definition at line 118 of file AttributeHandler.h.

Constructor & Destructor Documentation

◆ BoolArray() [1/3]

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

Constructor.

Definition at line 37 of file BoolArray.cpp.

References AttributeHandler::AttributeHandler(), and name.

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

Here is the call graph for this function:

◆ ~BoolArray()

Attributes::BoolArray::~BoolArray ( )
virtual

Definition at line 42 of file BoolArray.cpp.

◆ BoolArray() [2/3]

Attributes::BoolArray::BoolArray ( )
private

◆ BoolArray() [3/3]

Attributes::BoolArray::BoolArray ( const BoolArray & )
private

References BoolArray().

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

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

◆ clone()

AttributeHandler * AttributeHandler::clone ( ) const
virtualinherited

Make clone.

Definition at line 44 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 50 of file AttributeHandler.cpp.

References itsDefault, and itsName.

◆ getHelp()

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

Return help string.

Definition at line 60 of file AttributeHandler.cpp.

References itsHelp.

◆ getName()

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

Return attribute name.

Definition at line 65 of file AttributeHandler.cpp.

References itsName.

◆ getOwner()

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

Definition at line 109 of file AttributeHandler.cpp.

References attributeOwnerDictionary_s.

Referenced by OpalParser::getHint().

◆ getType()

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

Return attribute type string ``logical array''.

Implements AttributeHandler.

Definition at line 46 of file BoolArray.cpp.

◆ isDeferred()

bool AttributeHandler::isDeferred ( ) const
inherited

Return defer flag.

Definition at line 79 of file AttributeHandler.cpp.

References is_deferred.

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

◆ isReadOnly()

bool AttributeHandler::isReadOnly ( ) const
inherited

Return read-only flag.

Definition at line 89 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::BoolArray::operator= ( const BoolArray & )
private

References BoolArray().

Here is the call graph for this function:

◆ parse()

void Attributes::BoolArray::parse ( Attribute & attr,
Statement & stat,
bool eval ) const
virtual

Parse the attribute.

Implements AttributeHandler.

Definition at line 52 of file BoolArray.cpp.

References AttributeHandler::is_deferred, Expressions::parseBoolArray(), and Attribute::set().

Here is the call graph for this function:

◆ parseComponent()

void Attributes::BoolArray::parseComponent ( Attribute & attr,
Statement & stat,
bool eval,
int index ) const
virtual

Parse a component of the array.

Reimplemented from AttributeHandler.

Definition at line 67 of file BoolArray.cpp.

References Attribute::getBase(), Expressions::parseBool(), Attribute::set(), and Expressions::ADeferred< T >::setComponent().

Here is the call graph for this function:

◆ 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 84 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 98 of file AttributeHandler.cpp.

References itsHelp.

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

◆ setReadOnly()

void AttributeHandler::setReadOnly ( bool flag)
inherited

Set or reset read-only flag.

Definition at line 94 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 151 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 142 of file AttributeHandler.h.

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

◆ itsDefault

Pointer<AttributeBase> AttributeHandler::itsDefault
protectedinherited

Default value.

Definition at line 136 of file AttributeHandler.h.

Referenced by AttributeHandler(), and getDefault().

◆ itsHelp

const std::string AttributeHandler::itsHelp
protectedinherited

Help text.

Definition at line 133 of file AttributeHandler.h.

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

◆ itsName

const std::string AttributeHandler::itsName
protectedinherited

Attribute name.

Definition at line 130 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: