class ara::nm::NmErrorDomain

The error domain ara::nm::NmErrorDomain encapsulates error handling of Network Management in the AUTOSAR Adaptive Platform and incorporates error codes NmErrc as well as exception class NmException [SWS_ANM_01101]. Its primary tasks include providing readable error messages via Message() as well as controlled throwing of associated exceptions via ThrowAsException() [SWS_ANM_01108]. As a central constraint, instantiation and all member functions are implemented thread-safe (thread-safe), ensuring concurrent error querying throughout the overall system.

more ›

Context

The class ara::nm::NmErrorDomain functions within the AUTOSAR Adaptive Platform as a domain-specific error domain for the Network Management subsystem [SWS_ANM_01101]. As a final specialization of base class ara::core::ErrorDomain, it provides the standardized framework for identifying, textually describing, and forwarding errors that may occur during the operation of Network Management functions [SWS_ANM_01101].

Within the NM error handling concept, the class links concrete error causes with the general error handling mechanisms of the runtime environment. Here, the class defines a direct mapping to the relevant types via type aliases: Via alias Errc, it incorporates the underlying enumeration NmErrc, which declares the specific error codes for Network Management [SWS_ANM_01103]. At the same time, it references the specialized exception class NmException via alias Exception, allowing errors to be transferred into the C++ exception mechanism if required [SWS_ANM_01104]. Through this aggregation, NmErrorDomain serves as the central link between the error states of the module and the error-specific base system of ara::core.

Lifecycle

Creation of an instance of ara::nm::NmErrorDomain takes place via the parameterless default constructor [SWS_ANM_01105]. Since the class is specified as final, further sub-structuring or specialization by derived error domains is explicitly prevented [SWS_ANM_01101]. The constructor is declared with noexcept, guaranteeing that instantiation of the error domain is performed without throwing exceptions [SWS_ANM_01105].

Regarding ownership, an instance of this error domain typically exists as a long-lived global object in memory to be permanently available via references in error code objects. Question Q-27fedf008cefcdc7 (open) An essential feature in the lifecycle is concurrency behavior: Both the construction of instance [SWS_ANM_01105] and all interface functions such as name querying [SWS_ANM_01106], message generation [SWS_ANM_01107], and throwing of exceptions [SWS_ANM_01108] are designed to be fully thread-safe (thread-safe). Since instances of NmErrorDomain possess no mutable state, they can be used concurrently from multiple threads without additional synchronization measures.

Usage Path

The regular usage path begins as soon as an error state in Network Management needs to be analyzed, logged, or converted into an exception. The error domain provides the fundamental identification and evaluation functions for this purpose.

For general identification of the domain, the Name() method can be called, which returns the name of the domain as a constant string pointer [SWS_ANM_01106]. When an application or a basic system needs to determine the textual meaning of an encountered error code, the Message() method is called, passing the error code [SWS_ANM_01107]. This method returns the associated error message as const char* and guarantees through its noexcept declaration that the diagnostic process itself remains exception-safe [SWS_ANM_01107].

If the control flow requires throwing a system-specific exception, the ThrowAsException() method is used [SWS_ANM_01108]. This function accepts an error object of type ara::core::ErrorCode and throws the matching exception of type NmException [SWS_ANM_01104], [SWS_ANM_01108]. In practice, the call is likely to occur primarily indirectly via corresponding helper methods of error objects. Question Q-70e50ac95d89f400 (open)

Sequence diagram: Transformation of a network management error code into a type-specific NmException via the error domain. Sources: [SWS_ANM_01104], [SWS_ANM_01108].

Error Scenarios

In the context of error handling, the domain covers all error cases of the module defined by the enumeration type NmErrc via the alias Errc [SWS_ANM_01103]. The domain itself is designed to safeguard the evaluation of errors deterministically.

When obtaining text messages via Message(), the declaration as noexcept ensures that no unexpected exceptions are thrown even in the case of invalid error codes [SWS_ANM_01107]. The only intended scenario in which the class actively triggers an exception is the explicit call to ThrowAsException() [SWS_ANM_01108]. Via the noexcept(false) declaration, the method signals that it inevitably transfers the program to an exception-handling path by throwing an instance of NmException [SWS_ANM_01104], [SWS_ANM_01108]. Calling components must therefore ensure that such calls are caught by appropriate exception blocks when necessary.