class ara::shwa::ShwaErrorDomain

Class ara::shwa::ShwaErrorDomain provides the module-specific error domain for module shwa and associates error codes with descriptions as well as associated exception types [AP_SWS_SHWA_01305]. In addition to textual querying of domain names and error messages, it offers the capability via ThrowAsException() to specifically throw errors as an exception [AP_SWS_SHWA_01310]. The inspection methods are declared thread-safe and exception-safe.

more ›

Context

Class ara::shwa::ShwaErrorDomain represents the specific error domain for module shwa on the Adaptive Platform and derives from base class ara::core::ErrorDomain. It acts as the central link for uniquely identifying, naming, and textually describing module-specific error causes. Typically, the error domain interacts closely with ara::core::ErrorCode instances as well as the associated exception handling via ShwaException. Via type aliases, the class provides a direct mapping to the module-specific error types: Errc refers to ShwaErrorCode [AP_SWS_SHWA_01305] and Exception to ShwaException [AP_SWS_SHWA_01306].

Context diagram: Embedding of ShwaErrorDomain in interaction with error codes, exceptions, and application logic. Sources: [AP_SWS_SHWA_01305], [AP_SWS_SHWA_01306], [AP_SWS_SHWA_01310]

Lifecycle

Instantiation of ShwaErrorDomain takes place via the default constructor ShwaErrorDomain(), which is declared as noexcept and ensures both thread safety and exception safety [AP_SWS_SHWA_01307]. As a representative of an error domain in the AUTOSAR Adaptive error handling model, such an instance is usually kept long-lived (interpretation: presumably as a static or global singleton object) to repeatedly match error contexts. Question Q-82cb2e14793eeaef (open) Apart from triggering exceptions, all reading methods of the instance are thread-safe and do not throw exceptions.

Usage Path

In regular processing flow, when a module-specific error occurs, a component creates a ara::core::ErrorCode referencing the error domain. For text output or logging, the user calls method Name() to determine the identifier of the error domain [AP_SWS_SHWA_01308], or has Message(errorCode) provide the error description associated with the numeric code [AP_SWS_SHWA_01309]. If an error code is to be transferred to the C++ exception path, the calling logic invokes ThrowAsException() [AP_SWS_SHWA_01310].

Sequence diagram: Typical sequence during error query and conversion into an exception. Sources: [AP_SWS_SHWA_01308], [AP_SWS_SHWA_01309], [AP_SWS_SHWA_01310]

Error Scenarios

Error domains themselves serve to classify errors and are designed to be largely fault-tolerant in their inspection functions. Both Name() [AP_SWS_SHWA_01308] and Message() [AP_SWS_SHWA_01309] are specified as noexcept and exception-safe, so that even for unknown error codes, a defined pointer to a character string is returned (interpretation: presumably a static note or placeholder text). Question Q-03a63539b08ddb73 (open) The only explicitly throwing error scenario is method ThrowAsException(errorCode) [AP_SWS_SHWA_01310]: It is declared with noexcept(false) as “not exception safe” because its primary purpose is the targeted throwing of an exception of type Exception (ShwaException) [AP_SWS_SHWA_01306].