OKW_Memorize ist die Speicher-Klasse hinter den Merke*-Schlüsselwörter. Mehr ...

Zusammengehörigkeiten von OKW.OKW_Memorize:

Öffentliche Methoden
bool	Exists (string fpsKey)
	Prüft ob es eine Eintragzum Schlüssel fpsKey vorhanden ist. Mehr ...

string	Get (string fpsKey)
	Holt den Aktuellen Wert eines Schlüssels. Mehr ...

void	Init ()
	Initialsiert die Klasse OKW.OKW_Memorize. Mehr ...

void	Read ()
	Liest die Werte der Klasse OKW_Memorize aus einer Datei, gegeben in OKW.OKW_Ini.Xml_Ini_xml, ein. Es wird eine XML Datei gelesen. Hierzu wird die Klasse OKW_Memorize mit System.Xml.XmlSerializer deserialisiert. Mehr ...

void	Save ()
	Schreibt die Felder (fields) der Klasse OKW_Memorize in eine Datei. Mehr ...

void	Set (string fpsKey, string fpsValue)

Öffentliche, statische Methoden
static void	Reset ()
	Methode setzt diese Klasse zurück. Mehr ...

Öffentliche Attribute
string	OKW_Memorize_xml = string.Empty
	Variable hält Pfad und Dateinamen der OKW_Memorize.xml. Mehr ...

SerializableDictionary< string, string >	_Value = new SerializableDictionary<string, string>()
	Dictionary speichert die Schlüssel-Wert Paare. Mehr ...

Propertys
static OKW_Memorize	Instance `[get]`
	Diese Methode gibt die einzige Instanz dieser Klasse zurück. Mehr ...

Private Methoden
	OKW_Memorize ()
	Privater Konstruktor dieser Klasse. Mehr ...

Private Attribute
LogMessenger	LM = null
	Eine lokale Instanz des OKW.Log.LogMssenger. Mehr ...

Logger	Log = Logger.Instance
	Referenz auf die einzige Instanz des Klasse OKW.Logger. Mehr ...

Statische, private Attribute
static OKW_Memorize	_Instance
	Singelton spezifisch: Dieses Feld speichert die einzige Instanz dieser Klasse. Mehr ...

Ausführliche Beschreibung

OKW_Memorize ist die Speicher-Klasse hinter den Merke*-Schlüsselwörter.

Die Daten werden vie Serialisierung in eine XML Datei geschrieben. Zur Serialisierung wird die Klasse System.Xml.XmlSerializer verwendet.

Pfad und Name der XML-Datei. Dies wird in der XML/OKW_Ini.xml vorgegeben: XPATH: OKW_Ini/OKW_Enviroment/OKW_Memorize_xml

Diese Klasse ist nach denm Singelton-Muster aufgebaut.

Die Instanz der Klasse wird wie folgt abgerufen:

~~~~~~~~~~~~~{.py} OKW.OKW_Memorrize.Instanz
~~~~~~~~~~~~~

Autor
Zoltán Hrabovszki

Datum
2013.12.06

Definiert in Zeile 72 der Datei OKW_Memorize.cs.

Beschreibung der Konstruktoren und Destruktoren

OKW.OKW_Memorize.OKW_Memorize ( )

private

Privater Konstruktor dieser Klasse.

Zu beachten: Der Konstruktor muss private sein, weil die Klasse ein Singelton ist. Verwende die Methode OKW_Memorize.Instace() um eine Instanz dieser Klasse zu erhalten.

Autor: Zoltán Hrabovszki

Datum: 2014.14.27

Definiert in Zeile 149 der Datei OKW_Memorize.cs.

         {
             this.LM = new LogMessenger(this.GetType().Name);
         }

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

Dokumentation der Elementfunktionen

bool OKW.OKW_Memorize.Exists ( string fpsKey )

Prüft ob es eine Eintragzum Schlüssel fpsKey vorhanden ist.

Nach Aufruf dieser Methode befinden sich die Klasse im Initialzustand. Dazu wird die Instance-Variable auf__null__ gesetzt. Wird in erster Linie für die Unittest benötigt.

Parameter

fpsKey Schlüssel, der geprüft werden soll. , falls der gegeben schlüssel existiert, sonst false

Rückgabe

Autor: Zoltan Hrabovszki

Datum: 2013.11.25

Definiert in Zeile 220 der Datei OKW_Memorize.cs.

         {
             bool lvbReturn = false;
 
             this.Log.LogFunctionStartDebug(_Instance.GetType().FullName + "Exists", "string fpsKey", fpsKey);
 
             if (this._Value.ContainsKey(fpsKey))
             {
                 lvbReturn = true;
             }
             
             this.Log.LogFunctionEndDebug(lvbReturn);
             
             return lvbReturn;
         }

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

string OKW.OKW_Memorize.Get ( string fpsKey )

Holt den Aktuellen Wert eines Schlüssels.

