Module settings [Version: v01] (Interface AbsMultiSettings)

Constructor:
MultiSettings()

Factory Method:
AbsMultiSettings *AbsMultiSettingsInterface::createMultiSettings()

Wrapper Class:
MultiSettingsWrapper()

The static method AbsMultiSettingsInterface::createMultiSettings creates a new instance of class MultiSettings.

Return value:
Returns an instance of MultiSettings.

Methods

loadfile (version 1)

Liest eine Settings-Datei ein.

Falls die Datei nicht existiert, wird false zurückgegeben.

Durch wiederholten Aufruf dieser Methode können mehrere Settings-Dateien eingelesen werden. Gleich benannte Blöcke werden dabei zu einem Block zusammengefasst.

Der ausgewählte Block wird durch den Wert des Eintrags mit dem Namen "sblock" im Block mit dem Namen "main" festgelegt.

Signature:

bool loadfile(const char *filename)

Parameters:

const char *

filename

[IN]

Dateiname der Settings-Datei (opt. inkl. Pfad) als null-terminierter String (in ASCII oder UTF-8 Codierung).

Return value:
Gibt true zurück, falls die Datei erfolgreich eingelesen werden konnte, sonst false.

loadfile (version 2)

Liest eine Settings-Datei ein.

Falls die Datei nicht existiert, wird versucht sie anzulegen, falls docreate=true ist.

Durch wiederholten Aufruf dieser Methode können mehrere Settings-Dateien eingelesen werden. Gleich benannte Blöcke werden dabei zu einem Block zusammengefasst.

Der ausgewählte Block wird durch den Wert des Eintrags mit dem Namen "sblock" im Block mit dem Namen "main" festgelegt.

Signature:

bool loadfile(const char *filename,bool docreate)

Parameters:

const char *	filename	[IN]	Dateiname der Settings-Datei (opt. inkl. Pfad) als null-terminierter String (in ASCII oder UTF-8 Codierung).
bool	docreate		Gibt an, ob versucht werden soll eine nicht existierende Datei anzulegen.

Return value:
Gibt true zurück, falls die Datei erfolgreich eingelesen werden konnte, sonst false.

setSelectedDefBlockName

Legt den ausgewählten Block fest. (Der Block muss nicht existieren. Ein neuer Block wird erst angelegt, wenn Werte eingetragen oder abgefragt werden.)

Signature:

void setSelectedDefBlockName(const char *defBlockName)

Parameters:

const char *

defBlockName

[IN]

Filename (incl. path)

getSelectedDefBlockName

Gibt den Namen des ausgewählten Blocks zurück.

Signature:

std::string getSelectedDefBlockName()

Return value:
Der Name des ausgewählten Blocks.

insert

Fügt dem ausgewählten Block einen neuen Eintrag hinzu.

Falls der ausgewählte Block noch nicht existiert, wird er angelegt.

Falls im ausgewählten Block bereits ein Eintrag mit dem angegebenen Namen existiert, so wird ein neuer Eintrag erzeugt, wobei dem Namen zu Unterscheidung von den bestehenden Einträgen ein Suffix (Nummerierung) der Form [$i] angehängt wird, mit $i∈{0,1,2,3,...} fortlaufend.

Die Änderung wirkt sich nur auf die im Speicher geladenen Einstellungen aus. Verwenden Sie save() um die Änderungen in die Settings-Datei zu schreiben.

Signature:

void insert(std::string name,std::string value)

Parameters:

std::string	name		Name des Eintrags.
std::string	value		Wert des Eintrags.

set (version 1)

Überschreibt den Eintrag mit dem angegebenen Namen im ausgewählten Block mit einem neuen Wert. Falls der Eintrag noch nicht existiert, wird er neu angelegt.

Die Änderung wirkt sich nur auf die im Speicher geladenen Einstellungen aus. Verwenden Sie save() um die Änderungen in die Settings-Datei zu schreiben.

Signature:

void set(std::string name,std::string value)

Parameters:

std::string	name		Name des Eintrags.
std::string	value		Wert des Eintrags.

set (version 2)

Überschreibt einen nummerierten Eintrag mit dem angegebenen Namen im ausgewählten Block mit einem neuen Wert. Falls der Eintrag noch nicht existiert, wird er neu angelegt.

