Generic Monitoring-System DMM-Demo Reference Manual. Generated by Doxygen 1.2.6

Transkript

1 Generic Monitoring-System DMM-Demo Reference Manual Generated by Doxygen Sun Apr 22 11:53:

2

3 Contents 1 Generic Monitoring-System DMM-Demo Hierarchical Index Generic Monitoring-System DMM-Demo Class Hierarchy Generic Monitoring-System DMM-Demo Compound Index Generic Monitoring-System DMM-Demo Compound List Generic Monitoring-System DMM-Demo File Index Generic Monitoring-System DMM-Demo File List Generic Monitoring-System DMM-Demo Class Documentation Alarming Class Reference ConfigFile Class Reference Date Class Reference DMMController Class Reference GMS DOMException Class Reference GMS FileException Class Reference GMS IPCException Class Reference GMS MEException Class Reference GMS SMSException Class Reference GMS XMLConsistencyException Class Reference GMS XMLException Class Reference GMS XMLFileException Class Reference GMS XMLInvalidIdRefException Class Reference GMSException Class Reference StrX Class Reference XercesErrorHandler Class Reference Generic Monitoring-System DMM-Demo File Documentation alarming.cpp File Reference

4 ii CONTENTS 5.2 alarming.h File Reference configfile.cpp File Reference configfile.h File Reference date.cpp File Reference date.h File Reference dmmcontroller.cpp File Reference dmmcontroller.h File Reference gmsexception.cpp File Reference gmsexception.h File Reference main.cpp File Reference xerces helpers.cpp File Reference xerces helpers.h File Reference

5 Chapter 1 Generic Monitoring-System DMM-Demo Hierarchical Index 1.1 Generic Monitoring-System DMM-Demo Class Hierarchy This inheritance list is sorted roughly, but not completely, alphabetically: Alarming ConfigFile Date DMMController ErrorHandler XercesErrorHandler std::logic error GMSException GMS FileException GMS IPCException GMS MEException GMS SMSException GMS XMLException GMS DOMException GMS XMLConsistencyException GMS XMLFileException GMS XMLInvalidIdRefException StrX

6 2 Generic Monitoring-System DMM-Demo Hierarchical Index

