igor::iConfigReader Class Reference

#include <iConfigReader.h>

Inherits igor::iModule< iConfigReader >.

Public Member Functions
void	readConfiguration (const iaString &filename)
bool	writeConfiguration (const iaString &filename)
const iaString	getValue (const iaString &setting) const
int64	getValueAsInt (const iaString &setting) const
float64	getValueAsFloat (const iaString &setting) const
const std::vector< iaString >	getValueAsArray (const iaString &setting) const
bool	hasSetting (const iaString &setting) const

Friends
class	iModule< iConfigReader >

Additional Inherited Members
Static Public Member Functions inherited from igor::iModule< iConfigReader >
static IGOR_INLINE iConfigReader &	getInstance ()
static IGOR_INLINE bool	isInstantiated ()
static void	create ()
static void	destroy ()
Protected Member Functions inherited from igor::iModule< iConfigReader >
	iModule ()=default
virtual	~iModule ()=default

Detailed Description

reader for general Igor configuration file.

usually located at config/Igor.xml

Member Function Documentation

getValue()

const iaString igor::iConfigReader::getValue

(

const iaString &

setting

)

const

Returns

value for given setting as string

Parameters

key	the given setting

getValueAsArray()

const std::vector< iaString > igor::iConfigReader::getValueAsArray

(

const iaString &

setting

)

const

Returns

value for given setting array of string

Parameters

key	the given setting

getValueAsFloat()

float64 igor::iConfigReader::getValueAsFloat

(

const iaString &

setting

)

const

Returns

value for given setting as float

Parameters

key	the given setting

getValueAsInt()

int64 igor::iConfigReader::getValueAsInt

(

const iaString &

setting

)

const

Returns

value for given setting as int

Parameters

key	the given setting

hasSetting()

bool igor::iConfigReader::hasSetting

(

const iaString &

setting

)

const

Returns

true if given setting is set

Parameters

setting

the given setting

readConfiguration()

void igor::iConfigReader::readConfiguration

(

const iaString &

filename

)

opens and reads configuration file from filesystem.

using tinyXML API

Parameters

filename

path to configuration file

writeConfiguration()

bool igor::iConfigReader::writeConfiguration

(

const iaString &

filename

)

writes current configuration to given file

Parameters

filename

the given filename

Returns

true if successful

Friends And Related Function Documentation

iModule< iConfigReader >

friend class iModule< iConfigReader >

friend

---

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

• /home/maddin/dev/Igor/src/igor/igor/resources/config/iConfigReader.h
• /home/maddin/dev/Igor/src/igor/igor/resources/config/iConfigReader.cpp