IErrorDescription

The internal interface to ensure binary compatibility of error result descriptions. More...

Inheritance diagram for IErrorDescription:

Public Member Functions
virtual std::int32_t	getErrorCode () const =0
	Interface method to get the error code. More...
virtual std::int32_t	getLine () const =0
	Interface method to get the line of the source file where the error was reported. More...
virtual const char *	getErrorDescription () const =0
	Interface method to get the error code as string representation. More...
virtual const char *	getFileName () const =0
	Interface method to get the name of the file the error was reported in. More...
virtual const char *	getFunctionName () const =0
	Interface method to get the name of the function the error was reported in. More...
virtual const char *	getErrorCodeLabel () const =0
	Interface method to get the error code label. More...

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!

Definition at line 28 of file workspace/conan/dev_essential/1.3.3/dw/stable/package/37682420cd166e229516a41c8d6a139a0b13e1e1/include/a_util/result/detail/error_description_intf.h.

Member Function Documentation

getErrorCode()

virtual std::int32_t getErrorCode ( ) const

pure virtual

Interface method to get the error code.

Returns

Error code.

Implemented in ResultInfoDescription< T, class >, and ErrorDescription.

Referenced by Result::getErrorCode().

getErrorCodeLabel()

virtual const char* getErrorCodeLabel ( ) const

pure virtual

Interface method to get the error code label.

Returns

Error code as an string object.

Implemented in ResultInfoDescription< T, class >, and ErrorDescription.

Referenced by Result::getErrorLabel().

getErrorDescription()

virtual const char* getErrorDescription ( ) const

pure virtual

Interface method to get the error code as string representation.

Returns

Error code represented as string.

Implemented in ResultInfoDescription< T, class >, and ErrorDescription.

Referenced by Result::getDescription().

getFileName()

virtual const char* 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 ResultInfoDescription< T, class >, and ErrorDescription.

Referenced by Result::getFile().

getFunctionName()

virtual const char* 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 ResultInfoDescription< T, class >, and ErrorDescription.

Referenced by Result::getFunction().

getLine()

virtual std::int32_t getLine ( ) const

pure virtual

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

Returns

Line number.

Implemented in ResultInfoDescription< T, class >, and ErrorDescription.

Referenced by Result::getLine().