Privacy
An open-source, flexible 3D physical simulation framework
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Private Member Functions | List of all members
mars::cfg_manager::CFGParamString Class Reference

#include <CFGParamString.h>

Public Types

enum  paramProperty { value = 0, dstNrOfParamPropertys }
 

Public Member Functions

 CFGParamString (const cfgParamId &_id, const std::string &_group, const std::string &_name)
 
 ~CFGParamString ()
 
virtual bool setProperty (const CFGProperty &_property)
 
virtual const std::string & getPropertyNameByIndex (unsigned int _index) const
 
virtual const cfgPropertyType & getPropertyTypeByIndex (unsigned int _index) const
 
virtual unsigned int getPropertyIndexByName (const std::string &_name) const
 
virtual unsigned int getNrOfPropertys () const
 
- Public Member Functions inherited from mars::cfg_manager::CFGParam
 CFGParam (const cfgParamId &_id, const std::string &_group, const std::string &_name, const cfgParamType &_type)
 
 ~CFGParam ()
 
const cfgParamType & getParamType () const
 
const cfgParamId & getId () const
 
const std::string & getGroup () const
 
const std::string & getName () const
 
virtual bool getProperty (CFGProperty *property) const
 
virtual unsigned char getOption () const
 
virtual void setOption (const unsigned char _newOption)
 
virtual void unsetOption (const unsigned char _newOption)
 
void addClient (CFGClient *client)
 
void removeClient (CFGClient *client)
 
void writeToYAML (YAML::Emitter &out) const
 

Static Public Member Functions

static CFGParam * createParam (const cfgParamId &_id, const std::string &_group, const YAML::Node &node)
 

Static Public Attributes

static const std::string paramPropertyName [dstNrOfParamPropertys]
 
static const cfgPropertyType paramPropertyType [dstNrOfParamPropertys]
 

Private Member Functions

bool setPropertyValue (const CFGProperty &_property) const
 

Additional Inherited Members

- Protected Member Functions inherited from mars::cfg_manager::CFGParam
void updateClients (const CFGProperty &property)
 
void readFromYAML (const YAML::Node &node)
 
void readPropertyFromYAML (unsigned int index, const YAML::Node &node) const
 
void readSaveSettingFromYAML (const YAML::Node &node)
 
bool writeProperty (const CFGProperty &property) const
 
- Protected Attributes inherited from mars::cfg_manager::CFGParam
std::vector< CFGProperty * > propertys
 
utils::Mutex mutexPropertys
 
unsigned char options
 
const std::string emptyString
 
const cfgPropertyType noType
 

Detailed Description

Definition at line 41 of file CFGParamString.h.

Member Enumeration Documentation

◆ paramProperty

enum mars::cfg_manager::CFGParamString::paramProperty
Enumerator
value 
dstNrOfParamPropertys 

Definition at line 44 of file CFGParamString.h.

Constructor & Destructor Documentation

◆ CFGParamString()

mars::cfg_manager::CFGParamString::CFGParamString ( const cfgParamId &  _id,
const std::string &  _group,
const std::string &  _name 
)

Definition at line 48 of file CFGParamString.cpp.

◆ ~CFGParamString()

mars::cfg_manager::CFGParamString::~CFGParamString ( )

Definition at line 66 of file CFGParamString.cpp.

Member Function Documentation

◆ createParam()

CFGParam * mars::cfg_manager::CFGParamString::createParam ( const cfgParamId &  _id,
const std::string &  _group,
const YAML::Node &  node 
)
static

Definition at line 100 of file CFGParamString.cpp.

◆ getNrOfPropertys()

unsigned int mars::cfg_manager::CFGParamString::getNrOfPropertys ( ) const
virtual

Implements mars::cfg_manager::CFGParam.

Definition at line 154 of file CFGParamString.cpp.

◆ getPropertyIndexByName()

unsigned int mars::cfg_manager::CFGParamString::getPropertyIndexByName ( const std::string &  _name) const
virtual

Implements mars::cfg_manager::CFGParam.

Definition at line 143 of file CFGParamString.cpp.

◆ getPropertyNameByIndex()

const string & mars::cfg_manager::CFGParamString::getPropertyNameByIndex ( unsigned int  _index) const
virtual

Implements mars::cfg_manager::CFGParam.

Definition at line 125 of file CFGParamString.cpp.

◆ getPropertyTypeByIndex()

const cfgPropertyType & mars::cfg_manager::CFGParamString::getPropertyTypeByIndex ( unsigned int  _index) const
virtual

Implements mars::cfg_manager::CFGParam.

Definition at line 134 of file CFGParamString.cpp.

◆ setProperty()

bool mars::cfg_manager::CFGParamString::setProperty ( const CFGProperty &  _property)
virtual

Implements mars::cfg_manager::CFGParam.

Definition at line 81 of file CFGParamString.cpp.

◆ setPropertyValue()

bool mars::cfg_manager::CFGParamString::setPropertyValue ( const CFGProperty &  _property) const
private

Definition at line 161 of file CFGParamString.cpp.

Member Data Documentation

◆ paramPropertyName

const string mars::cfg_manager::CFGParamString::paramPropertyName
static
Initial value:
= {
"value"
}

Definition at line 49 of file CFGParamString.h.

◆ paramPropertyType

const cfgPropertyType mars::cfg_manager::CFGParamString::paramPropertyType
static
Initial value:
= {
stringProperty
}

Definition at line 50 of file CFGParamString.h.

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