Privacy
An open-source, flexible 3D physical simulation framework
Public Member Functions | List of all members
mars::cfg_manager::CFGManagerInterface Class Referenceabstract

#include <CFGManagerInterface.h>

Public Member Functions

 CFGManagerInterface (lib_manager::LibManager *theManager)
 
 ~CFGManagerInterface ()
 
virtual int getLibVersion () const =0
 
virtual const std::string getLibName () const =0
 
virtual void createModuleInfo ()
 
virtual cfgParamId createParam (const std::string &_group, const std::string &_name, const cfgParamType &_paramType)=0
 
virtual bool loadConfig (const char *filename)=0
 
virtual bool loadConfig (const char *filename, const char *group)=0
 
virtual bool loadConfigFromString (const std::string &configString)=0
 
virtual void writeConfig (const char *filename, const char *group, const unsigned char saveOption=saveOnClose) const =0
 
virtual const std::string writeConfigToString (const char *group=0, const unsigned char saveOption=saveOnClose) const =0
 
virtual bool removeParam (const cfgParamId &_id)=0
 
virtual bool removeParam (const std::string &_group, const std::string &_name)=0
 
virtual bool setProperty (const cfgPropertyStruct &_propertyS)=0
 
virtual bool getProperty (cfgPropertyStruct *_propertyS) const =0
 
template<typename T >
bool getPropertyValue (const std::string &_group, const std::string &_name, const std::string &_propertyName, T *rValue) const
 
virtual bool getPropertyValue (cfgParamId paramId, const std::string &_propertyName, double *rValue) const =0
 
virtual bool getPropertyValue (cfgParamId paramId, const std::string &_propertyName, int *rValue) const =0
 
virtual bool getPropertyValue (cfgParamId paramId, const std::string &_propertyName, bool *rValue) const =0
 
virtual bool getPropertyValue (cfgParamId paramId, const std::string &_propertyName, std::string *rValue) const =0
 
virtual bool setPropertyValue (const std::string &_group, const std::string &_name, const std::string &_propertyName, const double rValue)=0
 
virtual bool setPropertyValue (const std::string &_group, const std::string &_name, const std::string &_propertyName, const int rValue)=0
 
virtual bool setPropertyValue (const std::string &_group, const std::string &_name, const std::string &_propertyName, const bool rValue)=0
 
virtual bool setPropertyValue (const std::string &_group, const std::string &_name, const std::string &_propertyName, const std::string &rValue)=0
 
virtual bool setPropertyValue (const std::string &_group, const std::string &_name, const std::string &_propertyName, const char *rValue)=0
 
virtual cfgParamId getParamId (const std::string &_group, const std::string &_name) const =0
 
virtual const cfgParamInfo getParamInfo (const cfgParamId &_id) const =0
 
virtual const cfgParamInfo getParamInfo (const std::string &_group, const std::string &_name) const =0
 
virtual cfgParamId registerToParam (const std::string &_group, const std::string &_name, CFGClient *client)=0
 
virtual bool registerToParam (const cfgParamId &_id, CFGClient *client)=0
 
virtual bool unregisterFromParam (const std::string &_group, const std::string &_name, CFGClient *client)=0
 
virtual bool unregisterFromParam (const cfgParamId &_id, CFGClient *client)=0
 
virtual bool registerToCFG (CFGClient *client)=0
 
virtual bool unregisterFromCFG (CFGClient *client)=0
 
virtual bool getAllParams (std::vector< cfgParamInfo > *allParams) const =0
 
virtual const cfgPropertyStruct getOrCreateProperty (const std::string &_group, const std::string &_name, bool val, CFGClient *newClient=0)=0
 
virtual const cfgPropertyStruct getOrCreateProperty (const std::string &_group, const std::string &_name, double val, CFGClient *newClient=0)=0
 
virtual const cfgPropertyStruct getOrCreateProperty (const std::string &_group, const std::string &_name, int val, CFGClient *newClient=0)=0
 
virtual const cfgPropertyStruct getOrCreateProperty (const std::string &_group, const std::string &_name, const std::string &val, CFGClient *newClient=0)=0
 
virtual const cfgPropertyStruct getOrCreateProperty (const std::string &_group, const std::string &_name, const char *val, CFGClient *newClient=0)=0
 
virtual void setProperty (const std::string &_group, const std::string &_name, bool val)=0
 