Kernfunktion dieser Klasse. Holt zum gegeben Schlüssel fpsKey den aktuellwert aus OKW_Memmorize._Value.

Ausnahmebehandlung

Es	wird die Ausnahme OKWMemorizeKeyNotExistsException ausgelöst, wenn ein Schlüssel abgefragt wird, der vorher nicht eigespeichert wurde.

Parameter

fpsKey

Autor: Zoltán Hrabovszki

Datum: 2014.14.27

Definiert in Zeile 250 der Datei OKW_Memorize.cs.

         {
             string lvsReturn = string.Empty;
             bool bOK = false;
 
             this.Log.LogFunctionStartDebug(_Instance.GetType().FullName + "Get", "String fpsKey", fpsKey);
 
             try
             {
                 if (this._Value.ContainsKey(fpsKey))
                 {
                     lvsReturn = this._Value[fpsKey];
                 }
                 else
                 {
                     string ErrorText = this.LM.GetMessage("Get", "OKWMemorizeKeyNotExistsException", fpsKey);
                     throw new OKWMemorizeKeyNotExistsException(ErrorText);
                 }
                 
                 bOK = true;
             }
             finally
             {
                 if (bOK)
                 {
                     this.Log.LogFunctionEndDebug();
                 }
                 else
                 {
                     this.Log.LogFunctionEndDebug(lvsReturn);
                 }
             }
             
             return lvsReturn;
         }

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

void OKW.OKW_Memorize.Init ( )

Initialsiert die Klasse OKW.OKW_Memorize.

Die Initialisierung der Klasse OKW.OKW_Ini läuft wie folgt ab:

Autor: Zoltán Hrabovszki

Datum: 2013.11.28

Definiert in Zeile 317 der Datei OKW_Memorize.cs.

         {
             this.Log.LogFunctionStartDebug(this.GetType().FullName + ".Init");
 
             // Klassen Variablen erst löschen...
             _Instance.OKW_Memorize_xml = string.Empty;
             _Instance._Value.Clear();
 
             // ... und dann alles Initialisieren!
             // 1. Setze Pfad und
             this.OKW_Memorize_xml = OKW_Ini.Instance.OKW_Enviroment.File_OKW_Memorize_xml;
 
             if (!string.IsNullOrEmpty(this.OKW_Memorize_xml))
             {
                 this.Log.LogPrintDebug("OKW Memorize Datei = >>" + this.OKW_Memorize_xml + "<<");
                 if (System.IO.File.Exists(this.OKW_Memorize_xml))
                 {
                     // Lesen der Daten...
                     this.Read();
                 }
                 else
                 {
                     // Deafault Werte Lesen.
                     this.Log.LogWarning("Datei: >>" + this.OKW_Memorize_xml + "<< nicht gefunden.");
                 }
             }
             else
             {
                 this.Log.LogWarning("Enviroment variable 'OKWIni' not set!");
             }
 
             this.Log.LogFunctionEndDebug();
             return;
         }

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

void OKW.OKW_Memorize.Read ( )

Liest die Werte der Klasse OKW_Memorize aus einer Datei, gegeben in OKW.OKW_Ini.Xml_Ini_xml, ein. Es wird eine XML Datei gelesen. Hierzu wird die Klasse OKW_Memorize mit System.Xml.XmlSerializer deserialisiert.

Autor: Zoltán Hrabovszki

Datum: 2013.11.28

Definiert in Zeile 362 der Datei OKW_Memorize.cs.

         {
             this.Log.LogFunctionStartDebug(_Instance.GetType().FullName + "Read()");
 
             try
             {
                 XmlSerializer serializer = new XmlSerializer(typeof(OKW_Memorize));
                 StreamReader fs = new StreamReader(this.OKW_Memorize_xml);
                 _Instance = (OKW_Memorize)serializer.Deserialize(fs);
                 fs.Close();
             }
             finally
             {
                 this.Log.LogFunctionEndDebug();
             }
 
             return;
         }

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

static void OKW.OKW_Memorize.Reset ( )

static

Methode setzt diese Klasse zurück.

Nach Aufruf dieser Methode befinden sich die Klasse im Initialzustand. Dazu wird die Instance-Variable auf__null__ gesetzt. Wird in erster Linie für die Unittest benötigt.

Autor: Zoltan Hrabovszki

Datum: 2013.11.25

Definiert in Zeile 202 der Datei OKW_Memorize.cs.

         {
             _Instance = null;
         }

void OKW.OKW_Memorize.Save ( )

Schreibt die Felder (fields) der Klasse OKW_Memorize in eine Datei.

Es wird eine XML Datei geschrieben. Hierzu wird die Klasse OKW_Ini mit der Klasse System.Xml.XmlSerializer serialisiert.

Pfad und Name der XML-Datei. Dies wird in der XML/OKW_Ini.xml vorgegeben: XPATH: OKW_Ini/OKW_Enviroment/OKW_Memorize_xml

