Public Member Functions | Protected Attributes
CConfigSection Class Reference

#include <Configuration.h>

List of all members.

Public Member Functions

 CConfigSection (IConfigSection *configSectionInterface)
CConfigProperty firstProperty () const
CConfigSection firstSection () const
CConfigProperty get (const std::string &property) const
bool get (const std::string &property, std::string *value) const
bool get (const std::string &property, bool *value) const
bool get (const std::string &property, char *value) const
bool get (const std::string &property, unsigned char *value) const
bool get (const std::string &property, short *value) const
bool get (const std::string &property, unsigned short *value) const
bool get (const std::string &property, int *value) const
bool get (const std::string &property, unsigned int *value) const
bool get (const std::string &property, long *value) const
bool get (const std::string &property, unsigned long *value) const
bool get (const std::string &property, long long *value) const
bool get (const std::string &property, unsigned long long *value) const
bool get (const std::string &property, float *value) const
bool get (const std::string &property, double *value) const
bool get (const std::string &property, COptionBool *value) const
bool get (const std::string &property, COptionInt *value) const
bool get (const std::string &property, COptionDouble *value) const
bool get (const std::string &property, COptionChar *value) const
bool get (const std::string &property, COptionByte *value) const
bool get (const std::string &property, COptionWord *value) const
bool get (const std::string &property, std::string *value, std::string preset) const
bool get (const std::string &property, bool *value, bool preset) const
bool get (const std::string &property, char *value, char preset) const
bool get (const std::string &property, unsigned char *value, unsigned char preset) const
bool get (const std::string &property, short *value, short preset) const
bool get (const std::string &property, unsigned short *value, unsigned short preset) const
bool get (const std::string &property, int *value, int preset) const
bool get (const std::string &property, unsigned int *value, unsigned int preset) const
bool get (const std::string &property, long *value, long preset) const
bool get (const std::string &property, unsigned long *value, unsigned long preset) const
bool get (const std::string &property, long long *value, long long preset) const
bool get (const std::string &property, unsigned long long *value, unsigned long long preset) const
bool get (const std::string &property, float *value, float preset) const
bool get (const std::string &property, double *value, double preset) const
bool getArray (const std::string &property, CConfigPropertyArray *array) const
bool getArray (const std::string &property, double *array, unsigned int maxNumElements) const
bool has (const std::string &property) const
bool hasSection (const std::string &section) const
bool isNull () const
std::string name () const
CConfigSection nextSection () const
CConfigSection nextSimilarSection () const
 operator bool () const
CConfigSection parent () const
CConfigSection section (const std::string &section) const
 ~CConfigSection ()

Protected Attributes

IConfigSectionmIConfigSection

Detailed Description

Definition at line 150 of file Configuration.h.


Constructor & Destructor Documentation

CConfigSection::CConfigSection ( IConfigSection configSectionInterface)

Definition at line 81 of file Configuration.cpp.

Definition at line 86 of file Configuration.cpp.


Member Function Documentation

Definition at line 170 of file Configuration.cpp.

Gets the very first section (useful for iteration).

Parameters:
foundSectionreturns the name of the section, if one is found
Returns:
true if there is a section within this section

Definition at line 122 of file Configuration.cpp.

CConfigProperty CConfigSection::get ( const std::string &  property) const

Gets the value of the given property

Parameters:
propertyThe property
valuePointer to the value field
Returns:
true if property was set from configuration

Definition at line 162 of file Configuration.cpp.

bool CConfigSection::get ( const std::string &  property,
std::string *  value 
) const

Gets the value of the given property