virtual void setProperty (const std::string &_group, const std::string &_name, double val)=0
 
virtual void setProperty (const std::string &_group, const std::string &_name, int val)=0
 
virtual void setProperty (const std::string &_group, const std::string &_name, const std::string &val)=0
 
virtual void setProperty (const std::string &_group, const std::string &_name, const char *val)=0
 
- Public Member Functions inherited from lib_manager::LibInterface
 LibInterface (LibManager *theManager)
 
virtual ~LibInterface (void)
 
ModuleInfo getModuleInfo () const
 
virtual void newLibLoaded (const std::string &libName)
 

Additional Inherited Members

- Protected Attributes inherited from lib_manager::LibInterface
LibManager * libManager
 
ModuleInfo moduleInfo
 

Detailed Description

Definition at line 47 of file CFGManagerInterface.h.

Constructor & Destructor Documentation

◆ CFGManagerInterface()

mars::cfg_manager::CFGManagerInterface::CFGManagerInterface ( lib_manager::LibManager *  theManager)
inline

Definition at line 50 of file CFGManagerInterface.h.

◆ ~CFGManagerInterface()

mars::cfg_manager::CFGManagerInterface::~CFGManagerInterface ( )
inline

Definition at line 52 of file CFGManagerInterface.h.

Member Function Documentation

◆ createModuleInfo()

virtual void mars::cfg_manager::CFGManagerInterface::createModuleInfo ( void  )
inlinevirtual

Reimplemented from lib_manager::LibInterface.

Definition at line 57 of file CFGManagerInterface.h.

◆ createParam()

virtual cfgParamId mars::cfg_manager::CFGManagerInterface::createParam ( const std::string &  _group,
const std::string &  _name,
const cfgParamType &  _paramType 
)
pure virtual

Implemented in mars::cfg_manager::CFGManager.

◆ getAllParams()

virtual bool mars::cfg_manager::CFGManagerInterface::getAllParams ( std::vector< cfgParamInfo > *  allParams) const
pure virtual

Implemented in mars::cfg_manager::CFGManager.

◆ getLibName()

virtual const std::string mars::cfg_manager::CFGManagerInterface::getLibName ( ) const
pure virtual

Implements lib_manager::LibInterface.

Implemented in mars::cfg_manager::CFGManager.

◆ getLibVersion()

virtual int mars::cfg_manager::CFGManagerInterface::getLibVersion ( ) const
pure virtual

Implements lib_manager::LibInterface.

Implemented in mars::cfg_manager::CFGManager.

◆ getOrCreateProperty() [1/5]

virtual const cfgPropertyStruct mars::cfg_manager::CFGManagerInterface::getOrCreateProperty ( const std::string &  _group,
const std::string &  _name,
bool  val,
CFGClient *  newClient = 0 
)
pure virtual

Implemented in mars::cfg_manager::CFGManager.

◆ getOrCreateProperty() [2/5]

virtual const cfgPropertyStruct mars::cfg_manager::CFGManagerInterface::getOrCreateProperty ( const std::string &  _group,
const std::string &  _name,
double  val,
CFGClient *  newClient = 0 
)
pure virtual

Implemented in mars::cfg_manager::CFGManager.

◆ getOrCreateProperty() [3/5]

virtual const cfgPropertyStruct mars::cfg_manager::CFGManagerInterface::getOrCreateProperty ( const std::string &  _group,
const std::string &  _name,
int  val,
CFGClient *  newClient = 0 
)
pure virtual

Implemented in mars::cfg_manager::CFGManager.

◆ getOrCreateProperty() [4/5]

virtual const cfgPropertyStruct mars::cfg_manager::CFGManagerInterface::getOrCreateProperty ( const std::string &  _group,
const std::string &  _name,
const std::string &  val,
CFGClient *  newClient = 0 
)
pure virtual

Implemented in mars::cfg_manager::CFGManager.

◆ getOrCreateProperty() [5/5]

virtual const cfgPropertyStruct mars::cfg_manager::CFGManagerInterface::getOrCreateProperty ( const std::string &  _group,
const std::string &  _name,
const char *  val,
CFGClient *  newClient = 0 
)
pure virtual

Implemented in mars::cfg_manager::CFGManager.

◆ getParamId()