Autor: Zoltán Hrabovszki

Datum: 2013.11.28

Definiert in Zeile 394 der Datei OKW_Memorize.cs.

         {
             this.Log.LogFunctionStartDebug(_Instance.GetType().FullName + "Save()");
 
             try
             {
                 XmlSerializer serializer = new XmlSerializer(typeof(OKW_Memorize));
                 StreamWriter fs = new StreamWriter(this.OKW_Memorize_xml, false);
                 serializer.Serialize(fs, _Instance);
                 fs.Close();
             }
             finally
             {
                 this.Log.LogFunctionEndDebug();
             }
             
             return;
         }

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

void OKW.OKW_Memorize.Set	(	string	fpsKey,
		string	fpsValue
	)

Autor: Zoltán Hrabovszki

Datum: 2014.12.27

Definiert in Zeile 420 der Datei OKW_Memorize.cs.

         {
             this.Log.LogFunctionStartDebug(_Instance.GetType().FullName + "Set", "String fpsKey", fpsKey, "String fpsValue", fpsValue);
             
             try
             {
                 if (this._Value.ContainsKey(fpsKey))
                 {
                     string lvsOverwriteKey = this.LM.GetMessage("Set", "OverwriteKeyWarning", fpsKey);
                     string lvsOldValue = this.LM.GetMessage("Set", "OldValue", this._Value[fpsKey]);
                     string lvsNewValue = this.LM.GetMessage("Set", "NewValue", fpsValue);
 
                     this.Log.LogWarning(lvsOverwriteKey);
                     this.Log.LogPrint(lvsOldValue);
                     this.Log.LogPrint(lvsNewValue);
                     _Instance._Value[fpsKey] = fpsValue;
                 }
                 else
                 {
                     _Instance._Value.Add(fpsKey, fpsValue);
                     this.Log.LogPrint("Wert: " + fpsValue  + " wird gespeichert");
                 }
                 
                 // persistentes Speichern aller Daten...
                 _Instance.Save();
             }
             finally
             {
                 this.Log.LogFunctionEndDebug();
             }
 
             return;
         }

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

Dokumentation der Datenelemente

OKW_Memorize OKW.OKW_Memorize._Instance

staticprivate

Singelton spezifisch: Dieses Feld speichert die einzige Instanz dieser Klasse.

Autor: Zoltán Hrabovszki

Datum: 2013.11.28

Definiert in Zeile 108 der Datei OKW_Memorize.cs.

SerializableDictionary<string, string> OKW.OKW_Memorize._Value = new SerializableDictionary<string, string>()

Dictionary speichert die Schlüssel-Wert Paare.

Zu beachten: Dieses Feld muss wegen der Serialisierung public sein.

Autor: Zoltán Hrabovszki

Datum: 2013.11.28

Definiert in Zeile 97 der Datei OKW_Memorize.cs.

LogMessenger OKW.OKW_Memorize.LM = null

private

Eine lokale Instanz des OKW.Log.LogMssenger.

Autor: Zoltán Hrabovszki

Datum: 2014.12.28

Definiert in Zeile 120 der Datei OKW_Memorize.cs.

Logger OKW.OKW_Memorize.Log = Logger.Instance

private

Referenz auf die einzige Instanz des Klasse OKW.Logger.

Autor: Zoltán Hrabovszki

Datum: 2013.11.28

Definiert in Zeile 132 der Datei OKW_Memorize.cs.

string OKW.OKW_Memorize.OKW_Memorize_xml = string.Empty

Variable hält Pfad und Dateinamen der OKW_Memorize.xml.

Autor: Zoltán Hrabovszki

Datum: 2013.11.28

Definiert in Zeile 84 der Datei OKW_Memorize.cs.

Dokumentation der Propertys

OKW_Memorize OKW.OKW_Memorize.Instance

staticget

Diese Methode gibt die einzige Instanz dieser Klasse zurück.

Nachdem Singelton-Muster wird die einzige Instanz der Klasse mit einer Methode abgerufen.

Diese Methode erzeug eine Instanz dieser Klasse und initialisiert diesen, sofern nicht bereits eine Instanz der Klasse exsistiert. Wenn eine Instenz bereits vorhanden ist, dann wird nur die Referenz auf die Instanz zurückgeliefert

Beipsile für die Verwendung sind unter der Beschreibung dieser Klasse, OKW.OKW_Memorize, zu finden.

Autor: Zoltán Hrabovszki

Datum: 2014.14.27

Definiert in Zeile 174 der Datei OKW_Memorize.cs.

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

OKW/OKW_Memorize.cs

Öffentliche Methoden

Öffentliche, statische Methoden

Öffentliche Attribute

Propertys

Private Methoden

Private Attribute

Statische, private Attribute

Ausführliche Beschreibung

Beschreibung der Konstruktoren und Destruktoren

Dokumentation der Elementfunktionen

Dokumentation der Datenelemente

Dokumentation der Propertys