Result Class Reference

Class describing a result of an operation. More...

#include <Result.hh>

Public Member Functions
	Result ()
	Default constructor.
	Result (const Result &_result)
	Copy constructor.
	Result (const ResultType _type)
	Constructor.
	Result (Result &&_result) noexcept
	Move constructor.
virtual	~Result ()
	Destructor.
virtual	operator bool () const
	Operator bool returns true if operation was successful.
Result &	operator= (const Result &_result)
	Copy assignment operator.
Result &	operator= (Result &&_result) noexcept
	Move assignment operator.
virtual std::string	ReadableResult () const
	Get human readable result string.
ResultType	Type () const
	Get the type of result.

Detailed Description

Class describing a result of an operation.

Constructor & Destructor Documentation

Result() [1/4]

Result

(

)

Default constructor.

~Result()

virtual ~Result ( )

virtual

Destructor.

Result() [2/4]

Result ( const ResultType  _type )

explicit

Constructor.

Parameters

[in]

_type

Result type

Result() [3/4]

Result

(

const Result &

_result

)

Copy constructor.

Parameters

[in]

_result

Result to copy.

Result() [4/4]

Result ( Result &&  _result )

noexcept

Move constructor.

Parameters

[in]

_result

Result to move.

Member Function Documentation

operator bool()

virtual operator bool ( ) const

virtual

Operator bool returns true if operation was successful.

Returns

True if the operation was successful.

operator=() [1/2]

Result & operator=

(

const Result &

_result

)

Copy assignment operator.

Parameters

[in]

_result

Result to copy.

operator=() [2/2]

Result & operator= ( Result &&  _result )

noexcept

Move assignment operator.

Parameters

[in]

_result

Result component to move.

Returns

Reference to this.

ReadableResult()

virtual std::string ReadableResult ( ) const

virtual

Get human readable result string.

Returns

The result string.

Type()

ResultType Type

(

)

const

Get the type of result.

Returns

The type of result.

---

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

• Result.hh