Parameters:
propertyThe property
valuePointer to the value field
Returns:
true if property was set from configuration
bool CConfigSection::get ( const std::string &  property,
bool *  value 
) const
bool CConfigSection::get ( const std::string &  property,
char *  value 
) const
bool CConfigSection::get ( const std::string &  property,
unsigned char *  value 
) const
bool CConfigSection::get ( const std::string &  property,
short *  value 
) const
bool CConfigSection::get ( const std::string &  property,
unsigned short *  value 
) const
bool CConfigSection::get ( const std::string &  property,
int *  value 
) const
bool CConfigSection::get ( const std::string &  property,
unsigned int *  value 
) const
bool CConfigSection::get ( const std::string &  property,
long *  value 
) const
bool CConfigSection::get ( const std::string &  property,
unsigned long *  value 
) const
bool CConfigSection::get ( const std::string &  property,
long long *  value 
) const
bool CConfigSection::get ( const std::string &  property,
unsigned long long *  value 
) const
bool CConfigSection::get ( const std::string &  property,
float *  value 
) const
bool CConfigSection::get ( const std::string &  property,
double *  value 
) const
bool CConfigSection::get ( const std::string &  property,
COptionBool value 
) const
bool CConfigSection::get ( const std::string &  property,
COptionInt value 
) const
bool CConfigSection::get ( const std::string &  property,
COptionDouble value 
) const
bool CConfigSection::get ( const std::string &  property,
COptionChar value 
) const
bool CConfigSection::get ( const std::string &  property,
COptionByte value 
) const
bool CConfigSection::get ( const std::string &  property,
COptionWord value 
) const
bool CConfigSection::get ( const std::string &  property,
std::string *  value,
std::string  preset 
) const

Gets the value of the given property, using a preset value that is set when the property cannot be read

Parameters:
propertyThe property
valuePointer to the value field
presetThe default value
Returns:
true if property was set from configuration
bool CConfigSection::get ( const std::string &  property,
bool *  value,
bool  preset 
) const
bool CConfigSection::get ( const std::string &  property,
char *  value,
char  preset 
) const
bool CConfigSection::get ( const std::string &  property,
unsigned char *  value,
unsigned char  preset 
) const
bool CConfigSection::get ( const std::string &  property,
short *  value,
short  preset 
) const
bool CConfigSection::get ( const std::string &  property,
unsigned short *  value,
unsigned short  preset 
) const
bool CConfigSection::get ( const std::string &  property,
int *  value,
int  preset 
) const
bool CConfigSection::get ( const std::string &  property,
unsigned int *  value,
unsigned int  preset 
) const
bool CConfigSection::get ( const std::string &  property,
long *  value,
long  preset 
) const
bool CConfigSection::get ( const std::string &  property,
unsigned long *  value,
unsigned long  preset 
) const
bool CConfigSection::get ( const std::string &  property,
long long *  value,
long long  preset 
) const
bool CConfigSection::get ( const std::string &  property,
unsigned long long *  value,
unsigned long long  preset 
) const
bool CConfigSection::get ( const std::string &  property,
float *  value,
float  preset 
) const
bool CConfigSection::get ( const std::string &  property,
double *  value,
double  preset 
) const
bool CConfigSection::getArray ( const std::string &  property,
CConfigPropertyArray array 
) const
bool CConfigSection::getArray ( const std::string &  property,
double *  array,
unsigned int  maxNumElements 
) const
bool CConfigSection::has ( const std::string &  property) const

Checks if the property exists in the section.

Parameters:
sectionThe section
propertyThe property
Returns:
true if the property exists

Definition at line 146 of file Configuration.cpp.

bool CConfigSection::hasSection ( const std::string &  section) const

Checks if the section exists.

Parameters:
sectionThe section
Returns:
true if the section exists

Definition at line 98 of file Configuration.cpp.

bool CConfigSection::isNull ( ) const

Sets the value of the property in the given section.

Parameters:
sectionThe section
propertyThe property
valueThe value
std::string CConfigSection::name ( ) const

Returns the name of the section

Returns:
name

Definition at line 90 of file Configuration.cpp.

Gets the next section, regardless of its name

Parameters:
sectionThe section
Returns:
true if ...

Definition at line 130 of file Configuration.cpp.

Gets the next section in line with the same name.

Parameters:
sectionThe section
Returns:
true if ...

Definition at line 138 of file Configuration.cpp.

CConfigSection::operator bool ( ) const [inline]

Definition at line 295 of file Configuration.h.

Returns the parent section.

Definition at line 106 of file Configuration.cpp.

CConfigSection CConfigSection::section ( const std::string &  section) const

Gets the first given section with the specified name.

Parameters:
sectionThe section
Returns:
true if ...

Definition at line 114 of file Configuration.cpp.


Member Data Documentation

Definition at line 153 of file Configuration.h.


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


threemxl
Author(s):
autogenerated on Fri Aug 28 2015 13:21:08