a_util::result::detail::IErrorDescription Class Reference

#include <error_description_intf.h>

Inherited by a_util::result::detail::ErrorDescription, and a_util::result::detail::ResultInfoDescription< T, class >.

Public Member Functions
virtual std::int32_t	getErrorCode () const =0
virtual std::int32_t	getLine () const =0
virtual const char *	getErrorDescription () const =0
virtual const char *	getFileName () const =0
virtual const char *	getFunctionName () const =0
virtual const char *	getErrorCodeLabel () const =0

Protected Member Functions
	~IErrorDescription ()
	DTOR.

Detailed Description

The internal interface to ensure binary compatibility of error result descriptions

Warning

This interface must not be changed to ensure binary compatibility!

Member Function Documentation

getErrorCode()

virtual std::int32_t a_util::result::detail::IErrorDescription::getErrorCode ( ) const

pure virtual

Interface method to get the error code.

Returns

Error code.

Implemented in a_util::result::detail::ErrorDescription, and a_util::result::detail::ResultInfoDescription< T, class >.

getErrorCodeLabel()

virtual const char * a_util::result::detail::IErrorDescription::getErrorCodeLabel ( ) const

pure virtual

Interface method to get the error code label.

Returns

Error code as an string object.

Implemented in a_util::result::detail::ErrorDescription, and a_util::result::detail::ResultInfoDescription< T, class >.

getErrorDescription()

virtual const char * a_util::result::detail::IErrorDescription::getErrorDescription ( ) const

pure virtual

Interface method to get the error code as string representation.

Returns

Error code represented as string.

Implemented in a_util::result::detail::ErrorDescription.

getFileName()

virtual const char * a_util::result::detail::IErrorDescription::getFileName ( ) const

pure virtual

Interface method to get the name of the file the error was reported in.

Returns

File name as string.

Implemented in a_util::result::detail::ErrorDescription.

getFunctionName()

virtual const char * a_util::result::detail::IErrorDescription::getFunctionName ( ) const

pure virtual

Interface method to get the name of the function the error was reported in.

Returns

Function name as string.

Implemented in a_util::result::detail::ErrorDescription.

getLine()

virtual std::int32_t a_util::result::detail::IErrorDescription::getLine ( ) const

pure virtual

Interface method to get the line of the source file where the error was reported.

Returns

Line number.

Implemented in a_util::result::detail::ErrorDescription.

---

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

• include/a_util/result/detail/error_description_intf.h