HSL 2.0-Framework
Beschreibung des Frameworks
Öffentliche Methoden | Aufstellung aller Elemente
hsl20_4_debug_page.hsl20_4_debug_page.Section Klassenreferenz

Zugriff auf die Debug-Seite des HS/FS. Mehr ...

Öffentliche Methoden

def __init__ (self, section_key)
 Konstruktor. Mehr ...
 
def set_value (self, key, value)
 Setzt einen Wert. Mehr ...
 
def add_value_to_average_field (self, key, value)
 Setzt einen Wert. Mehr ...
 
def increase_counter_field (self, key)
 Erhöht einen Wert um '1'. Mehr ...
 
def add_message (self, message)
 Fügt der Debug-Sektion eine Meldungsliste hinzu, sofern noch keine Meldungsliste vorhanden ist. Mehr ...
 
def add_exception (self, comment=None)
 Fügt der Debug-Sektion eine Exception-Liste hinzu, sofern noch keine Exception-Liste vorhanden ist. Mehr ...
 
def get_debug_information (self)
 Liefert die bisher gesammelten Debug-Informationen zurück. Mehr ...
 

Ausführliche Beschreibung

Zugriff auf die Debug-Seite des HS/FS.

Eine Instanz dieser Klasse bietet die Möglichkeit, Informationen auf der Debug-Seite des HS/FS auszugeben. Durch einen Aufruf der Methode hsl20_4.framework::create_debug_section wird auf der Debug-Seite automatisch eine eigene Sektion angelegt. Alle Methoden, die diese Klasse anbietet, beziehen sich immer auf diese Sektion.

Zu beachten
Pro Modul-Kontext gibt es eine Sektion auf der Debug-Seite.

Ein Code-Beispiel dafür gibt es auf in der Dokumentation zum Remanentspeicher.

Beschreibung der Konstruktoren und Destruktoren

◆ __init__()

def hsl20_4_debug_page.hsl20_4_debug_page.Section.__init__ (   self,
  section_key 
)

Konstruktor.

Warnung
Diese Klasse sollte nicht direkt instanziert werden.
Parameter
section_keystring
Schlüssel, unter dem alle Einträge auf der Debug-Seite zusammengefasst werden.

Dokumentation der Elementfunktionen

◆ add_exception()

def hsl20_4_debug_page.hsl20_4_debug_page.Section.add_exception (   self,
  comment = None 
)

Fügt der Debug-Sektion eine Exception-Liste hinzu, sofern noch keine Exception-Liste vorhanden ist.


Dieser Liste wird die aktuelle Exception hinzugefügt. Liegt dem System zum Zeit des Aufrufs keine Exception vor, bleibt die Liste unverändert. Es werden bis zu 15 unterschiedliche Exceptions angezeigt. Bei Überlauf verschwindet der älteste Eintrag.
Die Darstellung einer Exception:
ZEITSTEMPEL (ANZAHL)
EXCEPTION

Zu beachten
Wird die gleiche Exception mehrfach hinzugefügt, wird sie nur einmal dargestellt und mit einem Zähler versehen.
Parameter
commentstring
Optional. Kommentar zur Exception.
Ab Version 2.0.4:
Hinweis zur Exception-Liste ergänzt

◆ add_message()

def hsl20_4_debug_page.hsl20_4_debug_page.Section.add_message (   self,
  message 
)

Fügt der Debug-Sektion eine Meldungsliste hinzu, sofern noch keine Meldungsliste vorhanden ist.


Es werden bis zu 25 unterschiedliche Meldungen angezeigt. Bei Überlauf verschwindet der älteste Eintrag.
Die Darstellung einer Meldung:
ZEITSTEMPEL (ANZAHL)
MELDUNGSTEXT

Zu beachten
Wird die gleiche Meldung mehrfach hinzugefügt, wird sie nur einmal dargestellt und mit einem Zähler versehen.
Parameter
messagestring
Meldungstext
Ab Version 2.0.4:
Hinweis zur Meldungsliste ergänzt

◆ add_value_to_average_field()

def hsl20_4_debug_page.hsl20_4_debug_page.Section.add_value_to_average_field (   self,
  key,
  value 
)

Setzt einen Wert.

Berechnet anhand des neuen und des vorhandenen Werts den Durchschnittswert. Gibt es den übergebenen Schlüssel noch nicht, wird er automatisch angelegt.

Parameter
keystring
Schlüssel
valuestring
Wert

◆ get_debug_information()

def hsl20_4_debug_page.hsl20_4_debug_page.Section.get_debug_information (   self)

Liefert die bisher gesammelten Debug-Informationen zurück.

Der Wert enthält dabei ein weiteres Dictionary mit 3 Feldern.

Zu beachten
Wird beim Erzeugen der Debug-Seite vom HS/FS aufgerufen.
Rückgabe
dictionary
Debug-Informationen

◆ increase_counter_field()

def hsl20_4_debug_page.hsl20_4_debug_page.Section.increase_counter_field (   self,
  key 
)

Erhöht einen Wert um '1'.

Gibt es den übergebenen Schlüssel noch nicht, wird er automatisch angelegt und auf '1' gesetzt.

Zu beachten
Beim Erhöhen kann auch ein Schlüssel angegeben werden, der mit einer anderen Methode dieser Klasse erzeugt wurde.
Parameter
keystring
Schlüssel

◆ set_value()

def hsl20_4_debug_page.hsl20_4_debug_page.Section.set_value (   self,
  key,
  value 
)

Setzt einen Wert.

Gibt es den übergebenen Schlüssel noch nicht, wird er automatisch angelegt.

Parameter
keystring
Schlüssel
valuestring
Wert

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