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

List of all members
Status Class Reference

Class that holds the results of API calls. In case of API routine failure it contains the list of errors describing problems API encountered. More...

Class Declaration

Constructor & Destructor Documentation

Status ( )
inline

Default constructor

Status ( ErrorID  id)

Constructs an object containing given error

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

Constructs an object containing given error

Parameters
[in]ethe error
Status ( const Status other)

Copy constructor

~Status ( )

Destructor

DAAL_DEPRECATED Status ( const KernelErrorCollection e)
Deprecated:
This item will be removed in a future release.
DAAL_DEPRECATED Status ( const ErrorCollection e)
Deprecated:
This item will be removed in a future release.

Member Function Documentation

Status& add ( ErrorID  id)

Adds an error to the object

Parameters
[in]idIdentifier of the error
Returns
Reference to this object
Status& add ( const ErrorPtr e)

Adds an error to the object

Parameters
[in]ethe error
Returns
Reference to this object
Status& add ( const Status other)

Adds another status to this object

Parameters
[in]otherthe status to add
Returns
Reference to this object
void clear ( )

Clear all errors contained in this object

Returns
Description of all errors contained in the object
ErrorCollectionPtr getCollection ( ) const
Deprecated:
This item will be removed in a future release.
const char* getDescription ( ) const

Returns description of all errors contained in the object

Returns
Description of all errors contained in the object
bool ok ( ) const
inline

Checks that the object doesn't contain errors

Returns
true if no errors false otherwise
operator bool ( ) const
inline

Checks that the object doesn't contain errors

Returns
true if no errors false otherwise
Status& operator= ( const Status other)

Assignment oerator

Parameters
[in]otherthe status to assign
Returns
Reference to this object
Status& operator|= ( const Status other)
inline

Operator, adds another status to this object

Parameters
[in]otherthe status to add
Returns
Reference to this object

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

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