class ara::phm::PhmErrorDomain

The member function Message of class ara::phm::PhmErrorDomain returns, for a passed error number errorCode of type CodeType, a textual description of the associated error message as const char * [SWS_PHM_01249]. The function is provided via the header file ara/phm/phm_error_domain.h and, as a virtual method (override), overrides the standard interface behavior for error resolution [SWS_PHM_01249].

The following specifications apply to the call context and execution semantics:

• Synchronous Execution and Exception Handling: The call is synchronous and is declared as noexcept; in addition, the method is specified as exception safe, so that no exceptions are thrown during execution [SWS_PHM_01249].
• Concurrency: The function is explicitly declared as thread-safe and can be called safely from concurrent threads without additional external synchronization [SWS_PHM_01249].
• Memory Management: Interpretation: The returned character pointer likely points to a static character literal, so that no memory deallocation needs to be performed by the caller. Question Q-dcdc593e3f9ded45 (open)

In Platform Health Management (PHM), the method is used to translate numerical error codes of PhmErrorDomain into human-readable strings for logging or diagnostic purposes [SWS_PHM_01249].

The member function Name of class ara::phm::PhmErrorDomain returns the name of the error domain as a string ([SWS_PHM_01248]). The declaration is included in module phm via header file #include "ara/phm/phm_error_domain.h" ([SWS_PHM_01248]).

The following requirements apply to practical usage and runtime behavior:

• Usage and Signature: The method has the signature const char * Name () const noexcept override; ([SWS_PHM_01248]). It is executed synchronously and expects no arguments. The returned pointer of type const char * complies with the requirements for ara::phm::PhmErrorDomain from [SWS_CORE_90023].
• Error Handling: The function is declared as noexcept and has the exception safety level exception safe ([SWS_PHM_01248]). It throws no exceptions at runtime and generates no error messages.
• Concurrency: The method is specified as thread-safe (thread-safe) ([SWS_PHM_01248]). Parallel calls across the same or different instances can be performed without additional synchronization mechanisms.

In the architectural interaction, the operation overrides the virtual name query of the superordinate error domain interface and provides the specific name for ara::phm::PhmErrorDomain according to [SWS_CORE_90023] ([SWS_PHM_01248]).

The default constructor PhmErrorDomain() is used to create an instance of the error domain ara::phm::PhmErrorDomain [SWS_PHM_01247]. The call is synchronous and without arguments via header ara/phm/phm_error_domain.h [SWS_PHM_01247].

Regarding execution safety, construction is specified as exception safe and declared with noexcept so that no exceptions are thrown [SWS_PHM_01247]. In addition, instantiation is thread-safe [SWS_PHM_01247].

The created domain forms the context for PHM errors, provides member functions such as Name() [SWS_PHM_01248], Message() [SWS_PHM_01249], and ThrowAsException() [SWS_PHM_01250], and maintains the type aliases Errc [SWS_PHM_01245] and Exception [SWS_PHM_01246]. For regular access to the error domain, the free function GetPhmDomain() is available, which returns a reference to the global object [SWS_PHM_01251]. A separate manual instantiation via the constructor is therefore typically not required in application code. Question Q-63be3bb534ef1fa9 (open)

use

The member function ThrowAsException is a method of the error domain class ara::phm::PhmErrorDomain and is provided via the header file ara/phm/phm_error_domain.h ([SWS_PHM_01250]). Its purpose is to synchronously throw the C++ exception associated with the passed error code ([SWS_PHM_01250]). For this purpose, the function takes a reference to the error object errorCode of type const ara::core::ErrorCode & as an input parameter ([SWS_PHM_01250]). Because control flow is continued via the exception in case of faulty execution, the method has no return value (void) ([SWS_PHM_01250]).

Concurrency and Execution Safety

With regard to behavior during parallel calls, ThrowAsException is declared as thread-safe ([SWS_PHM_01250]). It can thus be safely and concurrently called from multiple threads. Regarding exception safety, however, the interface is explicitly classified as "not exception safe" in the specification ([SWS_PHM_01250]).

Compiler Restrictions and Overload Resolution

An essential boundary condition for use is defined by [SWS_CORE_10304]: If C++ exceptions are disabled in the used compiler toolchain, ThrowAsException does not participate in overload resolution ([SWS_PHM_01250]). For software builds for platforms or configurations without exception support, the function is thus not available to the compiler for overload resolution ([SWS_PHM_01250]).