virtual cfgParamId mars::cfg_manager::CFGManagerInterface::getParamId ( const std::string &  _group,
const std::string &  _name 
) const
pure virtual

Implemented in mars::cfg_manager::CFGManager.

◆ getParamInfo() [1/2]

virtual const cfgParamInfo mars::cfg_manager::CFGManagerInterface::getParamInfo ( const cfgParamId &  _id) const
pure virtual

Implemented in mars::cfg_manager::CFGManager.

◆ getParamInfo() [2/2]

virtual const cfgParamInfo mars::cfg_manager::CFGManagerInterface::getParamInfo ( const std::string &  _group,
const std::string &  _name 
) const
pure virtual

Implemented in mars::cfg_manager::CFGManager.

◆ getProperty()

virtual bool mars::cfg_manager::CFGManagerInterface::getProperty ( cfgPropertyStruct *  _propertyS) const
pure virtual

Implemented in mars::cfg_manager::CFGManager.

◆ getPropertyValue() [1/5]

template<typename T >
bool mars::cfg_manager::CFGManagerInterface::getPropertyValue ( const std::string &  _group,
const std::string &  _name,
const std::string &  _propertyName,
T *  rValue 
) const
inline

Definition at line 85 of file CFGManagerInterface.h.

◆ getPropertyValue() [2/5]

virtual bool mars::cfg_manager::CFGManagerInterface::getPropertyValue ( cfgParamId  paramId,
const std::string &  _propertyName,
double *  rValue 
) const
pure virtual

Implemented in mars::cfg_manager::CFGManager.

◆ getPropertyValue() [3/5]

virtual bool mars::cfg_manager::CFGManagerInterface::getPropertyValue ( cfgParamId  paramId,
const std::string &  _propertyName,
int *  rValue 
) const
pure virtual

Implemented in mars::cfg_manager::CFGManager.

◆ getPropertyValue() [4/5]

virtual bool mars::cfg_manager::CFGManagerInterface::getPropertyValue ( cfgParamId  paramId,
const std::string &  _propertyName,
bool *  rValue 
) const
pure virtual

Implemented in mars::cfg_manager::CFGManager.

◆ getPropertyValue() [5/5]

virtual bool mars::cfg_manager::CFGManagerInterface::getPropertyValue ( cfgParamId  paramId,
const std::string &  _propertyName,
std::string *  rValue 
) const
pure virtual

Implemented in mars::cfg_manager::CFGManager.

◆ loadConfig() [1/2]

virtual bool mars::cfg_manager::CFGManagerInterface::loadConfig ( const char *  filename)
pure virtual

Implemented in mars::cfg_manager::CFGManager.

◆ loadConfig() [2/2]

virtual bool mars::cfg_manager::CFGManagerInterface::loadConfig ( const char *  filename,
const char *  group 
)
pure virtual

Implemented in mars::cfg_manager::CFGManager.

◆ loadConfigFromString()

virtual bool mars::cfg_manager::CFGManagerInterface::loadConfigFromString ( const std::string &  configString)
pure virtual

Implemented in mars::cfg_manager::CFGManager.

◆ registerToCFG()

virtual bool mars::cfg_manager::CFGManagerInterface::registerToCFG ( CFGClient *  client)
pure virtual

Implemented in mars::cfg_manager::CFGManager.

◆ registerToParam() [1/2]

virtual cfgParamId mars::cfg_manager::CFGManagerInterface::registerToParam ( const std::string &  _group,
const std::string &  _name,
CFGClient *  client 
)
pure virtual

Implemented in mars::cfg_manager::CFGManager.

◆ registerToParam() [2/2]

virtual bool mars::cfg_manager::CFGManagerInterface::registerToParam ( const cfgParamId &  _id,
CFGClient *  client 
)
pure virtual

Implemented in mars::cfg_manager::CFGManager.

◆ removeParam() [1/2]

virtual bool mars::cfg_manager::CFGManagerInterface::removeParam ( const cfgParamId &  _id)
pure virtual

Implemented in mars::cfg_manager::CFGManager.

◆ removeParam() [2/2]

virtual bool mars::cfg_manager::CFGManagerInterface::removeParam ( const std::string &  _group,
const std::string &  _name 
)
pure virtual

Implemented in mars::cfg_manager::CFGManager.

◆ setProperty() [1/6]

