Almetare  1.15
Alle meine Taschenrechner - Eine C++-Bibliothek zur Entwicklung von Taschenrechnern
Cfgs Klassenreferenz

Anzeigeart des Rechners. Mehr ...

#include <cfgs.h>

Öffentliche Methoden

 Cfgs (string accPath, string cfgFileName, string progName, string progVers)
 Konstruktor liest die Konfigurationsdatei ein oder belegt die Parameter mit Default-Werten. Mehr ...
 
int readCfgFile ()
 Liest alle Werte aus der Konfigurationsdatei ein und schreibt sie in die Members. Mehr ...
 
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. Mehr ...
 
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. Mehr ...
 
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. Mehr ...
 
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. Mehr ...
 
const string displayModeToStr (DisplayMode dm) const
 Wandelt DisplayMode dm in String um. Mehr ...
 
const string boolToStr (bool bl) const
 Wandelt bool bl in "on" oder "off". Mehr ...
 
DisplayMode strToDisplayMode (const string &str) const
 Wandelt String str in DisplayMode um. Mehr ...
 
bool strToBool (const string &str) const
 Wandelt String str in bool um. Mehr ...
 

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

Anzeigeart des Rechners.

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::Cfgs ( string  accPath,
string  cfgFileName,
string  progName,
string  progVers 
)

Konstruktor liest die Konfigurationsdatei ein oder belegt die Parameter mit Default-Werten.

Parameter
accPathPfad zum Zubehoer-Ordner (obsolet, da Datei jetzt im Wurzelverzeichnis liegt)
cfgFileNameName der einzulesenden Konfigurationsdatei
progNameName des Programms, das die Datei einliest; dieser Name wird als Parameter in der Datei erwartet
progVersVersionsnummer des Programms, das die Datei einliest; dieser String wird als Parameter in der Datei erwartet

Dokumentation der Elementfunktionen

◆ boolToStr()

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

Wandelt bool bl in "on" oder "off".

Parameter
bltrue oder false
Rückgabe
"on" oder "off"

◆ displayModeToStr()

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
dmin String zu wandelnder Display-Mode
Rückgabe
Display-Mode als String

◆ readCfgFile()

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

◆ readParam()

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
cfgReferenz auf Config-Objekt
paramString mit Namen des einzulesenden Parmeters
sectionString mit Namen der Sektion, in der der einzulesende Parameter steht
Rückgabewerte
valString mit dem eingelesenen Wert des Parameters
Rückgabe
true, wenn das Einlesen geklappt hat, sonst false

◆ setDefaults()

void Cfgs::setDefaults ( )
private

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

◆ strToBool()

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

Wandelt String str in bool um.

Parameter
str"on" oder "off"
Rückgabe
true oder false

◆ strToDisplayMode()

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

Wandelt String str in DisplayMode um.

Wird zum Lesen des Display-Modes benoetigt.

Parameter
strString mit dem Display-Mode
Rückgabe
DisplayMode, der dem String entspricht

◆ writeDefaultCfgFile()

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

◆ writeParam()

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
cfgReferenz auf Config-Objekt
paramString mit Namen des zu schreibenden Parmeters
sectionString mit Namen der Sektion, in der der zu schreibende Parameter steht
Rückgabewerte
valString mit dem zu schreibenden Wert des Parameters
Rückgabe
true, wenn das Schreiben geklappt hat, sonst false

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