igor::iConfig Class Reference

#include <iConfig.h>

Inherits igor::iModule< iConfig >.

Public Member Functions
void	read (const iaString &filename)
bool	write (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	hasValue (const iaString &setting) const
void	setValue (const iaString &setting, const iaString &value)
void	setValue (const iaString &setting, const std::vector< iaString > &values)

Friends
class	iModule< iConfig >

Additional Inherited Members
Static Public Member Functions inherited from igor::iModule< iConfig >
static IGOR_INLINE iConfig &	getInstance ()
static IGOR_INLINE bool	isInstantiated ()
static void	createInstance ()
static void	destroyInstance ()
Protected Member Functions inherited from igor::iModule< iConfig >
	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::iConfig::getValue

(

const iaString &

setting

)

const

Returns

value for given setting as string

Parameters

key	the given setting

getValueAsArray()

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

(

const iaString &

setting

)

const

Returns

value for given setting array of string

Parameters

key	the given setting

getValueAsFloat()

float64 igor::iConfig::getValueAsFloat

(

const iaString &

setting

)

const

Returns

value for given setting as float

Parameters

key	the given setting

getValueAsInt()

int64 igor::iConfig::getValueAsInt

(

const iaString &

setting

)

const

Returns

value for given setting as int

Parameters

key	the given setting

hasValue()

bool igor::iConfig::hasValue

(

const iaString &

setting

)

const

Returns

true if given setting is set

Parameters

setting

the given setting

read()

void igor::iConfig::read

(

const iaString &

filename

)

opens and reads configuration file from filesystem.

using tinyXML API

Parameters

filename

path to configuration file

setValue() [1/2]

void igor::iConfig::setValue	(	const iaString &	setting,
		const iaString &	value
	)

sets value on setting and overrides all values that been there before

Parameters

setting	the setting to set
value	the value to set

setValue() [2/2]

void igor::iConfig::setValue	(	const iaString &	setting,
		const std::vector< iaString > &	values
	)

sets multiple values on setting and overrides all values that been there before

Parameters

setting	the setting to set
values	the values to set

write()

bool igor::iConfig::write

(

const iaString &

filename = ""

)

writes current configuration to given file

Parameters

filename

the given filename

Returns

true if successful

Friends And Related Function Documentation

iModule< iConfig >

friend class iModule< iConfig >

friend

---

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

• /home/martin/dev/Igor/src/igor/igor/resources/config/iConfig.h
• /home/martin/dev/Igor/src/igor/igor/resources/config/iConfig.cpp