class ara::sm::SmErrorDomain

Die Elementfunktion ara::sm::SmErrorDomain::Message dient der synchronen Ermittlung der textuellen Fehlermeldung, die einem bestimmten Fehlercode der State-Management-Fehlerdomäne zugeordnet ist [SWS_SM_81249]. Sie ist in der Header-Datei ara/sm/sm_error_domain.h innerhalb des Gültigkeitsbereichs der Klasse ara::sm::SmErrorDomain deklariert und besitzt in der Spezifikation den Status DRAFT AUTOSAR_AP_SWS_StateManagement §8.1.3.2.2.1 „Message“.

Die Schnittstelle besitzt folgende Parameter und Rückgabewerte [SWS_SM_81249]:

• Parameter: errorCode vom Typ CodeType nimmt die numerische Fehlernummer entgegen, zu welcher die zugehörige Textmeldung angefordert wird.
• Rückgabewert: Ein Zeiger vom Typ const char * auf die dem übergebenen Fehlercode zugeordnete Fehlermeldung.

Für die Ausführung gelten strenge Zusicherungen bezüglich Nebenläufigkeit und Ausnahmebehandlung: Die Funktion ist als thread-safe und exception safe spezifiziert sowie mit dem Bezeichner noexcept deklariert [SWS_SM_81249]. Sie kann somit sicher aus beliebigen Threads ohne synchronisierende Sperren oder Try-Catch-Blöcke aufgerufen werden.

Im Rahmen des Fehlermanagements von AUTOSAR Adaptive überschreibt die Methode die virtuelle Funktion der Basis-Fehlerdomäne. Interpretation: Da der Rückgabewert als const char * ohne Allokationsschnittstelle definiert ist, dürfte der Zeiger typischerweise auf statische String-Literale verweisen, die über die gesamte Prozesslaufzeit hinweg gültig bleiben. Frage Q-03fc170f18f910b4 (offen)

Die API-Methode Name der Fehlerdomänenklasse ara::sm::SmErrorDomain dient dem Abruf des standardisierten Namens der Fehlerdomäne des State Managements ([SWS_SM_81248]). Gemäß Spezifikation liefert der synchrone Aufruf stets den konstanten Zeichenkettenwert "Sm" zurück (SWS StateManagement §8.1.3.2.2.2 „Name“). Für die Verwendung muss die entsprechende Header-Datei ara/sm/sm_error_domain.h eingebunden werden.

Die Elementfunktion nimmt keine Übergabeparameter entgegen und bietet vollständige Ausnahmesicherheit: Sie ist als noexcept und exception safe spezifiziert ([SWS_SM_81248]), wodurch sie garantiert ohne das Auslösen von Ausnahmen zurückkehrt und keine Fehlercodes erzeugt. Interpretation: Da als Rückgabetyp const char * mit dem festen Wert "Sm" vorgegeben ist, dürfte die Funktion auf ein statisches String-Literal verweisen, dessen Lebensdauer unbegrenzt ist. Frage Q-855d1837679010a7 (offen)

Hinsichtlich des Aufrufkontexts und der Nebenläufigkeit ist die Methode als thread-safe eingestuft ([SWS_SM_81248]). Sie darf somit ohne manuelle Synchronisation parallel aus mehreren Threads ausgeführt werden. Für Integratoren und Entwickler ist ferner relevant, dass die Anforderung im Release R25-11 mit dem Status DRAFT versehen ist (SWS StateManagement §8.1.3.2.2.2 „Name“).

Verwendung

Der Standardkonstruktor SmErrorDomain() erzeugt synchron eine Instanz der Fehlerdomäne ara::sm::SmErrorDomain ([SWS_SM_81247]). Die Deklaration befindet sich in der Header-Datei ara/sm/sm_error_domain.h. Der Aufruf benötigt keine Übergabeparameter und liefert direkt das initialisierte Domänenobjekt zurück (SWS StateManagement §8.1.3.2.1.1 „Default Constructor“).

Fehlerbehandlung

Die Funktion ist mit dem Bezeichner noexcept versehen und als ausnahmesicher (exception safe) klassifiziert ([SWS_SM_81247]). Bei der Erzeugung treten keine Fehlercodes auf und es werden keine Exceptions geworfen.

Nebenläufigkeit und Einschränkungen

Die Erzeugung ist thread-safe spezifiziert ([SWS_SM_81247]). Instanzen können somit nebenläufig in Multithreading-Umgebungen erzeugt werden, ohne dass zusätzliche Synchronisationsmechanismen erforderlich sind. Besondere Reihenfolgebedingungen bestehen nicht.

Zusammenspiel

Das erzeugte Objekt gehört zur Klasse ara::sm::SmErrorDomain ([SWS_SM_81241]), die gemäß [SWS_CORE_90023] spezifiziert ist. Innerhalb des Moduls State Management wirkt die Fehlerdomäne mit folgenden Elementen zusammen:

• Errc ([SWS_SM_81245]) und Exception ([SWS_SM_81246]) als Typsynonyme für Fehlercodes (SmErrc) und Ausnahmebehandlung (SmException).
• Name() ([SWS_SM_81248]) liefert den Domänennamen "Sm".
• Message() ([SWS_SM_81249]) übersetzt Fehlercodes in textuelle Beschreibungen.
• ThrowAsException() ([SWS_SM_81250]) wirft den Fehlercode als Exception, sofern C++-Exceptions aktiviert sind ([SWS_CORE_10304]).
• GetSmDomain() ([SWS_SM_81251]) stellt alternativ eine globale Instanz der Fehlerdomäne zur Verfügung.

Die Funktion ara::sm::SmErrorDomain::ThrowAsException dient dazu, einen Fehlercode aus der Fehlerdomäne des State Managements direkt als C++-Ausnahme zu werfen [SWS_SM_81250]. Sie ist in der Header-Datei ara/sm/sm_error_domain.h deklariert und überschreibt die entsprechende Basisfunktion für Fehlerdomänen (SWS StateManagement §8.1.3.2.2.3 „ThrowAsException“).

Aufruf und Parameter

Die Methode wird synchron aufgerufen und nimmt als einzigen Übergabeparameter eine konstante Referenz auf errorCode (vom Typ ara::core::ErrorCode) entgegen [SWS_SM_81250]. Sie liefert keinen Rückgabewert (void), da sie die zum übergebenen Fehlercode gehörende Exception instanziiert und auslöst, womit der reguläre Kontrollfluss an der Aufrufstelle abgebrochen wird [SWS_SM_81250].

Nebenläufigkeit und Randbedingungen

• Thread-Sicherheit: Die Funktion ist explizit als threadsicher (thread-safe) spezifiziert und kann daher problemlos aus nebenläufigen Threads aufgerufen werden [SWS_SM_81250].
• Ausnahmesicherheit: Das Verhalten ist als not exception safe dokumentiert [SWS_SM_81250]; Interpretation: Dies dürfte dem Umstand geschuldet sein, dass das Werfen der Ausnahme den regulären Kontrollfluss verlässt und die Methode definitionsgemäß fehlschlägt bzw. eine Exception propagiert. Frage Q-5afbb1be303b657b (offen)
• Compiler-Einschränkung: Gemäß [SWS_CORE_10304] nimmt die Funktion nicht an der Überladungsauflösung (overload resolution) teil, sofern C++-Exceptions in der Compiler-Toolchain deaktiviert sind [SWS_SM_81250].