Woman, Life, Freedom


Adaptive AUTOSAR
ARA public interface header documentation
ara::diag::DiagErrorDomain Class Referencefinal

Diagnostic Management error domain. More...

#include <diag_error_domain.h>

Inheritance diagram for ara::diag::DiagErrorDomain:
ara::core::ErrorDomain

Public Member Functions

 DiagErrorDomain (DiagErrorDomain &other)=delete
 
void operator= (const DiagErrorDomain &)=delete
 
const char * Name () const noexcept override
 Get the domain's name. More...
 
const char * Message (ara::core::ErrorDomain::CodeType errorCode) const noexcept override
 Get error message of a specific error code. More...
 
ara::core::ErrorCode MakeErrorCode (DiagErrc code) noexcept
 Make an error code based on the given giagnostic error type. More...
 
- Public Member Functions inherited from ara::core::ErrorDomain
constexpr ErrorDomain (IdType id) noexcept
 Constructor. More...
 
 ErrorDomain (const ErrorDomain &)=delete
 
 ErrorDomain (ErrorDomain &&)=delete
 
ErrorDomainoperator= (const ErrorDomain &)=delete
 
ErrorDomainoperator= (ErrorDomain &&)=delete
 
constexpr bool operator== (const ErrorDomain &other) const noexcept
 
constexpr bool operator!= (const ErrorDomain &other) const noexcept
 
constexpr IdType Id () const noexcept
 Get the domain ID. More...
 

Static Public Member Functions

static ara::core::ErrorDomainGetDiagDomain ()
 Get the global diagnostic error domain. More...
 

Additional Inherited Members

- Public Types inherited from ara::core::ErrorDomain
using IdType = uint64_t
 Alias type of the domain ID.
 
using CodeType = uint32_t
 Alias type of the error code.
 

Detailed Description

Diagnostic Management error domain.

Note
The class is not fully aligned with ARA standard.

Member Function Documentation

◆ GetDiagDomain()

ara::core::ErrorDomain * ara::diag::DiagErrorDomain::GetDiagDomain ( )
static

Get the global diagnostic error domain.

Returns
Pointer to the singleton diagnostic error domain
Note
The signature does not match with ARA standard.

◆ MakeErrorCode()

ara::core::ErrorCode ara::diag::DiagErrorDomain::MakeErrorCode ( DiagErrc  code)
noexcept

Make an error code based on the given giagnostic error type.

Parameters
codeDiagnostic error code input
Returns
Created error code
Note
Vendor specific data is not supported.

◆ Message()

const char * ara::diag::DiagErrorDomain::Message ( ara::core::ErrorDomain::CodeType  errorCode) const
overridevirtualnoexcept

Get error message of a specific error code.

Parameters
errorCodeError code of interest
Returns
Error code message in this domain

Implements ara::core::ErrorDomain.

◆ Name()

const char * ara::diag::DiagErrorDomain::Name ( ) const
overridevirtualnoexcept

Get the domain's name.

Returns
Error domain name

Implements ara::core::ErrorDomain.