C++ API Reference for Intel® Data Analytics Acceleration Library 2020 Update 1

Static Public Member Functions | List of all members
Error Class Reference

Class that represents an error. More...

Static Public Member Functions

static SharedPtr< Errorcreate (ErrorID id)
 

Class Declaration

Constructor & Destructor Documentation

Constructs an error from an identifier

Parameters
[in]idIdentifier of the error
Error ( const Error e)

Copy constructor. Constructs an error from a copy of the content of another error

Parameters
[in]eAnother error to be used as a source with which to initialize the contents of this error
~Error ( )

Destructor

Member Function Documentation

Error& addDetail ( ErrorDetail detail)
protected

Adds a detail into a collection of details associated with this error. This class becomes an owner of the detail

Parameters
[in]detailThe detail
Returns
Reference to this object
Error& addDoubleDetail ( ErrorDetailID  id,
double  value 
)

Adds a floating-point detail into a collection of details associated with this error

Parameters
[in]idIdentifier of the detail
[in]valueValue of the detail
Returns
Reference to this object
Error& addIntDetail ( ErrorDetailID  id,
int  value 
)

Adds an integer detail into a collection of details associated with this error

Parameters
[in]idIdentifier of the detail
[in]valueValue of the detail
Returns
Reference to this object
Error& addStringDetail ( ErrorDetailID  id,
const String value 
)

Adds a string detail into a collection of details associated with this error

Parameters
[in]idIdentifier of the detail
[in]valueValue of the detail
Returns
Reference to this object
static SharedPtr<Error> create ( ErrorID  id)
static

Create an instance of the class with the given arguments

Returns
pointer to the new instance
const char* description ( ) const

Returns the word description of the error

Returns
Description of the error
const ErrorDetail* details ( ) const
inline

Access to error details list

Returns
pointer to the top of error details list
ErrorID id ( ) const
inline

Returns a description of the error

Returns
Identifier of this error
void setId ( ErrorID  id)
inline

Sets an identifier of the error

Parameters
[in]idIdentifier of the error

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

For more complete information about compiler optimizations, see our Optimization Notice.