Die Änderung wirkt sich nur auf die im Speicher geladenen Einstellungen aus. Verwenden Sie save() um die Änderungen in die Settings-Datei zu schreiben.

Signature:

void set(std::string name,int i,std::string value)

Parameters:

std::string	name	Name des Eintrags.
int	i	Die Nummerierung als Suffix für den Namen eines Eintrags. Beispiel: Der Eintrag mit dem Namen "test" und der Nummerierung i=17 wird unter dem vollständigen Namen "test[17]" abgespeichert.
std::string	value	Wert des Eintrags.

get (version 1)

Ruft den Wert eines Eintrags im ausgewählten Block ab.

Falls der Eintrag noch nicht existiert, wird ein solcher Eintrag mit einem Leerstring als Wert angelegt (und der leere String zurückgegeben).

Signature:

std::string get(std::string name)

Parameters:

std::string

name

Name des Eintrags.

Return value:
Der Wert des angegebenen Eintrags im ausgewählten Block.

get (version 2)

Ruft den Wert eines nummerierten Eintrags im ausgewählten Block ab.

Falls der Eintrag noch nicht existiert, wird ein solcher Eintrag mit einem Leerstring als Wert angelegt (und der leere String zurückgegeben).

Signature:

std::string get(std::string name,int i)

Parameters:

std::string	name		Name des Eintrags.
int	i		Die Nummerierung als Suffix für den Namen eines Eintrags. Beispiel: Der Eintrag mit dem Namen "test" und der Nummerierung i=17 wird unter dem vollständigen Namen "test[17]" abgespeichert.

Return value:
Der Wert des angegebenen Eintrags im ausgewählten Block.

exists (version 1)

Prüft, ob der Eintrag im ausgewählten Block existiert.

Signature:

bool exists(std::string name)

Parameters:

std::string

name

Name des Eintrags.

Return value:
true falls der gesuchte Eintrag existiert, sonst false.

exists (version 2)

Prüft, ob der nummerierte Eintrag im ausgewählten Block existiert.

Signature:

bool exists(std::string name,int i)

Parameters:

std::string	name		Name des Eintrags.
int	i		Die Nummerierung als Suffix für den Namen eines Eintrags. Beispiel: Der Eintrag mit dem Namen "test" und der Nummerierung i=17 wird unter dem vollständigen Namen "test[17]" abgespeichert.

Return value:
true falls der gesuchte Eintrag existiert, sonst false.

getNameCount (version 1)

Gibt die Anzahl Einträge im ausgewählten Block zurück.

Signature:

int getNameCount()

Return value:
Anzahl Einträge im ausgewählten Block.

getNameCount (version 2)

Gibt die Anzahl Einträge mit angegebenem Namen im angegebenen Block zurück.

Signature:

int getNameCount(std::string name)

Parameters:

std::string

name

Name des Eintrags.

Return value:
Anzahl Einträge mit angegebenem Namen im angegebenen Block.

getNextName (version 1)

Gibt den Namen des nächsten Eintrags im ausgewählten Block zurück.

Durch wiederholten Aufruf dieser Methode können alle Einträge abgerufen werden.

Signature:

std::string getNextName()

Return value:
Der Name des nächsten Eintrags im ausgewählten Block.

getNextName (version 2)

Gibt den (vollständigen, ggf. um eine Nummerierung erweiterten) Namen des nächsten Eintrags mit angegebenem Namen im ausgewählten Block zurück.

Durch wiederholten Aufruf dieser Methode können alle Einträge abgerufen werden.

Signature:

std::string getNextName(std::string name)

Parameters:

std::string

name

Name des Eintrags.

Return value:
Der Name des nächsten Eintrags mit angegebenem Namen im ausgewählten Block.

getNextValue (version 2)

Gibt den Wert des nächsten Eintrags mit angegebenem Namen im ausgewählten Block zurück.

Durch wiederholten Aufruf dieser Methode können alle Einträge abgerufen werden.

Signature:

std::string getNextValue(std::string name)

Parameters:

std::string

name

Name des Eintrags.

Return value:
Der Wert des nächsten Eintrags mit angegebenem Namen im ausgewählten Block.