class ara::phm::PhmErrorDomain

Die Elementfunktion Message der Klasse ara::phm::PhmErrorDomain liefert zu einer übergebenen Fehlernummer errorCode vom Typ CodeType eine textuelle Beschreibung der zugehörigen Fehlermeldung als const char * zurück [SWS_PHM_01249]. Die Funktion wird über die Header-Datei ara/phm/phm_error_domain.h bereitgestellt und überschreibt als virtuelle Methode (override) das standardmäßige Schnittstellenverhalten zur Fehlerauflösung [SWS_PHM_01249].

Für den Aufrufkontext und die Ausführungssemantik gelten folgende Festlegungen:

• Synchrone Ausführung und Ausnahmebehandlung: Der Aufruf erfolgt synchron und ist als noexcept deklariert; zudem ist die Methode als exception safe spezifiziert, sodass während der Ausführung keine Ausnahmen geworfen werden [SWS_PHM_01249].
• Nebenläufigkeit: Die Funktion ist explizit als thread-safe deklariert und kann ohne zusätzliche externe Synchronisation sicher aus nebenläufigen Threads aufgerufen werden [SWS_PHM_01249].
• Speicherverwaltung: Interpretation: Der zurückgegebene Zeichenzeiger dürfte auf ein statisches Zeichenliteral verweisen, sodass vom Aufrufer keine Freigabe des Speichers durchgeführt werden muss. Frage Q-dcdc593e3f9ded45 (offen)

Die Methode dient im Platform Health Management (PHM) dazu, numerische Fehlercodes der PhmErrorDomain für Protokollierungs- oder Diagnosezwecke in menschenlesbare Zeichenketten zu übersetzen [SWS_PHM_01249].

Die Elementfunktion Name der Klasse ara::phm::PhmErrorDomain liefert den Namen der Fehlerdomäne als Zeichenkette zurück ([SWS_PHM_01248]). Die Deklaration ist im Modul phm über die Header-Datei #include "ara/phm/phm_error_domain.h" eingebunden ([SWS_PHM_01248]).

Für die praktische Verwendung und das Laufzeitverhalten gelten folgende Vorgaben:

• Verwendung und Signatur: Die Methode besitzt die Signatur const char * Name () const noexcept override; ([SWS_PHM_01248]). Sie wird synchron ausgeführt und erwartet keine Übergabeparameter. Der zurückgegebene Zeiger vom Typ const char * entspricht den Vorgaben für ara::phm::PhmErrorDomain aus [SWS_CORE_90023].
• Fehlerbehandlung: Die Funktion ist als noexcept deklariert und weist die Exception-Sicherheitsstufe exception safe auf ([SWS_PHM_01248]). Sie wirft zur Laufzeit keine Ausnahmen und erzeugt keine Fehlermeldungen.
• Nebenläufigkeit: Die Methode ist als threadsicher (thread-safe) spezifiziert ([SWS_PHM_01248]). Parallele Aufrufe über dieselbe oder verschiedene Instanzen hinweg können ohne zusätzliche Synchronisationsmechanismen durchgeführt werden.

Im architektonischen Zusammenspiel überschreibt die Operation die virtuelle Namensabfrage der übergeordneten Fehlerdomänen-Schnittstelle und stellt den spezifischen Namen für ara::phm::PhmErrorDomain gemäß [SWS_CORE_90023] bereit ([SWS_PHM_01248]).

Der Standardkonstruktor PhmErrorDomain() dient der Erzeugung einer Instanz der Fehlerdomäne ara::phm::PhmErrorDomain [SWS_PHM_01247]. Der Aufruf erfolgt synchron und ohne Übergabeparameter über den Header ara/phm/phm_error_domain.h [SWS_PHM_01247].

Hinsichtlich der Ausführungssicherheit ist die Konstruktion als exception safe spezifiziert und mit noexcept deklariert, sodass keine Ausnahmen ausgelöst werden [SWS_PHM_01247]. Zudem ist die Instanziierung thread-safe [SWS_PHM_01247].

Die erzeugte Domäne bildet den Kontext für PHM-Fehler und stellt Elementfunktionen wie Name() [SWS_PHM_01248], Message() [SWS_PHM_01249] sowie ThrowAsException() [SWS_PHM_01250] bereit und führt die Typ-Aliase Errc [SWS_PHM_01245] und Exception [SWS_PHM_01246]. Für den regulären Zugriff auf die Fehlerdomäne steht die freie Funktion GetPhmDomain() zur Verfügung, die eine Referenz auf das globale Objekt zurückgibt [SWS_PHM_01251]. Eine separate manuelle Instanziierung über den Konstruktor dürfte daher im Anwendungscode typischerweise nicht erforderlich sein. Frage Q-63be3bb534ef1fa9 (offen)

Verwendung

Die Elementfunktion ThrowAsException ist eine Methode der Fehlerdomänenklasse ara::phm::PhmErrorDomain und wird über die Header-Datei ara/phm/phm_error_domain.h bereitgestellt ([SWS_PHM_01250]). Ihr Zweck besteht darin, synchron diejenige C++-Ausnahme auszulösen, die mit dem übergebenen Fehlercode verknüpft ist ([SWS_PHM_01250]). Die Funktion nimmt hierfür als Eingabeparameter eine Referenz auf das Fehlerobjekt errorCode vom Typ const ara::core::ErrorCode & entgegen ([SWS_PHM_01250]). Da der Kontrollfluss bei fehlerhafter Ausführung über die Ausnahme fortgeführt wird, besitzt die Methode keinen Rückgabewert (void) ([SWS_PHM_01250]).

Nebenläufigkeit und Ausführungssicherheit

Im Hinblick auf das Verhalten bei parallelen Aufrufen ist ThrowAsException als thread-safe deklariert ([SWS_PHM_01250]). Sie kann damit gefahrlos und nebenläufig aus mehreren Threads aufgerufen werden. Bezüglich der Exception-Sicherheit ist die Schnittstelle in der Spezifikation hingegen ausdrücklich als „not exception safe“ eingestuft ([SWS_PHM_01250]).

Compiler-Einschränkungen und Überladungsauflösung

Eine wesentliche Randbedingung für den Einsatz definiert [SWS_CORE_10304]: Falls C++-Exceptions in der genutzten Compiler-Toolchain deaktiviert sind, nimmt ThrowAsException nicht an der Überladungsauflösung teil ([SWS_PHM_01250]). Bei Software-Builds für Plattformen oder Konfigurationen ohne Ausnahmeunterstützung steht die Funktion dem Compiler somit nicht zur Überladungsauflösung zur Verfügung ([SWS_PHM_01250]).