virtual bool mars::cfg_manager::CFGManagerInterface::setProperty ( const cfgPropertyStruct &  _propertyS)
pure virtual

Implemented in mars::cfg_manager::CFGManager.

◆ setProperty() [2/6]

virtual void mars::cfg_manager::CFGManagerInterface::setProperty ( const std::string &  _group,
const std::string &  _name,
bool  val 
)
pure virtual

Implemented in mars::cfg_manager::CFGManager.

◆ setProperty() [3/6]

virtual void mars::cfg_manager::CFGManagerInterface::setProperty ( const std::string &  _group,
const std::string &  _name,
double  val 
)
pure virtual

Implemented in mars::cfg_manager::CFGManager.

◆ setProperty() [4/6]

virtual void mars::cfg_manager::CFGManagerInterface::setProperty ( const std::string &  _group,
const std::string &  _name,
int  val 
)
pure virtual

Implemented in mars::cfg_manager::CFGManager.

◆ setProperty() [5/6]

virtual void mars::cfg_manager::CFGManagerInterface::setProperty ( const std::string &  _group,
const std::string &  _name,
const std::string &  val 
)
pure virtual

Implemented in mars::cfg_manager::CFGManager.

◆ setProperty() [6/6]

virtual void mars::cfg_manager::CFGManagerInterface::setProperty ( const std::string &  _group,
const std::string &  _name,
const char *  val 
)
pure virtual

Implemented in mars::cfg_manager::CFGManager.

◆ setPropertyValue() [1/5]

virtual bool mars::cfg_manager::CFGManagerInterface::setPropertyValue ( const std::string &  _group,
const std::string &  _name,
const std::string &  _propertyName,
const double  rValue 
)
pure virtual

Implemented in mars::cfg_manager::CFGManager.

◆ setPropertyValue() [2/5]

virtual bool mars::cfg_manager::CFGManagerInterface::setPropertyValue ( const std::string &  _group,
const std::string &  _name,
const std::string &  _propertyName,
const int  rValue 
)
pure virtual

Implemented in mars::cfg_manager::CFGManager.

◆ setPropertyValue() [3/5]

virtual bool mars::cfg_manager::CFGManagerInterface::setPropertyValue ( const std::string &  _group,
const std::string &  _name,
const std::string &  _propertyName,
const bool  rValue 
)
pure virtual

Implemented in mars::cfg_manager::CFGManager.

◆ setPropertyValue() [4/5]

virtual bool mars::cfg_manager::CFGManagerInterface::setPropertyValue ( const std::string &  _group,
const std::string &  _name,
const std::string &  _propertyName,
const std::string &  rValue 
)
pure virtual

Implemented in mars::cfg_manager::CFGManager.

◆ setPropertyValue() [5/5]

virtual bool mars::cfg_manager::CFGManagerInterface::setPropertyValue ( const std::string &  _group,
const std::string &  _name,
const std::string &  _propertyName,
const char *  rValue 
)
pure virtual

Implemented in mars::cfg_manager::CFGManager.

◆ unregisterFromCFG()

virtual bool mars::cfg_manager::CFGManagerInterface::unregisterFromCFG ( CFGClient *  client)
pure virtual

Implemented in mars::cfg_manager::CFGManager.

◆ unregisterFromParam() [1/2]

virtual bool mars::cfg_manager::CFGManagerInterface::unregisterFromParam ( const std::string &  _group,
const std::string &  _name,
CFGClient *  client 
)
pure virtual

Implemented in mars::cfg_manager::CFGManager.

◆ unregisterFromParam() [2/2]

virtual bool mars::cfg_manager::CFGManagerInterface::unregisterFromParam ( const cfgParamId &  _id,
CFGClient *  client 
)
pure virtual

Implemented in mars::cfg_manager::CFGManager.

◆ writeConfig()

virtual void mars::cfg_manager::CFGManagerInterface::writeConfig ( const char *  filename,
const char *  group,
const unsigned char  saveOption = saveOnClose 
) const
pure virtual

Implemented in mars::cfg_manager::CFGManager.

◆ writeConfigToString()

virtual const std::string mars::cfg_manager::CFGManagerInterface::writeConfigToString ( const char *  group = 0,
const unsigned char  saveOption = saveOnClose 
) const
pure virtual

Implemented in mars::cfg_manager::CFGManager.

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