Cfgs Klassenreferenz

Die Klasse Cfgs fasst alle Konfigurationsparameter zusammen. Mehr ...

#include <cfgs.h>

Aufstellung aller Elemente

Öffentliche Methoden
	Cfgs (string accPath, string cfgFileName, string progName, string progVers)
	Konstruktor liest die Konfigurationsdatei ein oder belegt die Parameter mit Default-Werten.
int	readCfgFile ()
	Liest alle Werte aus der Konfigurationsdatei ein und schreibt sie in die Members.
bool	readParam (Config &cfg, const string &param, string &val, const string &section) const
	Liest Parameter param ein und gibt Fehlermeldung auf ERR_LOG aus, falls es nicht geklappt hat.
bool	writeParam (Config &cfg, const string &param, const string &val, const string &section) const
	Schreibt Parameter param und gibt Fehlermeldung auf ERR_LOG aus, falls es nicht geklappt hat.
void	updtCfgFile ()
	Schreibt alle veraenderbaren Membervariablen in die Konfigurationsdatei.
void	startStopLogging ()
	Initialisiert die Log-Objekte bzw. stoppt das Logging je nach mLogMode.
Öffentliche Attribute
DisplayMode	mDisplayMode
int	mXpos
	horizontale Position des Rechnerdialogs
int	mYpos
	vertikale Position des Rechnerdialogs
int	mWidth
	Breite des Rechnerdialogs.
int	mHeight
	Hoehe des Rechnerdialogs.
bool	mAlwaysOnTop
	Flag, ob Dialog immer im Vordergrund.
int	mZoom
	kein echter Parameter, nur Zwischenspeicher
bool	mShowHint
	Flag, ob Hinweis auf Hilfe gezeigt wird.
bool	mShowToolTips
	Flag, ob Tooltips gezeigt werden.
bool	mLogMode
	Flag, ob Logging eingeschaltet ist.
string	mNvRam
	"non volatile" RAM (Speicher, Winkelmodus, ...)
string	mBrowserPath
	Pfad zum HTML-Browser fuer die Hilfe.
string	mOnlLogFile
	Pfad und Dateiname fuer Online-Logging.
string	mDbgLogFile
	Pfad und Dateiname fuer Debug-Logging.
string	mErrLogFile
	Pfad und Dateiname fuer Error-Logging.
int	mMaxLogLen
	Maximale Groesse einer Log-Datei.
int	mOnlChannels
	Online-Logging: konfigurierte Kanaele.
int	mDbgChannels
	Debug-Logging : konfigurierte Kanaele.
int	mErrChannels
	Error-Logging : konfigurierte Kanaele.
string	mExclFileToLog
	Dateiname der einzigen Log-Datei.
Private Methoden
void	setDefaults ()
	Setzt alle Werte, die in der Konfigurationsdatei geaendert werden koennen, auf Default-Werte.
int	writeDefaultCfgFile ()
	Lesen der Konfigurationsdatei ging schief! Schreibt Konfigurationsdatei mit den aktuellen Werten (das sind bei der Konstruktion der Klasse die Default-Werte) und Kommentaren.
const string	displayModeToStr (DisplayMode dm) const
	Wandelt DisplayMode dm in String um.
const string	boolToStr (bool bl) const
	Wandelt bool bl in "on" oder "off".
DisplayMode	strToDisplayMode (const string &str) const
	Wandelt String str in DisplayMode um.
bool	strToBool (const string &str) const
	Wandelt String str in bool um.
Private Attribute
string	mCfgFileName
	Name der Konfigurationsdatei.
string	mProgName
	Name des Programms, zu dem die Datei gehoert.
string	mProgVers
	Version d. Prgrms., zu dem die Datei gehoert.

---

Ausführliche Beschreibung

Die Klasse Cfgs fasst alle Konfigurationsparameter zusammen.

Ausserdem wird die Verwaltung der Konfigurationsdatei gehandhabt. Die Taschenrechnerklasse CalculatorBase enthaelt ein Objekt dieser Klasse als Member. Um den Zugriff durch andere Programmteile zu erleichtern, sind alle Konfigurationsparameter, die in der Datei stehen, oeffentlich zugaenglich.

---

Beschreibung der Konstruktoren und Destruktoren

Cfgs::Cfgs (  string  accPath, string  cfgFileName, string  progName, string  progVers )

Konstruktor liest die Konfigurationsdatei ein oder belegt die Parameter mit Default-Werten. Parameter: accPath  Pfad zum Zubehoer-Ordner (obsolet, da Datei jetzt im Wurzelverzeichnis liegt) cfgFileName  Name der einzulesenden Konfigurationsdatei progName  Name des Programms, das die Datei einliest; dieser Name wird als Parameter in der Datei erwartet progVers  Versionsnummer des Programms, das die Datei einliest; dieser String wird als Parameter in der Datei erwartet

---

Dokumentation der Elementfunktionen

const string Cfgs::boolToStr (  bool  bl  )  const [private]

Wandelt bool bl in "on" oder "off". Parameter: bl  true oder false Rückgabe: "on" oder "off"

const string Cfgs::displayModeToStr (  DisplayMode  dm  )  const [private]

