Equalizer  1.7.3
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Pages
eq::fabric::Error Class Reference

A wrapper for error codes to allow intuitive bool-like usage. More...

#include <error.h>

+ Collaboration diagram for eq::fabric::Error:

Public Member Functions

 Error (const uint32_t code)
 Construct a new error. More...
 
Erroroperator= (const ErrorCode code)
 Assign the given error code. More...
 
 operator bool_t ()
 
bool operator! ()
 
uint32_t getCode () const
 
 operator uint32_t () const
 
bool operator== (const Error &rhs) const
 
bool operator!= (const Error &rhs) const
 
bool operator== (const uint32_t code) const
 
bool operator!= (const uint32_t code) const
 

Detailed Description

A wrapper for error codes to allow intuitive bool-like usage.

Definition at line 105 of file fabric/error.h.

Constructor & Destructor Documentation

eq::fabric::Error::Error ( const uint32_t  code)
inlineexplicit

Construct a new error.

Version
1.7.1

Definition at line 112 of file fabric/error.h.

Member Function Documentation

uint32_t eq::fabric::Error::getCode ( ) const
inline
Returns
the error code.
Version
1.7.1

Definition at line 124 of file fabric/error.h.

eq::fabric::Error::operator bool_t ( )
inline
Returns
true if no error occured.
Version
1.7.1

Definition at line 118 of file fabric/error.h.

eq::fabric::Error::operator uint32_t ( ) const
inline
Returns
the error code.
Version
1.7.1

Definition at line 127 of file fabric/error.h.

bool eq::fabric::Error::operator! ( )
inline
Returns
true if an error occured.
Version
1.7.1

Definition at line 121 of file fabric/error.h.

bool eq::fabric::Error::operator!= ( const Error rhs) const
inline
Returns
true if the two errors have different values.
Version
1.7.1

Definition at line 133 of file fabric/error.h.

bool eq::fabric::Error::operator!= ( const uint32_t  code) const
inline
Returns
true if the two errors have different values.
Version
1.7.1

Definition at line 139 of file fabric/error.h.

Error& eq::fabric::Error::operator= ( const ErrorCode  code)
inline

Assign the given error code.

Version
1.7.1

Definition at line 115 of file fabric/error.h.

bool eq::fabric::Error::operator== ( const Error rhs) const
inline
Returns
true if the two errors have the same value.
Version
1.7.1

Definition at line 130 of file fabric/error.h.

bool eq::fabric::Error::operator== ( const uint32_t  code) const
inline
Returns
true if the two errors have the same value.
Version
1.7.1

Definition at line 136 of file fabric/error.h.


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