a_util::result::detail::ErrorDescription Class Reference

#include <error_description.h>

Inherits a_util::result::detail::IErrorDescription.

Public Member Functions
	ErrorDescription (const ErrorDescription &)=delete
ErrorDescription &	operator= (const ErrorDescription &)=delete
	ErrorDescription (ErrorDescription &&)=delete
ErrorDescription &	operator= (ErrorDescription &&)=delete
	~ErrorDescription ()=default
	DTOR.
	ErrorDescription (std::int32_t error_code, const char *error_description, std::int32_t line, const char *file, const char *function, const char *error_label)
	Construct error description object with complete set of error information.
std::int32_t	getErrorCode () const
	Get error code.
std::int32_t	getLine () const
	Get line in source file where the error was reported.
const char *	getErrorDescription () const
	Get error code as string representation.
const char *	getFileName () const
	Get name of the file the error was reported in.
const char *	getFunctionName () const
	Get name of the function the error was reported in.
const char *	getErrorCodeLabel () const
	Get error code label.

Additional Inherited Members
Protected Member Functions inherited from a_util::result::detail::IErrorDescription
	~IErrorDescription ()
	DTOR.

Detailed Description

Implements the error description interface for heap allocated error cases

Constructor & Destructor Documentation

ErrorDescription()

a_util::result::detail::ErrorDescription::ErrorDescription ( std::int32_t error_code, const char * error_description, std::int32_t line, const char * file, const char * function, const char * error_label )

inline

Construct error description object with complete set of error information.

Template Parameters

ErrorCode

Error code (to deduce specialized template to stringify the error code)

Parameters

[in]	error_code	The The concrete error object
[in]	error_description	Complete description of the error
[in]	line	Line in source file the error was reported (default: -1)
[in]	file	Source file the error was reported in
[in]	function	Function the error was reported in
[in]	error_label	The error code as an string object

Member Function Documentation

getErrorCode()

std::int32_t a_util::result::detail::ErrorDescription::getErrorCode ( ) const

inlinevirtual

Get error code.

Returns

Error code.

Implements a_util::result::detail::IErrorDescription.

getErrorCodeLabel()

const char * a_util::result::detail::ErrorDescription::getErrorCodeLabel ( ) const

inlinevirtual

Get error code label.

Returns

Error code as an string object.

Implements a_util::result::detail::IErrorDescription.

getErrorDescription()

const char * a_util::result::detail::ErrorDescription::getErrorDescription ( ) const

inlinevirtual

Get error code as string representation.

Returns

Error code represented as string.

Implements a_util::result::detail::IErrorDescription.

getFileName()

const char * a_util::result::detail::ErrorDescription::getFileName ( ) const

inlinevirtual

Get name of the file the error was reported in.

Returns

File name as string.

Implements a_util::result::detail::IErrorDescription.

getFunctionName()

const char * a_util::result::detail::ErrorDescription::getFunctionName ( ) const

inlinevirtual

Get name of the function the error was reported in.

Returns

Function name as string.

Implements a_util::result::detail::IErrorDescription.

getLine()

std::int32_t a_util::result::detail::ErrorDescription::getLine ( ) const

inlinevirtual

Get line in source file where the error was reported.

Returns

Line number.

Implements a_util::result::detail::IErrorDescription.

---

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

• include/a_util/result/detail/error_description.h
• include/a_util/result/detail/error_description_impl.h