klasse ara::sm::SmErrorDomain

De lidfunctie ara::sm::SmErrorDomain::Message dient voor het synchroon bepalen van de tekstuele foutmelding die is toegewezen aan een specifieke foutcode van het foutdomein van State Management [SWS_SM_81249]. Ze is gedeclareerd in het headerbestand ara/sm/sm_error_domain.h binnen de scope van de klasse ara::sm::SmErrorDomain en heeft in de specificatie de status DRAFT AUTOSAR_AP_SWS_StateManagement §8.1.3.2.2.1 “Message”.

De interface heeft de volgende parameters en retourwaarden [SWS_SM_81249]:

• Parameter: errorCode van het type CodeType accepteert het numerieke foutnummer waarvoor de bijbehorende tekstmelding wordt aangevraagd.
• Retourwaarde: Een pointer van het type const char * naar de foutmelding die is toegewezen aan de overgedragen foutcode.

Voor de uitvoering gelden strikte garanties ten aanzien van concurrency en uitzonderingsafhandeling: de functie is gespecificeerd als thread-safe en exception safe en gedeclareerd met de identifier noexcept [SWS_SM_81249]. Ze kan zodoende veilig vanuit willekeurige threads worden aangeroepen zonder synchroniserende locks of try-catch-blokken.

In het kader van het foutbeheer van AUTOSAR Adaptive overschrijft de methode de virtuele functie van het basis-foutdomein. Interpretatie: Aangezien de retourwaarde is gedefinieerd als const char * zonder allocatie-interface, zal de pointer doorgaans verwijzen naar statische string literals die gedurende de gehele proceslooptijd geldig blijven. Vraag Q-03fc170f18f910b4 (open)

De API-methode Name van de foutdomeinklasse ara::sm::SmErrorDomain dient voor het opvragen van de gestandaardiseerde naam van het foutdomein van State Management ([SWS_SM_81248]). Volgens de specificatie levert de synchrone aanroep altijd de constante tekenreekswaarde "Sm" op (SWS StateManagement §8.1.3.2.2.2 “Name”). Voor het gebruik moet het bijbehorende headerbestand ara/sm/sm_error_domain.h worden ingevoegd.

De lidfunctie accepteert geen invoerparameters en biedt volledige uitzonderingsveiligheid: zij is gespecificeerd als noexcept en exception safe ([SWS_SM_81248]), waardoor zij gegarandeerd terugkeert zonder het genereren van uitzonderingen en geen foutcodes produceert. Interpretatie: Aangezien als retourtype const char * met de vaste waarde "Sm" is voorgeschreven, verwijst de functie vermoedelijk naar een statische string literal waarvan de levensduur onbeperkt is. Vraag Q-855d1837679010a7 (open)

Wat betreft de aanroepcontext en de concurrency is de methode geclassificeerd als thread-safe ([SWS_SM_81248]). Ze mag zodoende zonder handmatige synchronisatie parallel vanuit meerdere threads worden uitgevoerd. Voor integrators en ontwikkelaars is het voorts relevant dat de eis in release R25-11 is voorzien van de status DRAFT (SWS StateManagement §8.1.3.2.2.2 “Name”).

Gebruik

De standaardconstructor SmErrorDomain() genereert synchroon een instantie van het foutdomein ara::sm::SmErrorDomain ([SWS_SM_81247]). De declaratie bevindt zich in het headerbestand ara/sm/sm_error_domain.h. De aanroep vereist geen overdrachtsparameters en levert direct het geïnitialiseerde domeinobject op (SWS StateManagement §8.1.3.2.1.1 “Default Constructor”).

Foutafhandeling

De functie is voorzien van de identifier noexcept en geclassificeerd als uitzonderingsveilig (exception safe) ([SWS_SM_81247]). Bij het aanmaken treden geen foutcodes op en worden geen excepties gegenereerd.

Gelijktijdigheid en beperkingen

Het aanmaken is gespecificeerd als thread-safe ([SWS_SM_81247]). Instanties kunnen zodoende gelijktijdig in multithreading-omgevingen worden aangemaakt zonder dat aanvullende synchronisatiemechanismen vereist zijn. Er gelden geen bijzondere volgordevoorwaarden.

Samenspel

Het aangemaakte object behoort tot de klasse ara::sm::SmErrorDomain ([SWS_SM_81241]), die volgens [SWS_CORE_90023] is gespecificeerd. Binnen de module State Management werkt het foutdomein samen met de volgende elementen:

• Errc ([SWS_SM_81245]) en Exception ([SWS_SM_81246]) als typesynoniemen voor foutcodes (SmErrc) en exceptieafhandeling (SmException).
• Name() ([SWS_SM_81248]) levert de domeinnaam "Sm" op.
• Message() ([SWS_SM_81249]) vertaalt foutcodes naar tekstuele beschrijvingen.
• ThrowAsException() ([SWS_SM_81250]) werpt de foutcode op als exceptie, mits C++-excepties zijn ingeschakeld ([SWS_CORE_10304]).
• GetSmDomain() ([SWS_SM_81251]) stelt als alternatief een globale instantie van het foutdomein beschikbaar.

De functie ara::sm::SmErrorDomain::ThrowAsException dient ertoe een foutcode uit het foutdomein van State Management direct als C++-uitzondering te werpen [SWS_SM_81250]. Ze is gedeclareerd in het headerbestand ara/sm/sm_error_domain.h en overschrijft de overeenkomstige basisfunctie voor foutdomeinen (SWS StateManagement §8.1.3.2.2.3 “ThrowAsException”).

Aanroep en parameters

De methode wordt synchroon aangeroepen en accepteert als enige invoerparameter een constante referentie naar errorCode (van het type ara::core::ErrorCode) [SWS_SM_81250]. Ze levert geen retourwaarde op (void), omdat ze de uitzondering horend bij de overgedragen foutcode instantieert en triggert, waardoor de reguliere controlestroom op de aanroepplek wordt afgebroken [SWS_SM_81250].

Gelijktijdigheid en randvoorwaarden

• Thread-safety: De functie is expliciet gespecificeerd als thread-safe (thread-safe) en kan daarom probleemloos vanuit concurrente threads worden aangeroepen [SWS_SM_81250].
• Uitzonderingsveiligheid: Het gedrag is gedocumenteerd als not exception safe [SWS_SM_81250]; interpretatie: dit is vermoedelijk te wijten aan het feit dat het opwerpen van de uitzondering de reguliere controlestroom verlaat en de methode per definitie faalt respectievelijk een uitzondering propageert. Vraag Q-5afbb1be303b657b (open)
• Compilerbeperking: Volgens [SWS_CORE_10304] neemt de functie niet deel aan de overload resolution zolang C++-exceptions in de compiler-toolchain gedeactiveerd zijn [SWS_SM_81250].