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
EQFABRIC_API	Error (const uint32_t code, const uint128_t &originator=uint128_t())
	Construct a new error. More...
EQFABRIC_API Error &	operator= (const ErrorCode code)
	Assign the given error code. More...
EQFABRIC_API	operator bool_t () const
EQFABRIC_API bool	operator! () const
EQFABRIC_API uint32_t	getCode () const
EQFABRIC_API const uint128_t &	getOriginator () const
EQFABRIC_API bool	operator== (const Error &rhs) const
EQFABRIC_API bool	operator!= (const Error &rhs) const
EQFABRIC_API bool	operator== (const uint32_t code) const
EQFABRIC_API bool	operator!= (const uint32_t code) const
EQFABRIC_API void	serialize (co::DataOStream &os) const
EQFABRIC_API void	deserialize (co::DataIStream &is)

Friends
void	lunchbox::byteswap (Error &value)

Detailed Description

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

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

Constructor & Destructor Documentation

EQFABRIC_API eq::fabric::Error::Error	(	const uint32_t	code,
		const uint128_t &	originator = uint128_t()
	)

Construct a new error.

Version

1.7.1

Member Function Documentation

EQFABRIC_API uint32_t eq::fabric::Error::getCode

(

)

const

Returns

the error code.

Version

1.7.1

EQFABRIC_API const uint128_t& eq::fabric::Error::getOriginator

(

)

const

Returns

the ID of the originator, a co::Object.

Version

1.9

EQFABRIC_API eq::fabric::Error::operator bool_t

(

)

const

Returns

true if an error occured.

Version

1.7.1

EQFABRIC_API bool eq::fabric::Error::operator!

(

)

const

Returns

true if no error occured.

Version

1.7.1

EQFABRIC_API bool eq::fabric::Error::operator!=

(

const Error &

rhs

)

const

Returns

true if the two errors have different values.

Version

1.7.1

EQFABRIC_API bool eq::fabric::Error::operator!=

(

const uint32_t

code

)

const

Returns

true if the two errors have different values.

Version

1.7.1

EQFABRIC_API Error& eq::fabric::Error::operator=

(

const ErrorCode

code

)

Assign the given error code.

Version

1.7.1

EQFABRIC_API bool eq::fabric::Error::operator==

(

const Error &

rhs

)

const

Returns

true if the two errors have the same value.

Version

1.7.1

EQFABRIC_API bool eq::fabric::Error::operator==

(

const uint32_t

code

)

const

Returns

true if the two errors have the same value.

Version

1.7.1

---

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

• fabric/error.h