class ara::sm::SmErrorDomain

The member function ara::sm::SmErrorDomain::Message serves to synchronously determine the textual error message that is assigned to a specific error code of the State Management error domain [SWS_SM_81249]. It is declared in the header file ara/sm/sm_error_domain.h within the scope of class ara::sm::SmErrorDomain and has the status DRAFT in the specification AUTOSAR_AP_SWS_StateManagement §8.1.3.2.2.1 “Message”.

The interface has the following parameters and return values [SWS_SM_81249]:

• Parameter: errorCode of type CodeType accepts the numerical error number for which the associated text message is requested.
• Return value: A pointer of type const char * to the error message assigned to the passed error code.

Strict assurances regarding concurrency and exception handling apply to the execution: The function is specified as thread-safe and exception safe and is declared with the identifier noexcept [SWS_SM_81249]. It can thus be safely called from arbitrary threads without synchronizing locks or try-catch blocks.

Within the error management of AUTOSAR Adaptive, the method overrides the virtual function of the base error domain. Interpretation: Because the return value is defined as const char * without an allocation interface, the pointer is typically likely to refer to static string literals that remain valid across the entire process runtime. Question Q-03fc170f18f910b4 (open)

The API method Name of the error domain class ara::sm::SmErrorDomain is used to retrieve the standardized name of the State Management error domain ([SWS_SM_81248]). According to the specification, the synchronous call always returns the constant string value "Sm" (SWS StateManagement §8.1.3.2.2.2 “Name”). For use, the corresponding header file ara/sm/sm_error_domain.h must be included.

The member function takes no input parameters and provides full exception safety: It is specified as noexcept and exception safe ([SWS_SM_81248]), guaranteeing that it returns without throwing exceptions and generates no error codes. Interpretation: Since const char * with the fixed value "Sm" is specified as the return type, the function is likely to refer to a static string literal whose lifetime is unlimited. Question Q-855d1837679010a7 (open)

Regarding call context and concurrency, the method is classified as thread-safe ([SWS_SM_81248]). It may therefore be executed in parallel from multiple threads without manual synchronization. For integrators and developers, it is furthermore relevant that the requirement in release R25-11 is provided with the status DRAFT (SWS StateManagement §8.1.3.2.2.2 “Name”).

use

The default constructor SmErrorDomain() synchronously creates an instance of the error domain ara::sm::SmErrorDomain ([SWS_SM_81247]). The declaration is located in the header file ara/sm/sm_error_domain.h. The call requires no parameters and directly returns the initialized domain object (SWS StateManagement §8.1.3.2.1.1 “Default Constructor”).

Error handling

The function is provided with the identifier noexcept and classified as exception safe ([SWS_SM_81247]). During creation, no error codes occur and no exceptions are thrown.

Concurrency and Limitations

Creation is specified as thread-safe ([SWS_SM_81247]). Instances can therefore be created concurrently in multithreaded environments without requiring additional synchronization mechanisms. No special ordering constraints exist.

Interaction

The created object belongs to class ara::sm::SmErrorDomain ([SWS_SM_81241]), which is specified according to [SWS_CORE_90023]. Within the State Management module, the error domain interacts with the following elements:

• Errc ([SWS_SM_81245]) and Exception ([SWS_SM_81246]) as type aliases for error codes (SmErrc) and exception handling (SmException).
• Name() ([SWS_SM_81248]) returns the domain name "Sm".
• Message() ([SWS_SM_81249]) translates error codes into textual descriptions.
• ThrowAsException() ([SWS_SM_81250]) throws the error code as an exception if C++ exceptions are enabled ([SWS_CORE_10304]).
• GetSmDomain() ([SWS_SM_81251]) alternatively provides a global instance of the error domain.

The function ara::sm::SmErrorDomain::ThrowAsException serves to throw an error code from the State Management error domain directly as a C++ exception [SWS_SM_81250]. It is declared in the header file ara/sm/sm_error_domain.h and overrides the corresponding base function for error domains (SWS StateManagement §8.1.3.2.2.3 “ThrowAsException”).

Call and Parameters

The method is called synchronously and takes a constant reference to errorCode (of type ara::core::ErrorCode) as its only input parameter [SWS_SM_81250]. It returns no return value (void), because it instantiates and throws the exception associated with the passed error code, whereby the regular control flow at the call site is aborted [SWS_SM_81250].

Concurrency and Constraints

• Thread safety: The function is explicitly specified as thread-safe (thread-safe) and can therefore be called from concurrent threads without issue [SWS_SM_81250].
• Exception safety: The behavior is documented as not exception safe [SWS_SM_81250]; Interpretation: This is likely due to the fact that throwing the exception leaves the regular control flow and the method by definition fails or propagates an exception. Question Q-5afbb1be303b657b (open)
• Compiler restriction: According to [SWS_CORE_10304], the function does not participate in overload resolution if C++ exceptions are disabled in the compiler toolchain [SWS_SM_81250].