Wandelt DisplayMode dm in String um. Wird zum Schreiben des Display-Modes in die Datei benoetigt. Parameter: dm  in String zu wandelnder Display-Mode Rückgabe: Display-Mode als String

int Cfgs::readCfgFile (   )

Liest alle Werte aus der Konfigurationsdatei ein und schreibt sie in die Members. Rückgabe: 0: OK; -1: Lesen de Konfig.datei gescheitert -2: Programmname stimmt nicht mit Namen in der Datei ueberein -3: Programmname stimmt nicht mit Version in der Datei ueberein

bool Cfgs::readParam (  Config &  cfg, const string &  param, string &  val, const string &  section )  const

Liest Parameter param ein und gibt Fehlermeldung auf ERR_LOG aus, falls es nicht geklappt hat. Parameter: cfg  Referenz auf Config-Objekt param  String mit Namen des einzulesenden Parmeters section  String mit Namen der Sektion, in der der einzulesende Parameter steht Rückgabewerte: val  String mit dem eingelesenen Wert des Parameters Rückgabe: true, wenn das Einlesen geklappt hat, sonst false

void Cfgs::setDefaults (   )  [private]

Setzt alle Werte, die in der Konfigurationsdatei geaendert werden koennen, auf Default-Werte.

void Cfgs::startStopLogging (   )

Initialisiert die Log-Objekte bzw. stoppt das Logging je nach mLogMode.

bool Cfgs::strToBool (  const string &  str  )  const [private]

Wandelt String str in bool um. Parameter: str  "on" oder "off" Rückgabe: true oder false

DisplayMode Cfgs::strToDisplayMode (  const string &  str  )  const [private]

Wandelt String str in DisplayMode um. Wird zum Lesen des Display-Modes benoetigt. Parameter: str  String mit dem Display-Mode Rückgabe: DisplayMode, der dem String entspricht

void Cfgs::updtCfgFile (   )

Schreibt alle veraenderbaren Membervariablen in die Konfigurationsdatei.

int Cfgs::writeDefaultCfgFile (   )  [private]

Lesen der Konfigurationsdatei ging schief! Schreibt Konfigurationsdatei mit den aktuellen Werten (das sind bei der Konstruktion der Klasse die Default-Werte) und Kommentaren. Rückgabe: 0: OK; -1: Schreiben der Konfigurationsdatei fehlgeschlagen

bool Cfgs::writeParam (  Config &  cfg, const string &  param, const string &  val, const string &  section )  const

Schreibt Parameter param und gibt Fehlermeldung auf ERR_LOG aus, falls es nicht geklappt hat. Parameter: cfg  Referenz auf Config-Objekt param  String mit Namen des zu schreibenden Parmeters section  String mit Namen der Sektion, in der der zu schreibende Parameter steht Rückgabewerte: val  String mit dem zu schreibenden Wert des Parameters Rückgabe: true, wenn das Schreiben geklappt hat, sonst false

---

Dokumentation der Datenelemente

bool Cfgs::mAlwaysOnTop

Flag, ob Dialog immer im Vordergrund.

string Cfgs::mBrowserPath

Pfad zum HTML-Browser fuer die Hilfe.

string Cfgs::mCfgFileName [private]

Name der Konfigurationsdatei.

int Cfgs::mDbgChannels

Debug-Logging : konfigurierte Kanaele.

string Cfgs::mDbgLogFile

Pfad und Dateiname fuer Debug-Logging.

DisplayMode Cfgs::mDisplayMode

int Cfgs::mErrChannels

Error-Logging : konfigurierte Kanaele.

string Cfgs::mErrLogFile

Pfad und Dateiname fuer Error-Logging.

string Cfgs::mExclFileToLog

Dateiname der einzigen Log-Datei.

int Cfgs::mHeight

Hoehe des Rechnerdialogs.

bool Cfgs::mLogMode

Flag, ob Logging eingeschaltet ist.

int Cfgs::mMaxLogLen

Maximale Groesse einer Log-Datei.

string Cfgs::mNvRam

"non volatile" RAM (Speicher, Winkelmodus, ...)

int Cfgs::mOnlChannels

Online-Logging: konfigurierte Kanaele.

string Cfgs::mOnlLogFile

Pfad und Dateiname fuer Online-Logging.

string Cfgs::mProgName [private]

Name des Programms, zu dem die Datei gehoert.

string Cfgs::mProgVers [private]

Version d. Prgrms., zu dem die Datei gehoert.

bool Cfgs::mShowHint

Flag, ob Hinweis auf Hilfe gezeigt wird.

bool Cfgs::mShowToolTips

Flag, ob Tooltips gezeigt werden.

int Cfgs::mWidth

Breite des Rechnerdialogs.

int Cfgs::mXpos

horizontale Position des Rechnerdialogs

int Cfgs::mYpos

vertikale Position des Rechnerdialogs

int Cfgs::mZoom

kein echter Parameter, nur Zwischenspeicher

---

Die Dokumentation für diese Klasse wurde erzeugt aufgrund der Dateien:

• home/fs/cpp/almetare/almetare/base/cfgs.h
• home/fs/cpp/almetare/almetare/base/cfgs.cpp

---