class ara::core::ErrorCode

Der Template-Konstruktor ErrorCode instanziiert synchron eine Fehlerbeschreibung innerhalb der Klasse ara::core::ErrorCode aus der Header-Datei ara/core/error_code.h [SWS_CORE_00512]. Er übernimmt einen domänenspezifischen Fehlercode-Wert e eines Aufzählungstyps EnumT sowie optionale herstellerspezifische Zusatzdaten data vom Typ ErrorDomain::SupportDataType, die standardmäßig leer initialisiert werden [SWS_CORE_00512]. Als wesentliche Restriktion nimmt der Konstruktor per SFINAE nur dann an der Überladungsauflösung teil, wenn es sich bei EnumT tatsächlich um einen Aufzählungstyp handelt [SWS_CORE_00512]. Im Unterschied zur alternativen Überladung mit expliziter Domänenübergabe [SWS_CORE_00513] dürfte die Zuordnung zur passenden ErrorDomain vermutlich implizit anhand des Typs EnumT abgeleitet werden. Frage Q-83bc8268971748ff (offen)

Hinsichtlich Nebenläufigkeit und Fehlersicherheit ist der Konstruktor als threadsicher (thread-safe) sowie vollständig ausnahmesicher (exception safe) spezifiziert und als noexcept deklariert [SWS_CORE_00512]. Durch die constexpr-Qualifizierung kann die Instanziierung bereits zur Übersetzungszeit in Konstantenausdrücken erfolgen [SWS_CORE_00512]. Spezifische DET- oder DEM-Fehlermeldungen sind für die Konstruktion nicht definiert. Soll der repräsentierte Fehler im weiteren Kontrollfluss als Ausnahme signalisiert werden, stellt die erzeugte Instanz die Methode ThrowAsException() bereit, welche den passenden Ausnahmetyp ermittelt und auslöst [SWS_CORE_00519]; korrespondierend dazu kann auch die Fehlerdomäne die Ausnahme direkt werfen [SWS_CORE_00154].

Im Zusammenspiel mit dem Gesamtsystem können die Eigenschaften des Objekts über die Methoden Value() [SWS_CORE_00514], Domain() [SWS_CORE_00515], SupportData() [SWS_CORE_00516] und die Textdarstellung Message() [SWS_CORE_00518] abgefragt werden. Bei Wertevergleichen über operator== [SWS_CORE_00571] und operator!= [SWS_CORE_00572] werden ausschließlich Value() und Domain() berücksichtigt, während SupportData() unberücksichtigt bleibt [SWS_CORE_00571]. Des Weiteren dient das erzeugte Objekt als Basis zur Kapselung in standardisierten Ausnahmeobjekten wie ara::core::Exception [SWS_CORE_00611] (auslesbar über Error() [SWS_CORE_00613]), ara::core::CoreException [SWS_CORE_05212] oder ara::core::FutureException [SWS_CORE_00412].

Die Elementfunktion SupportData() der Klasse ara::core::ErrorCode aus dem Header #include "ara/core/error_code.h" liefert ergänzende Kontextdaten zu einem Fehler zurück [SWS_CORE_00516]. Die Methode wird synchron auf einer Instanz aufgerufen, erfordert keine Parameter und gibt einen Wert vom Typ ErrorDomain::SupportDataType zurück [SWS_CORE_00516]. Durch die Deklaration als constexpr und noexcept ist der Aufruf garantiert ausnahmefrei und kann bereits zur Übersetzungszeit ausgewertet werden [SWS_CORE_00516].

Hinsichtlich der Nebenläufigkeit und Ausführungssicherheit ist die Methode als threadsicher (thread-safe) sowie ausnahmesicher (exception safe) spezifiziert [SWS_CORE_00516]. Da es sich um einen lesenden Zugriff auf den internen Fehlerkontext handelt, treten keine Fehlerzustände auf, womit sich der Aufruf auch für kritische und nebenläufige Ausführungspfade eignet [SWS_CORE_00516].

Im Zusammenspiel mit den weiteren Schnittstellen der Fehlerbehandlung liest SupportData() jene herstellerspezifischen Zusatzdaten aus, die dem Konstruktor von ErrorCode optional über den Parameter data übergeben wurden [SWS_CORE_00513]. Beim Vergleich zweier Fehlercodes mittels operator== ist zu beachten, dass Instanzen ausschließlich anhand der Rückgaben von Value() und Domain() als gleich bewertet werden; der Rückgabewert von SupportData() wird für den Gleichheitsvergleich ausdrücklich nicht herangezogen [SWS_CORE_00571].

Die Elementfunktion ThrowAsException der Klasse ara::core::ErrorCode dient dazu, einen aufgetretenen Fehler synchron als C++-Ausnahme auszulösen ([SWS_CORE_00519]). Die Funktion nimmt keine Übergabeparameter entgegen und besitzt keinen Rückgabewert, da der reguläre Kontrollfluss durch das Werfen der Exception unterbrochen wird.

Zur Ermittlung des konkreten Exception-Typs delegiert die Methode das Auslösen an die zugeordnete Fehlerdomäne gemäß dem Verhalten this->Domain().ThrowAsException(*this) ([SWS_CORE_00519]). Über die Schnittstelle der Basisklasse ara::core::ErrorDomain ([SWS_CORE_00154]) bestimmt die jeweilige Domäne den passenden Exception-Typ nach Vorgabe von [SWS_CORE_10953]. Die ausgelöste Ausnahme enthält stets die auslösende ErrorCode-Instanz. Konkrete Domänen implementieren dies spezifisch:

• ara::core::FutureErrorDomain wirft eine FutureException mit der übergebenen Fehlerinstanz ([SWS_CORE_00444]).
• ara::core::CoreErrorDomain wirft eine CoreException, welche die Instanz kapselt ([SWS_CORE_05244], [SWS_CORE_10304]).

Hinsichtlich Nebenläufigkeit und Randbedingungen ist ThrowAsException als threadsicher spezifiziert ([SWS_CORE_00519]). Die Ausnahmesicherheit ist mit not exception safe deklariert, und die Signatur weist explizit noexcept(false) auf ([SWS_CORE_00519]). Eine zentrale Restriktion der Toolchain besteht darin, dass die Funktion nicht an der Überladungsauflösung teilnimmt, wenn C++-Exceptions im Compiler deaktiviert sind ([SWS_CORE_00519]).