core_type::ErrorCode Class Reference

Encapsulation of an error code. An ErrorCode contains a raw error code value and an error domain. The raw error code value is specific to this error domain. More...

#include <error_code.h>

Collaboration diagram for core_type::ErrorCode:

Public Member Functions
template<typename EnumT >
	ErrorCode (EnumT e, ErrorDomain::SupportDataType data=ErrorDomain::SupportDataType{}) noexcept
	Construct a new ErrorCode instance with parameters. More...
	ErrorCode (ErrorDomain::CodeType value, ErrorDomain &domain, ErrorDomain::SupportDataType data=ErrorDomain::SupportDataType{}) noexcept
	Construct a new ErrorCode instance with parameters. More...
constexpr ErrorDomain::CodeType	Value () const noexcept
	Return the raw error code value. More...
constexpr const ErrorDomain &	Domain () const noexcept
	Return the domain with which this ErrorCode is associated. More...
constexpr ErrorDomain::SupportDataType	SupportData () const noexcept
	Return the supplementary error context data. More...
std::string_view	Message () noexcept
	Return a textual representation of this ErrorCode. More...

Private Attributes
ErrorDomain::CodeType	code_value_ {}
	Store the domain error code value. More...
ErrorDomain &	domain_
	Store the reference to error domain contained. More...
ErrorDomain::SupportDataType	support_data_ {}
	Store the supported data. More...

Detailed Description

Encapsulation of an error code. An ErrorCode contains a raw error code value and an error domain. The raw error code value is specific to this error domain.

This class is implemented based on API specification of ara::core::ErrorCode from Adaptive Platform Core AUTOSAR AP R21-11

Definition at line 22 of file error_code.h.

Constructor & Destructor Documentation

ErrorCode() [1/2]

template<typename EnumT >

core_type::ErrorCode::ErrorCode ( EnumT  e, ErrorDomain::SupportDataType  data = ErrorDomain::SupportDataType{}  )

explicitnoexcept

Construct a new ErrorCode instance with parameters.

This constructor does not participate in overload resolution unless EnumT is an enum type

Template Parameters

EnumT

An enum type that contains error code values

Parameters

[in]	e	A domain-specific error code value
[in]	data	Optional vendor-specific supplementary error context data

Definition at line 14 of file error_code.cpp.

                                                                      : code_value_{e},
                                                                            support_data_{data} {}

ErrorCode() [2/2]

core_type::ErrorCode::ErrorCode ( ErrorDomain::CodeType  value, ErrorDomain &  domain, ErrorDomain::SupportDataType  data = ErrorDomain::SupportDataType{}  )

noexcept

Construct a new ErrorCode instance with parameters.

Template Parameters

EnumT

An enum type that contains error code values

Parameters

[in]	value	A domain-specific error code value
[in]	domain	The ErrorDomain associated with value
[in]	data	Optional vendor-specific supplementary error context data

Definition at line 17 of file error_code.cpp.

    : code_value_{value},
      domain_{domain},
      support_data_{data} {}

Member Function Documentation

Domain()

constexpr const ErrorDomain & core_type::ErrorCode::Domain ( ) const

constexprnoexcept

Return the domain with which this ErrorCode is associated.

Returns

The reference to error domain

Definition at line 24 of file error_code.cpp.

{ return domain_; }

References domain_.

Message()

std::string_view core_type::ErrorCode::Message ( )

noexcept

Return a textual representation of this ErrorCode.

Returns

The error message

Definition at line 28 of file error_code.cpp.

{ return std::string_view{domain_.Message(code_value_)}; }

References code_value_, domain_, and core_type::ErrorDomain::Message().

Here is the call graph for this function:

SupportData()

constexpr ErrorDomain::SupportDataType core_type::ErrorCode::SupportData ( ) const

constexprnoexcept

Return the supplementary error context data.

The underlying type and the meaning of the returned value are implementation-defined

Returns

The support data type

Definition at line 26 of file error_code.cpp.

{ return support_data_; }

References support_data_.

Value()

constexpr ErrorDomain::CodeType core_type::ErrorCode::Value ( ) const

constexprnoexcept

Return the raw error code value.

Returns

The raw code value

Definition at line 22 of file error_code.cpp.

{ return code_value_; }

References code_value_.

Member Data Documentation

code_value_

ErrorDomain::CodeType core_type::ErrorCode::code_value_ {}

private

Store the domain error code value.

Definition at line 80 of file error_code.h.

Referenced by Message(), and Value().

domain_

ErrorDomain& core_type::ErrorCode::domain_

private

Store the reference to error domain contained.

Definition at line 85 of file error_code.h.

Referenced by Domain(), and Message().

support_data_

ErrorDomain::SupportDataType core_type::ErrorCode::support_data_ {}

private

Store the supported data.

Definition at line 90 of file error_code.h.

Referenced by SupportData().

---

The documentation for this class was generated from the following files:

• /home/runner/work/diag-client-lib/diag-client-lib/diag-client-lib/lib/platform-core/core/include/error_code.h
• /home/runner/work/diag-client-lib/diag-client-lib/diag-client-lib/lib/platform-core/core/src/error_code.cpp