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

#include <CFGProperty.h>

Public Types

enum  propertyOption {
  nothingSet = 0, paramIdSet = 1, propertyIndexSet = 2, propertyTypeSet = 4,
  propertyValueSet = 8, allSetButValue = 7, allSet = 15
}
 

Public Member Functions

 CFGProperty ()
 
 ~CFGProperty ()
 
const cfgParamId & getParamId () const
 
bool setParamId (const cfgParamId &_id)
 
bool changeParamId (const cfgParamId &_id)
 
unsigned int getPropertyIndex () const
 
bool setPropertyIndex (const unsigned int _propertyIndex)
 
const cfgPropertyType & getPropertyType () const
 
bool setPropertyType (const cfgPropertyType &_propertyType)
 
unsigned int getState () const
 
cfgPropertyStruct getAsStruct () const
 
bool isSameAs (const CFGProperty &property) const
 
bool isValueSet () const
 
bool setValue (const int _iValue)
 
bool setValue (const bool _bValue)
 
bool setValue (const double _dValue)
 
bool setValue (const std::string &_sValue)
 
bool getValue (int *value) const
 
bool getValue (bool *value) const
 
bool getValue (double *value) const
 
bool getValue (std::string *value) const
 

Private Attributes

cfgParamId paramId
 
unsigned int propertyIndex
 
cfgPropertyType propertyType
 
int iValue
 
bool bValue
 
double dValue
 
std::string sValue
 
unsigned int propertyState
 

Detailed Description

Definition at line 43 of file CFGProperty.h.

Member Enumeration Documentation

◆ propertyOption

enum mars::cfg_manager::CFGProperty::propertyOption
Enumerator
nothingSet 
paramIdSet 
propertyIndexSet 
propertyTypeSet 
propertyValueSet 
allSetButValue 
allSet 

Definition at line 46 of file CFGProperty.h.

Constructor & Destructor Documentation

◆ CFGProperty()

mars::cfg_manager::CFGProperty::CFGProperty ( )

Definition at line 38 of file CFGProperty.cpp.

◆ ~CFGProperty()

mars::cfg_manager::CFGProperty::~CFGProperty ( )

Definition at line 52 of file CFGProperty.cpp.

Member Function Documentation

◆ changeParamId()

bool mars::cfg_manager::CFGProperty::changeParamId ( const cfgParamId &  _id)

Definition at line 92 of file CFGProperty.cpp.

◆ getAsStruct()

cfgPropertyStruct mars::cfg_manager::CFGProperty::getAsStruct ( ) const

Definition at line 75 of file CFGProperty.cpp.

◆ getParamId()

const cfgParamId & mars::cfg_manager::CFGProperty::getParamId ( ) const

Definition at line 59 of file CFGProperty.cpp.

◆ getPropertyIndex()

unsigned int mars::cfg_manager::CFGProperty::getPropertyIndex ( ) const

Definition at line 102 of file CFGProperty.cpp.

◆ getPropertyType()

const cfgPropertyType & mars::cfg_manager::CFGProperty::getPropertyType ( ) const

Definition at line 118 of file CFGProperty.cpp.

◆ getState()

unsigned int mars::cfg_manager::CFGProperty::getState ( ) const

Definition at line 134 of file CFGProperty.cpp.

◆ getValue() [1/4]

bool mars::cfg_manager::CFGProperty::getValue ( int *  value) const

Definition at line 203 of file CFGProperty.cpp.

◆ getValue() [2/4]

bool mars::cfg_manager::CFGProperty::getValue ( bool *  value) const

Definition at line 215 of file CFGProperty.cpp.

◆ getValue() [3/4]

bool mars::cfg_manager::CFGProperty::getValue ( double *  value) const

Definition at line 227 of file CFGProperty.cpp.

◆ getValue() [4/4]

bool mars::cfg_manager::CFGProperty::getValue ( std::string *  value) const

◆ isSameAs()

bool mars::cfg_manager::CFGProperty::isSameAs ( const CFGProperty &  property) const

Definition at line 139 of file CFGProperty.cpp.

◆ isValueSet()

bool mars::cfg_manager::CFGProperty::isValueSet ( ) const

Definition at line 150 of file CFGProperty.cpp.

◆ setParamId()

bool mars::cfg_manager::CFGProperty::setParamId ( const cfgParamId &  _id)

Definition at line 64 of file CFGProperty.cpp.

◆ setPropertyIndex()

bool mars::cfg_manager::CFGProperty::setPropertyIndex ( const unsigned int  _propertyIndex)

Definition at line 107 of file CFGProperty.cpp.

◆ setPropertyType()

bool mars::cfg_manager::CFGProperty::setPropertyType ( const cfgPropertyType &  _propertyType)

Definition at line 123 of file CFGProperty.cpp.

◆ setValue() [1/4]

bool mars::cfg_manager::CFGProperty::setValue ( const int  _iValue)

Definition at line 159 of file CFGProperty.cpp.

◆ setValue() [2/4]

bool mars::cfg_manager::CFGProperty::setValue ( const bool  _bValue)

Definition at line 170 of file CFGProperty.cpp.

◆ setValue() [3/4]

bool mars::cfg_manager::CFGProperty::setValue ( const double  _dValue)

Definition at line 181 of file CFGProperty.cpp.

◆ setValue() [4/4]

bool mars::cfg_manager::CFGProperty::setValue ( const std::string &  _sValue)

Member Data Documentation

◆ bValue

bool mars::cfg_manager::CFGProperty::bValue
private

Definition at line 94 of file CFGProperty.h.

◆ dValue

double mars::cfg_manager::CFGProperty::dValue
private

Definition at line 95 of file CFGProperty.h.

◆ iValue

int mars::cfg_manager::CFGProperty::iValue
private

Definition at line 93 of file CFGProperty.h.

◆ paramId

cfgParamId mars::cfg_manager::CFGProperty::paramId
private

Definition at line 89 of file CFGProperty.h.

◆ propertyIndex

unsigned int mars::cfg_manager::CFGProperty::propertyIndex
private

Definition at line 90 of file CFGProperty.h.

◆ propertyState

unsigned int mars::cfg_manager::CFGProperty::propertyState
private

Definition at line 98 of file CFGProperty.h.

◆ propertyType

cfgPropertyType mars::cfg_manager::CFGProperty::propertyType
private

Definition at line 91 of file CFGProperty.h.

◆ sValue

std::string mars::cfg_manager::CFGProperty::sValue
private

Definition at line 96 of file CFGProperty.h.

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