7 Chapter 2 Generic Monitoring-System DMM-Demo Compound Index 2.1 Generic Monitoring-System DMM-Demo Compound List Here are the classes, structs, unions and interfaces with brief descriptions: Alarming (Aufgabe dieser Klasse ist das Versenden von Ereignis- / Alarmmeldungen) ConfigFile (Einlesen und Auswerten des Konfigurationsfiles wird für die DMM-Demo- Applikation mit dieser Klasse erledigt) Date (Hilfsklasse, die alle Aufgaben im Zusammenhang mit Datum und Zeit innerhalb des Generic Monitoring-Systems erledigt) DMMController (Diese Klasse betreibt ein DigitalMultimeter über die serielle Schnittstelle).. 16 GMS DOMException (Alle Exceptions, die der DOM-Parser (xerces) produziert, werden innherhalb der GMS-Software gefangen und in diese eigene Ausnahmeklasse umgewandelt) GMS FileException (SammelException für alle Ausnahmebedingungen, die im Zusammenhang mit dem File-Handling stehen) GMS IPCException (SammelException für alle Ausnahmebedingungen, die im Zusammenhang mit der Interprozess-Kommunikation stehen) GMS MEException (SammelException für alle Ausnahmebedingungen, die im Zusammenhang mit dem GSM-Mobiltelefon (ME = MobileEquipment) stehen) GMS SMSException (Fehler, die beim Versenden von Nachrichten über den SMS entstehen, werden mit dieser Klasse signalisiert) GMS XMLConsistencyException (Werden inhaltliche Fehler in den XML-Files festgestellt (z.b) 30 GMS XMLException (SammelException für alle Exceptions, die durch XML-Fehler (z.b).. 32 GMS XMLFileException (Wird z.b) GMS XMLInvalidIdRefException (Die verschiedenen XML-Listen verweisen über den ID/IDREF-Mechanismus auf Einträge in anderen Listen) GMSException (Supperklasse für das Exceptionhandling innerhalb aller GMS-Applikationen). 38 StrX (This is a simple class that lets us do easy (though not terribly efficient) trancoding of XMLCh data to local code page for display) XercesErrorHandler (Xerces ist so entworfen und implementiert, dass Methoden keine Exceptions nach aussen (über die Bibliotheksgrenze) werfen, sondern einen Fehlerhandler für die Behandlung von Fehlersituationen aufrufen)

8 4 Generic Monitoring-System DMM-Demo Compound Index

9 Chapter 3 Generic Monitoring-System DMM-Demo File Index 3.1 Generic Monitoring-System DMM-Demo File List Here is a list of all documented files with brief descriptions: alarming.cpp (Titel: DigitalMultimeterDemo) alarming.h (Titel: GMS Utility) configfile.cpp (Titel: DigitalMultimeterDemo) configfile.h (Titel: DigitalMultimeterDemo) date.cpp (Titel: GMS Utility) date.h (Titel: GMS Utility) dmmcontroller.cpp (Titel: DigitalMultimeterDemo) dmmcontroller.h (Titel: DigitalMultimeterDemo) gmsexception.cpp (Titel: GMS-Exceptions) gmsexception.h (Titel: GMS-Exceptions) main.cpp (Titel: GMS DMM Demo) xerces helpers.cpp (Titel: GMS Utility) xerces helpers.h (Titel: GMS Utility)

10 6 Generic Monitoring-System DMM-Demo File Index

11 Chapter 4 Generic Monitoring-System DMM-Demo Class Documentation 4.1 Alarming Class Reference Aufgabe dieser Klasse ist das Versenden von Ereignis- / Alarmmeldungen. #include alarming.h Public Types enum MAX FILEPATH LEN = 4095 Die Konstante legt die maximale Filenamenlänge (inkl. Public Methods Alarming () Default Konstruktor. Alarming () Destruktor. void init (void) Vorgesehen für Aktionen, die einmalig zu Beginn der Existenz eines Objekts dieser Klasse ausgeführt werden müssen. void finish (void) Vorgesehen für Aktionen, die einmalig am Ende der Existenz eines Objekts dieser Klasse ausgeführt werden müssen. void sendmsg (std::string ireceivergroup, std::string imsg= )

12 8 Generic Monitoring-System DMM-Demo Class Documentation Die Methode sendmsg macht einen entspechenden Eintrag im Übergabefile des SMS-Centers. Protected Attributes char xmlfilename [MAX FILEPATH LEN] Filename (inkl. Pfad) der Auftragsliste. char tmpfilename [MAX FILEPATH LEN] Filename (inkl. Pfad) des Temp.Files Detailed Description Aufgabe dieser Klasse ist das Versenden von Ereignis- / Alarmmeldungen. Dafür nimmt diese Klasse die Dienste des SMS-Centers in Anspruch. Da die Schnittstelle zum SMS-Center rein filebasiert funktioniert, besteht das Versenden lediglich aus dem Generieren von XML-Einträgen im entsprechenden File. Author(s): Martin Stahl Definition at line 65 of file alarming.h Member Enumeration Documentation anonymous enum Die Konstante legt die maximale Filenamenlänge (inkl. Pfad) fest, die die Listenfiles aufweisen dürfen. Ganz korrekt wäre das Feststellen der zulässigen Grösse über den Systemcall pathconf(path MAX). Definition at line 76 of file alarming.h {MAX_FILEPATH_LEN = }; Member Function Documentation void Alarming::sendMsg (std::string ireceivergroup, std::string imsg = ) Die Methode sendmsg macht einen entspechenden Eintrag im Übergabefile des SMS-Centers. Das zyklisch ausgeführte SMS-Center verarbeitet dann beim nächsten Durchgang die anliegenden Aufträge und versendet eine entsprechende SMS an alle betroffenen Empfänger.

13 4.1 Alarming Class Reference 9 Parameters: ireceivergroup Bezeichung der Empfängergruppe imsg zu übertragende Meldung, falls leer - es wird die Defaultmeldung übertragen The documentation for this class was generated from the following file: alarming.h

14 10 Generic Monitoring-System DMM-Demo Class Documentation 4.2 ConfigFile Class Reference Einlesen und Auswerten des Konfigurationsfiles wird für die DMM-Demo-Applikation mit dieser Klasse erledigt. #include configfile.h Public Types enum MAX FILEPATH LEN = 4095 Die Konstante legt die maximale Filenamenlänge (inkl. Public Methods ConfigFile () Konstruktor. ConfigFile () Destruktor. bool parsefile (void) throw (GMS DOMException) Mit dieser Methode wird das Konfigurationsfile für die Applikation eingelesen und die Parameterwerte zur Verfügung gestellt. long getmeasureinterval (void) throw (GMS XMLConsistencyException) Liefert den Konfigurationsparameter für das Messintervall. double geteventlevel1 (void) throw (GMS XMLConsistencyException) Liefert den Konfigurationsparameter für Interventionslevel 1. double geteventlevel2 (void) throw (GMS XMLConsistencyException) Liefert den Konfigurationsparameter für Interventionslevel 2. std::vector std::string getevent1receivers (void) throw (GMS XMLConsistencyException) Liefert eine Liste von Empfängergruppen(-Bezeichnern) zurück, an die eine Meldung gesendet werden muss, falls Level 1 überschritten wurde. std::vector std::string getevent2receivers (void) throw (GMS XMLConsistencyException) Liefert eine Liste von Empfängergruppen(-Bezeichnern) zurück, an die eine Meldung gesendet werden muss, falls Level 2 überschritten wurde.

15 4.2 ConfigFile Class Reference 11 Static Public Attributes const DOMParser::ValSchemes VAL SCHEMA Über dieses Klassenattribut wird gesteuert, ob der Parser das File validieren soll oder nicht. const bool DO NAME SPACES Dieses Flag steuert, ob Namespaces beachtet werden sollen. Protected Attributes char xmlfilename [MAX FILEPATH LEN] Filename (inkl. Pfad) der Auftragsliste. DOMParser thedomparser Der Parser, der das XML-File einliest und als DOM-Dokument zur Verfügung stellt Detailed Description Einlesen und Auswerten des Konfigurationsfiles wird für die DMM-Demo-Applikation mit dieser Klasse erledigt. Das Konfigurationsfile liegt als XML-File vor. Author(s): Martin Stahl Definition at line 72 of file configfile.h Member Enumeration Documentation anonymous enum Die Konstante legt die maximale Filenamenlänge (inkl. Pfad) fest, die die Listenfiles aufweisen dürfen. Ganz korrekt wäre das Feststellen der zulässigen Grösse über den Systemcall pathconf(path MAX). Definition at line 96 of file configfile.h {MAX_FILEPATH_LEN = }; Member Function Documentation

16 12 Generic Monitoring-System DMM-Demo Class Documentation std::vector std::string ConfigFile::getEvent1Receivers (void) throw (GMS XMLConsistencyException) Liefert eine Liste von Empfängergruppen(-Bezeichnern) zurück, an die eine Meldung gesendet werden muss, falls Level 1 überschritten wurde. Returns: Liste von Empfängergruppen std::vector std::string ConfigFile::getEvent2Receivers (void) throw (GMS XMLConsistencyException) Liefert eine Liste von Empfängergruppen(-Bezeichnern) zurück, an die eine Meldung gesendet werden muss, falls Level 2 überschritten wurde. Returns: Liste von Empfängergruppen double ConfigFile::getEventLevel1 (void) throw (GMS XMLConsistencyException) Liefert den Konfigurationsparameter für Interventionslevel 1. Methode darf erst aufgerufen werden, nachdem zuvor die Methode readfilein() mindestens einmal ausgführt wurde, da sonst noch kein Inputfile vorliegt. Returns: EventLevel1 bei dessen überschreiten Meldung 1 ausgelöst werden soll double ConfigFile::getEventLevel2 (void) throw (GMS XMLConsistencyException) Liefert den Konfigurationsparameter für Interventionslevel 2. Methode darf erst aufgerufen werden, nachdem zuvor die Methode readfilein() mindestens einmal ausgführt wurde, da sonst noch kein Inputfile vorliegt. Returns: EventLevel2 bei dessen Überschreiten Meldung 2 ausgelöst werden soll long ConfigFile::getMeasureInterval (void) throw (GMS XMLConsistencyException) Liefert den Konfigurationsparameter für das Messintervall. Methode darf erst aufgerufen werden, nachdem zuvor die Methode readfilein() mindestens einmal ausgführt wurde, da sonst noch kein Inputfile vorliegen.

17 4.2 ConfigFile Class Reference 13 Returns: Messintervall in Sekunden bool ConfigFile::parseFile (void) throw (GMS DOMException) Mit dieser Methode wird das Konfigurationsfile für die Applikation eingelesen und die Parameterwerte zur Verfügung gestellt. Returns: true, falls das Einlesen erfolgreich verlaufen ist The documentation for this class was generated from the following file: configfile.h

18 14 Generic Monitoring-System DMM-Demo Class Documentation 4.3 Date Class Reference Hilfsklasse, die alle Aufgaben im Zusammenhang mit Datum und Zeit innerhalb des Generic Monitoring- Systems erledigt. #include date.h Public Methods Date () throw () Default Konstruktor. Date (time t itime) throw () Konstruktor. virtual Date () throw () Destruktor. std::string tostring (void) const throw () Liefert das gespeicherte Datum in Klartextdarstellung. void settocurrenttime (void) throw () Setzt das interne Datenelement für die Zeit auf die aktuelle Systemzeit. Static Public Methods std::string converttostring (const struct tm &itimestruct) throw () Liefert den übergebenen tm-struct als Datum im Klartext zurück. std::string converttostring (const time t &itime) throw () Liefert das übergebene time t-datum als Datum im Klartext zurück. time t getcurrenttime (void) throw () Liefert die aktuelle Systemzeit. Protected Attributes time t thetime Diese Membervariable hält die Nutzinformation Zeit und Datum fest.

19 4.3 Date Class Reference Detailed Description Hilfsklasse, die alle Aufgaben im Zusammenhang mit Datum und Zeit innerhalb des Generic Monitoring- Systems erledigt. Die Klasse kann entweder statisch verwendet werden, um Umformoperationen durchzuführen, oder es können Objekte dieser Klasse instanziert werden, die eine Zeit-/Datumsinformation speichern. Author(s): Martin Stahl Definition at line 67 of file date.h Member Data Documentation time t Date:: thetime [protected] Diese Membervariable hält die Nutzinformation Zeit und Datum fest. Format: Sekunden seit Definition at line 82 of file date.h. The documentation for this class was generated from the following file: date.h

20 16 Generic Monitoring-System DMM-Demo Class Documentation 4.4 DMMController Class Reference Diese Klasse betreibt ein DigitalMultimeter über die serielle Schnittstelle. #include dmmcontroller.h Collaboration diagram for DMMController: Alarming ConfigFile _theeventhandler _TheCfgManger DMMController Public Methods DMMController () Default Konstruktor. DMMController () Destruktor. void start (void) Hauptfunktion der der Controller-Klasse. Static Public Attributes const int SERIAL SPEED Konstante, welche die Geschwindigkeit festlegt, mit der die serielle Schnittstelle, an der das DMM angeschlossen ist, betrieben wird. const std::string SERIAL DEVICE NAME Konstante, welche den Namen der seriellen Schnittstelle definiert, an der das DMM angeschlossen ist. Protected Methods void getnewmeasurevalue (void) Mit dieser Methode wird ein neuer Messwert beim DMM angefordert und von der seriellen Schnittstelle gelesen. void checklimits (double inewvalue) Hier wird überprüft, ob der neue Messwert über einem oder beiden Grenzwerten liegt. void sendeventmsg (int ialarmlevel, std::string imsg) Hier wird überprüft, ob der neue Messwert über einem oder beider Grenzwerte liegt.

21 4.4 DMMController Class Reference 17 void opendmmline (const std::string &idevice) throw (GMS FileException) Diese Funktion öffnet das Gerätefile für die serielle Schnittstelle, angeschlossen ist. an der das Digitalmultimeter Protected Attributes ConfigFile TheCfgManger Das Objekt TheCfgManger ist für das Einlesen und aufbereiten der im Konfigurationsfile gespeicherten Informationen zuständig. Alarming theeventhandler Dieses Objekt ist für das Absetzen von Arlarm- Erignismeldungen verantwortlich. LoggerClient thedatalogger Dieses Objekt ist für das Speichern der Nutzdaten verantwortlich. int seriallinefilehandle Filehandle auf die serielle Schnittstelle, an der das DigitalMultimeter angeschlossen ist. Static Protected Methods speed t symbolic speed (int ispeed) Hilfsmethode, die einen numerischen Wert für die Schnittstellengeschwindigkeit in den entsprechenden symbolischen Wert aus der Wertemenge von speed t zuweist Detailed Description Diese Klasse betreibt ein DigitalMultimeter über die serielle Schnittstelle. Die Messdaten vom DMM werden auf Grenzwertverletzungen hin untersucht und im Datenlogger gespeichert. Wird eine Verletzung eines Grenzwertes festgestellt, setzt das System eine entsprechende Meldung ab. Author(s): Martin Stahl Definition at line 71 of file dmmcontroller.h Member Function Documentation void DMMController::checkLimits (double inewvalue) [protected] Hier wird überprüft, ob der neue Messwert über einem oder beiden Grenzwerten liegt. Ist dies der Fall, wird eine entsprechende Eventmeldung abgesetzt.

22 18 Generic Monitoring-System DMM-Demo Class Documentation Parameters: inewvalue neuer Messwert, der überprüft werden soll void DMMController::getNewMeasureValue (void) [protected] Mit dieser Methode wird ein neuer Messwert beim DMM angefordert und von der seriellen Schnittstelle gelesen. Der Messwert wird dem Logger übergeben. Jeder neue Messwert wird darauf geprüft, ob er keine Grenzwerte verletzt void DMMController::openDMMLine (const std::string & idevice) throw (GMS FileException) [protected] Diese Funktion öffnet das Gerätefile für die serielle Schnittstelle, an der das Digitalmultimeter angeschlossen ist. Im weiteren werden die Kommunikationsparameter für die Datenübertragung vom und zum DMM gesetzt. Die serielle Schnittstelle wird mit dem Parameter O NONBLOCK geöffnet, um zu verhindern, dass das Programm hängen bleibt, falls kein Gerät angeschlossen oder dieses ausgeschaltet ist. Speziell ist die explizite Ansteuerung der RTS-Leitung der RS232- Schnittstelle. Diese Leitung wird bei einigen billigen DMMs zur Speisung des Optokoplers verwendet, der das DMM vom angeschlossenen Rechner trennt. Parameters: idevice Filename der seriellen Schnittstelle void DMMController::sendEventMsg (int ialarmlevel, std::string imsg) [protected] Hier wird überprüft, ob der neue Messwert über einem oder beider Grenzwerte liegt. Ist dies der Fall wird eine entsprechende Eventmeldung abgesetzt. Parameters: ialarmlevel Klassierung der Meldung imsg Meldungstext der gesendet werden soll void DMMController::start (void) Hauptfunktion der der Controller-Klasse. Über diese Methode wird der gesamte Auswerteprozess angestossen speed t DMMController::symbolic speed (int ispeed) [static, protected] Hilfsmethode, die einen numerischen Wert für die Schnittstellengeschwindigkeit in den entsprechenden symbolischen Wert aus der Wertemenge von speed t zuweist.

23 4.4 DMMController Class Reference 19 Returns: Geschwindigkeit als Enum vom Typ speed t The documentation for this class was generated from the following file: dmmcontroller.h

24 20 Generic Monitoring-System DMM-Demo Class Documentation 4.5 GMS DOMException Class Reference Alle Exceptions, die der DOM-Parser (xerces) produziert, werden innherhalb der GMS-Software gefangen und in diese eigene Ausnahmeklasse umgewandelt. #include gmsexception.h Inheritance diagram for GMS DOMException: std::logic_error GMSException GMS_XMLException GMS_DOMException Collaboration diagram for GMS DOMException: std::logic_error GMSException GMS_XMLException GMS_DOMException Public Methods GMS DOMException () Default-Konstruktor. GMS DOMException (const std::string &ireason) Konstruktor. virtual GMS DOMException () Destruktor Detailed Description Alle Exceptions, die der DOM-Parser (xerces) produziert, werden innherhalb der GMS-Software gefangen und in diese eigene Ausnahmeklasse umgewandelt.

25 4.5 GMS DOMException Class Reference 21 Author(s): Martin Stahl Definition at line 105 of file gmsexception.h. The documentation for this class was generated from the following file: gmsexception.h

26 22 Generic Monitoring-System DMM-Demo Class Documentation 4.6 GMS FileException Class Reference SammelException für alle Ausnahmebedingungen, die im Zusammenhang mit dem File-Handling stehen. #include gmsexception.h Inheritance diagram for GMS FileException: std::logic_error GMSException GMS_FileException Collaboration diagram for GMS FileException: std::logic_error GMSException GMS_FileException Public Methods GMS FileException () Default-Konstruktor. GMS FileException (const std::string &ireason) Konstruktor. virtual GMS FileException () Destruktor Detailed Description SammelException für alle Ausnahmebedingungen, die im Zusammenhang mit dem File-Handling stehen. Author(s): Martin Stahl Definition at line 240 of file gmsexception.h. The documentation for this class was generated from the following file:

27 4.6 GMS FileException Class Reference 23 gmsexception.h

28 24 Generic Monitoring-System DMM-Demo Class Documentation 4.7 GMS IPCException Class Reference SammelException für alle Ausnahmebedingungen, Kommunikation stehen. #include gmsexception.h Inheritance diagram for GMS IPCException: die im Zusammenhang mit der Interprozess- std::logic_error GMSException GMS_IPCException Collaboration diagram for GMS IPCException: std::logic_error GMSException GMS_IPCException Public Methods GMS IPCException () Default-Konstruktor. GMS IPCException (const std::string &ireason) Konstruktor. virtual GMS IPCException () Destruktor Detailed Description SammelException für alle Ausnahmebedingungen, Kommunikation stehen. die im Zusammenhang mit der Interprozess- Author(s): Martin Stahl

29 4.7 GMS IPCException Class Reference 25 Definition at line 261 of file gmsexception.h. The documentation for this class was generated from the following file: gmsexception.h

30 26 Generic Monitoring-System DMM-Demo Class Documentation 4.8 GMS MEException Class Reference SammelException für alle Ausnahmebedingungen, die im Zusammenhang mit dem GSM-Mobiltelefon (ME = MobileEquipment) stehen. #include gmsexception.h Inheritance diagram for GMS MEException: std::logic_error GMSException GMS_MEException GMS_SMSException Collaboration diagram for GMS MEException: std::logic_error GMSException GMS_MEException Public Methods GMS MEException () Default-Konstruktor. GMS MEException (const std::string &ireason) Konstruktor. virtual GMS MEException () Destruktor Detailed Description SammelException für alle Ausnahmebedingungen, die im Zusammenhang mit dem GSM-Mobiltelefon (ME = MobileEquipment) stehen. Solche Fehler werden meist von der gsmlib gemeldet.

31 4.8 GMS MEException Class Reference 27 Author(s): Martin Stahl Definition at line 197 of file gmsexception.h. The documentation for this class was generated from the following file: gmsexception.h

32 28 Generic Monitoring-System DMM-Demo Class Documentation 4.9 GMS SMSException Class Reference Fehler, die beim Versenden von Nachrichten über den SMS entstehen, werden mit dieser Klasse signalisiert. #include gmsexception.h Inheritance diagram for GMS SMSException: std::logic_error GMSException GMS_MEException GMS_SMSException Collaboration diagram for GMS SMSException: std::logic_error GMSException GMS_MEException GMS_SMSException Public Methods GMS SMSException () Default-Konstruktor. GMS SMSException (const std::string &ireason) Konstruktor. virtual GMS SMSException () Destruktor Detailed Description Fehler, die beim Versenden von Nachrichten über den SMS entstehen, werden mit dieser Klasse signalisiert. Solche Fehler werden meist von der gsmlib gemeldet.

33 4.9 GMS SMSException Class Reference 29 Author(s): Martin Stahl Definition at line 219 of file gmsexception.h. The documentation for this class was generated from the following file: gmsexception.h

34 30 Generic Monitoring-System DMM-Demo Class Documentation 4.10 GMS XMLConsistencyException Class Reference Werden inhaltliche Fehler in den XML-Files festgestellt (z.b. #include gmsexception.h Inheritance diagram for GMS XMLConsistencyException: std::logic_error GMSException GMS_XMLException GMS_XMLConsistencyException Collaboration diagram for GMS XMLConsistencyException: std::logic_error GMSException GMS_XMLException GMS_XMLConsistencyException Public Methods GMS XMLConsistencyException () Default-Konstruktor. GMS XMLConsistencyException (const std::string &ireason) Konstruktor. virtual GMS XMLConsistencyException () Destruktor Detailed Description Werden inhaltliche Fehler in den XML-Files festgestellt (z.b. keine Default-Meldung und auch keine explizite Meldung für das Versenden gefunden, was zu einer undefinierten Situation führt) wird eine Exception dieser Klasse ausgeworfen. Diese Exception deutet darauf

35 4.10 GMS XMLConsistencyException Class Reference 31 hin, dass in einem XML-File etwas verlangt wird, was in einem anderen XML-File nicht gefunden weden kann. Solche Fehler können vom Parser nicht erkannt werden. Author(s): Martin Stahl Definition at line 175 of file gmsexception.h. The documentation for this class was generated from the following file: gmsexception.h

36 32 Generic Monitoring-System DMM-Demo Class Documentation 4.11 GMS XMLException Class Reference SammelException für alle Exceptions, die durch XML-Fehler (z.b. #include gmsexception.h Inheritance diagram for GMS XMLException: std::logic_error GMSException GMS_XMLException GMS_DOMException GMS_XMLConsistencyException GMS_XMLFileException GMS_XMLInvalidIdRefException Collaboration diagram for GMS XMLException: std::logic_error GMSException GMS_XMLException Public Methods GMS XMLException () Default-Konstruktor. GMS XMLException (const std::string &ireason) Konstruktor. virtual GMS XMLException () Destruktor Detailed Description SammelException für alle Exceptions, die durch XML-Fehler (z.b. Parser, File, etc.) hervorgerufen wurden. Author(s): Martin Stahl

37 4.11 GMS XMLException Class Reference 33 Definition at line 84 of file gmsexception.h. The documentation for this class was generated from the following file: gmsexception.h

38 34 Generic Monitoring-System DMM-Demo Class Documentation 4.12 GMS XMLFileException Class Reference Wird z.b. #include gmsexception.h Inheritance diagram for GMS XMLFileException: std::logic_error GMSException GMS_XMLException GMS_XMLFileException Collaboration diagram for GMS XMLFileException: std::logic_error GMSException GMS_XMLException GMS_XMLFileException Public Methods GMS XMLFileException () Default-Konstruktor. GMS XMLFileException (const std::string &ireason) Konstruktor. virtual GMS XMLFileException () Destruktor Detailed Description Wird z.b. ein XML-File nicht gefunden oder stimmt sein Inhalt nicht mit der DTD überein, wird diese Exception geworfen.

39 4.12 GMS XMLFileException Class Reference 35 Author(s): Martin Stahl Definition at line 126 of file gmsexception.h. The documentation for this class was generated from the following file: gmsexception.h

40 36 Generic Monitoring-System DMM-Demo Class Documentation 4.13 GMS XMLInvalidIdRefException Class Reference Die verschiedenen XML-Listen verweisen über den ID/IDREF-Mechanismus auf Einträge in anderen Listen. #include gmsexception.h Inheritance diagram for GMS XMLInvalidIdRefException: std::logic_error GMSException GMS_XMLException GMS_XMLInvalidIdRefException Collaboration diagram for GMS XMLInvalidIdRefException: std::logic_error GMSException GMS_XMLException GMS_XMLInvalidIdRefException Public Methods GMS XMLInvalidIdRefException () Default-Konstruktor. GMS XMLInvalidIdRefException (const std::string &ireason) Konstruktor. virtual GMS XMLInvalidIdRefException () Destruktor Detailed Description Die verschiedenen XML-Listen verweisen über den ID/IDREF-Mechanismus auf Einträge in anderen Listen.

41 4.13 GMS XMLInvalidIdRefException Class Reference 37 Falls eine IDREF auf eine ID verweist, die in der referenzierten Liste nicht existiert, wird eine GMS - XMLInvalidIdRef -Exception geworfen. Author(s): Martin Stahl Definition at line 149 of file gmsexception.h. The documentation for this class was generated from the following file: gmsexception.h

42 38 Generic Monitoring-System DMM-Demo Class Documentation 4.14 GMSException Class Reference Supperklasse für das Exceptionhandling innerhalb aller GMS-Applikationen. #include gmsexception.h Inheritance diagram for GMSException: GMS_FileException std::logic_error GMSException GMS_IPCException GMS_MEException GMS_XMLException Collaboration diagram for GMSException: std::logic_error GMSException Public Methods GMSException () Default-Konstruktor. GMSException (const std::string &ireason) Konstruktor. virtual GMSException () Destruktor Detailed Description Supperklasse für das Exceptionhandling innerhalb aller GMS-Applikationen. Alle Exceptions, die in GMS-Applikationen auftreten können, sind Spezialisierungen dieser Klasse. Author(s): Martin Stahl Definition at line 63 of file gmsexception.h. The documentation for this class was generated from the following file: gmsexception.h

43 4.15 StrX Class Reference StrX Class Reference This is a simple class that lets us do easy (though not terribly efficient) trancoding of XMLCh data to local code page for display. #include xerces helpers.h Public Methods StrX (const XMLCh const totranscode) Constructor. virtual StrX () Destructor. const char localform () const Getter methods. Private Attributes char flocalform This is the local code page form of the string Detailed Description This is a simple class that lets us do easy (though not terribly efficient) trancoding of XMLCh data to local code page for display. Definition at line 68 of file xerces helpers.h. The documentation for this class was generated from the following file: xerces helpers.h

44 40 Generic Monitoring-System DMM-Demo Class Documentation 4.16 XercesErrorHandler Class Reference Xerces ist so entworfen und implementiert, dass Methoden keine Exceptions nach aussen (über die Bibliotheksgrenze) werfen, sondern einen Fehlerhandler für die Behandlung von Fehlersituationen aufrufen. #include xerces helpers.h Inheritance diagram for XercesErrorHandler: ErrorHandler XercesErrorHandler Collaboration diagram for XercesErrorHandler: ErrorHandler XercesErrorHandler Public Methods XercesErrorHandler () Konstruktor. virtual XercesErrorHandler () Destruktor. bool haserrors () const Über diese Methode kann abgefragt werden, ob bis zum Zeitpunkt des Aufrufs schon Fehler aufgetreten sind. Errorhandler-Interface Die folgenden Methoden werden durch die Basisklasse ErrorHandler vorgeschrieben. Sie definieren das effektive Verhalten des GMS auf die verschiedenen XML-Fehlerereignisse. virtual void warning (const SAXParseException &e) Methode, die Warnungen behandelt. virtual void error (const SAXParseException &e) Methode, die normale Fehler behandelt. virtual void fatalerror (const SAXParseException &e) Methode, die schwerwiegende Fehler behandelt.

45 4.16 XercesErrorHandler Class Reference 41 virtual void reseterrors () Methode, über welche ein anstehender Fehler zurückgesetzt wird. Private Methods XercesErrorHandler (const XercesErrorHandler &) Den Copy-Konstruktor von der öffentlichen Verwendung ausschliessen. void operator= (const XercesErrorHandler &) Den Zuweisungsoperator von der öffentlichen Verwendung ausschliessen. Private Attributes bool erroroccured Sammelflag, das festhält, ob schon irgendwo ein Fehler aufgetreten ist Detailed Description Xerces ist so entworfen und implementiert, dass Methoden keine Exceptions nach aussen (über die Bibliotheksgrenze) werfen, sondern einen Fehlerhandler für die Behandlung von Fehlersituationen aufrufen. Dieser ErrorHandler wird hier definiert. Er muss mit der Methode seterrorhandler() der (DOM-)Parser- Klasse beim Parser angemeldet werden. Definition at line 116 of file xerces helpers.h Member Function Documentation bool XercesErrorHandler::hasErrors () const [inline] Über diese Methode kann abgefragt werden, ob bis zum Zeitpunkt des Aufrufs schon Fehler aufgetreten sind. Returns: true, falls schon Fehler aufgetreten sind Definition at line 145 of file xerces helpers.h { return _erroroccured; } The documentation for this class was generated from the following file: xerces helpers.h

46 42 Generic Monitoring-System DMM-Demo Class Documentation

47 Chapter 5 Generic Monitoring-System DMM-Demo File Documentation 5.1 alarming.cpp File Reference Titel: DigitalMultimeterDemo. #include "alarming.h" #include "date.h" #include syslog.h #include fstream #include stdio.h Include dependency graph for alarming.cpp: string time.h alarming.h date.h syslog.h fstream stdio.h alarming.cpp Detailed Description Titel: DigitalMultimeterDemo. Project: Generic Monitoring-System Path: Source: /home/cvsadmin/repository/gmsdmm/gmsdmm/alarming.cpp,v Revision:

48 44 Generic Monitoring-System DMM-Demo File Documentation Id: History: Date Who Action Mon Mar stm created Description Special Conditions Document References Copyright Copyright (c) 2000, 2001 Martin Stahl stahl@ymail.ch This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. Definition in file alarming.cpp.

49 5.2 alarming.h File Reference alarming.h File Reference Titel: GMS Utility. #include string Include dependency graph for alarming.h: string alarming.h This graph shows which files directly or indirectly include this file: dmmcontroller.cpp main.cpp alarming.cpp dmmcontroller.h alarming.h Compounds class Alarming Aufgabe dieser Klasse ist das Versenden von Ereignis- / Alarmmeldungen Detailed Description Titel: GMS Utility. Project: Generic Monitoring-System Path: Source: Revision: Id: History: Date Who Action Mon Mar stm created

50 46 Generic Monitoring-System DMM-Demo File Documentation Description Special Conditions Document References Copyright Copyright (c) 2000, 2001 Martin Stahl This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. Definition in file alarming.h.

51 5.3 configfile.cpp File Reference configfile.cpp File Reference Titel: DigitalMultimeterDemo. #include "configfile.h" #include util/platformutils.hpp #include syslog.h Include dependency graph for configfile.cpp: stdexcept string sax/errorhandler.hpp iostream parsers/domparser.hpp gmsexception.h xerces_helpers.h vector configfile.h util/platformutils.hpp syslog.h configfile.cpp Detailed Description Titel: DigitalMultimeterDemo. Project: Generic Monitoring-System Path: Source: /home/cvsadmin/repository/gmsdmm/gmsdmm/templates/cpp template,v Revision: Id: History: Date Who Action Sun Mar stm created Description Special Conditions Document References Copyright Copyright (c) 2000, 2001 Martin Stahl

52 48 Generic Monitoring-System DMM-Demo File Documentation This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. Definition in file configfile.cpp.

53 5.4 configfile.h File Reference configfile.h File Reference Titel: DigitalMultimeterDemo. #include "gmsexception.h" #include "xerces helpers.h" #include sax/errorhandler.hpp #include parsers/domparser.hpp #include vector #include string Include dependency graph for configfile.h: stdexcept string sax/errorhandler.hpp iostream parsers/domparser.hpp gmsexception.h xerces_helpers.h vector configfile.h This graph shows which files directly or indirectly include this file: dmmcontroller.cpp main.cpp configfile.cpp dmmcontroller.h configfile.h Compounds class ConfigFile Einlesen und Auswerten des Konfigurationsfiles wird für die DMM-Demo-Applikation mit dieser Klasse erledigt Detailed Description Titel: DigitalMultimeterDemo. Project: Generic Monitoring-System Path: Source: /home/cvsadmin/repository/gmsdmm/gmsdmm/templates/header template,v

54 50 Generic Monitoring-System DMM-Demo File Documentation Revision: Id: History: Date Who Action Sun Mar stm created Description Special Conditions Document References Copyright Copyright (c) 2000, 2001 Martin Stahl This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. Definition in file configfile.h.

55 5.5 date.cpp File Reference date.cpp File Reference Titel: GMS Utility. #include "date.h" #include limits.h #include stdlib.h Include dependency graph for date.cpp: time.h string date.h limits.h stdlib.h date.cpp Detailed Description Titel: GMS Utility. Project: Generic Monitoring-System Path: Source: /home/cvsadmin/repository/gmsdmm/gmsdmm/date.cpp,v Revision: Id: History: Date Who Action Mon Feb stm created Description Special Conditions Document References Copyright Copyright (c) 2000, 2001 Martin Stahl stahl@ymail.ch

56 52 Generic Monitoring-System DMM-Demo File Documentation This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. Definition in file date.cpp.

57 5.6 date.h File Reference date.h File Reference Titel: GMS Utility. #include "time.h" #include string Include dependency graph for date.h: time.h string date.h This graph shows which files directly or indirectly include this file: alarming.cpp date.cpp dmmcontroller.cpp date.h Compounds class Date Hilfsklasse, die alle Aufgaben im Zusammenhang mit Datum und Zeit innerhalb des Generic Monitoring- Systems erledigt Detailed Description Titel: GMS Utility. Project: Generic Monitoring-System Path: Source: /home/cvsadmin/repository/genericmonitoringsystem/src/sms center/sms center/date.h,v Revision: Id: date.h,v /03/25 19:55:37 martin Exp History: Date Who Action Mon Feb stm created

58 54 Generic Monitoring-System DMM-Demo File Documentation Description Special Conditions Document References Copyright Copyright (c) 2000, 2001 Martin Stahl This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. Definition in file date.h.

59 5.7 dmmcontroller.cpp File Reference dmmcontroller.cpp File Reference Titel: DigitalMultimeterDemo. #include "dmmcontroller.h" #include "date.h" #include syslog.h #include unistd.h #include fcntl.h #include stdio.h #include sys/termios.h #include sys/ioctl.h Include dependency graph for dmmcontroller.cpp: sax/errorhandler.hpp parsers/domparser.hpp string time.h xerces_helpers.h vector gmsexception.h date.h loggerclient.h termios.h configfile.h alarming.h unistd.h dmmcontroller.h syslog.h fcntl.h stdio.h sys/termios.h sys/ioctl.h dmmcontroller.cpp Detailed Description Titel: DigitalMultimeterDemo. Project: Generic Monitoring-System Path: Source: /home/cvsadmin/repository/gmsdmm/gmsdmm/dmmcontroller.cpp,v Revision: Id: dmmcontroller.cpp,v /04/15 05:59:32 martin Exp History: Date Who Action Sun Mar stm created Description

60 56 Generic Monitoring-System DMM-Demo File Documentation Special Conditions Document References Copyright Copyright (c) 2000, 2001 Martin Stahl This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. Definition in file dmmcontroller.cpp.

61 5.8 dmmcontroller.h File Reference dmmcontroller.h File Reference Titel: DigitalMultimeterDemo. #include "alarming.h" #include "configfile.h" #include "loggerclient.h" #include string #include termios.h #include unistd.h Include dependency graph for dmmcontroller.h: string stdexcept sax/errorhandler.hpp iostream parsers/domparser.hpp alarming.h gmsexception.h xerces_helpers.h vector configfile.h loggerclient.h termios.h unistd.h dmmcontroller.h This graph shows which files directly or indirectly include this file: dmmcontroller.cpp main.cpp dmmcontroller.h Compounds class DMMController Diese Klasse betreibt ein DigitalMultimeter über die serielle Schnittstelle Detailed Description Titel: DigitalMultimeterDemo. Project: Generic Monitoring-System Path: Source: /home/cvsadmin/repository/gmsdmm/gmsdmm/dmmcontroller.h,v Revision:

62 58 Generic Monitoring-System DMM-Demo File Documentation Id: History: Date Who Action Sun Mar stm created Description Special Conditions Document References Copyright Copyright (c) 2000, 2001 Martin Stahl This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. Definition in file dmmcontroller.h.

63 5.9 gmsexception.cpp File Reference gmsexception.cpp File Reference Titel: GMS-Exceptions. #include "gmsexception.h" Include dependency graph for gmsexception.cpp: stdexcept string gmsexception.h gmsexception.cpp Detailed Description Titel: GMS-Exceptions. Project: Generic Monitoring-System Path: Source: Revision: Id: History: Date Who Action Sat Jan stm created Description Special Conditions Document References Copyright Copyright (c) 2000, 2001 Martin Stahl This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

64 60 Generic Monitoring-System DMM-Demo File Documentation This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. Definition in file gmsexception.cpp.

65 5.10 gmsexception.h File Reference gmsexception.h File Reference Titel: GMS-Exceptions. #include stdexcept #include string Include dependency graph for gmsexception.h: stdexcept string gmsexception.h This graph shows which files directly or indirectly include this file: dmmcontroller.cpp main.cpp configfile.cpp dmmcontroller.h configfile.h gmsexception.cpp xerces_helpers.cpp gmsexception.h Compounds class GMS DOMException Alle Exceptions, die der DOM-Parser (xerces) produziert, werden innherhalb der GMS-Software gefangen und in diese eigene Ausnahmeklasse umgewandelt. class GMS FileException SammelException für alle Ausnahmebedingungen, die im Zusammenhang mit dem File-Handling stehen. class GMS IPCException SammelException für alle Ausnahmebedingungen, die im Zusammenhang mit der Interprozess- Kommunikation stehen. class GMS MEException SammelException für alle Ausnahmebedingungen, die im Zusammenhang mit dem GSM-Mobiltelefon (ME = MobileEquipment) stehen. class GMS SMSException Fehler, die beim Versenden von Nachrichten über den SMS entstehen, werden mit dieser Klasse signalisiert. class GMS XMLConsistencyException Werden inhaltliche Fehler in den XML-Files festgestellt (z.b.

66 62 Generic Monitoring-System DMM-Demo File Documentation class GMS XMLException SammelException für alle Exceptions, die durch XML-Fehler (z.b. class GMS XMLFileException Wird z.b. class GMS XMLInvalidIdRefException Die verschiedenen XML-Listen verweisen über den ID/IDREF-Mechanismus auf Einträge in anderen Listen. class GMSException Supperklasse für das Exceptionhandling innerhalb aller GMS-Applikationen Detailed Description Titel: GMS-Exceptions. Project: Generic Monitoring-System Path: Source: Revision: $Id:$ History: Date Who Action Sat Jan stm created Description Special Conditions Document References Copyright Copyright (c) 2000, 2001 Martin Stahl This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. Definition in file gmsexception.h.