Mana
Loading...
Searching...
No Matches
Public Member Functions | Protected Member Functions | Protected Attributes | Friends | List of all members
ConfigurationObject Class Reference

Configuration object, mapping values to names and possibly containing lists of further configuration objects. More...

#include <configuration.h>

Inheritance diagram for ConfigurationObject:
Configuration

Public Member Functions

virtual ~ConfigurationObject ()
 
void setValue (const std::string &key, const std::string &value)
 Sets an option using a string value.
 
std::string getValue (const std::string &key, const std::string &deflt) const
 Gets a value as string.
 
int getValue (const std::string &key, int deflt) const
 
unsigned getValue (const std::string &key, unsigned deflt) const
 
double getValue (const std::string &key, double deflt) const
 
void clear ()
 Re-sets all data in the configuration.
 

Protected Member Functions

void initFromXML (XML::Node node)
 

Protected Attributes

std::map< std::string, std::string > mOptions
 

Friends

class Configuration
 

Detailed Description

Configuration object, mapping values to names and possibly containing lists of further configuration objects.

Definition at line 45 of file configuration.h.

Constructor & Destructor Documentation

◆ ~ConfigurationObject()

ConfigurationObject::~ConfigurationObject ( )
virtual

Definition at line 68 of file configuration.cpp.

Member Function Documentation

◆ clear()

void ConfigurationObject::clear ( )

Re-sets all data in the configuration.

Definition at line 63 of file configuration.cpp.

◆ getValue() [1/4]

std::string ConfigurationObject::getValue ( const std::string &  key,
const std::string &  deflt 
) const

Gets a value as string.

Parameters
keyOption identifier.
defltDefault option if not there or error.

Definition at line 36 of file configuration.cpp.

◆ getValue() [2/4]

double ConfigurationObject::getValue ( const std::string &  key,
double  deflt 
) const

Definition at line 56 of file configuration.cpp.

◆ getValue() [3/4]

int ConfigurationObject::getValue ( const std::string &  key,
int  deflt 
) const

Definition at line 43 of file configuration.cpp.

◆ getValue() [4/4]

unsigned ConfigurationObject::getValue ( const std::string &  key,
unsigned  deflt 
) const

Definition at line 49 of file configuration.cpp.

◆ initFromXML()

void ConfigurationObject::initFromXML ( XML::Node  node)
protected

Definition at line 188 of file configuration.cpp.

◆ setValue()

void ConfigurationObject::setValue ( const std::string &  key,
const std::string &  value 
)

Sets an option using a string value.

Parameters
keyOption identifier.
valueValue.

Definition at line 30 of file configuration.cpp.

Friends And Related Symbol Documentation

◆ Configuration

friend class Configuration
friend

Definition at line 47 of file configuration.h.

Member Data Documentation

◆ mOptions

std::map<std::string, std::string> ConfigurationObject::mOptions
protected

Definition at line 83 of file configuration.h.


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