hwdet::CheckedResult< T > Class Template Reference

Provides means to return two values from function - call status and return value. More...

#include <CheckedResult.h>

Public Member Functions
	CheckedResult (bool call_success, const T &retval)
	Constructor.
	CheckedResult (bool call_success=false)
	Constructor.
	CheckedResult (const CheckedResult &r1)
	Copy constructor.
	~CheckedResult (void)
	Destructor.
bool	Succeeded (void) const
	Test whether call succeded or not.
bool	Failed (void) const
	Test whether call failed or not.
T &	GetValue (void) const
	Get function return value.
Private Attributes
bool	successfull
	< Was call successfull? Return value.
T	value

---

Detailed Description

template<typename T>
class hwdet::CheckedResult< T >

Provides means to return two values from function - call status and return value.

This class is provided to simplify work with function which return two values. One of values is always error state and the other one is return value.

---

Constructor & Destructor Documentation

template<typename T>

hwdet::CheckedResult< T >::CheckedResult	(	bool	call_success,
		const T &	retval
	)			[inline]

Constructor.

Parameters:

	call_success	true if call to function wass successfull, false otherwise.
	retval	Return value of the function.

template<typename T>

hwdet::CheckedResult< T >::CheckedResult

(

bool

call_success = false

)

[inline]

Constructor.

This ctor should be used to report call failuers since it does not require any value.

Parameters:

call_success

true if call to function wass successfull, false otherwise.

template<typename T>

hwdet::CheckedResult< T >::CheckedResult

(

const CheckedResult< T > &

r1

)

[inline]

Copy constructor.

Parameters:

r1

Result to be copied to this.

template<typename T>

hwdet::CheckedResult< T >::~CheckedResult

(

void

)

[inline]

Destructor.

---

Member Function Documentation

template<typename T>

bool hwdet::CheckedResult< T >::Failed

(

void

)

const [inline]

Test whether call failed or not.

Returns:

true if call failed, true otherwise.

template<typename T>

T& hwdet::CheckedResult< T >::GetValue

(

void

)

const [inline]

Get function return value.

Returns:

Value.

template<typename T>

bool hwdet::CheckedResult< T >::Succeeded

(

void

)

const [inline]

Test whether call succeded or not.

Returns:

true if call succeded, false otherwise.

---

Field Documentation

template<typename T>

bool hwdet::CheckedResult< T >::successfull [private]

< Was call successfull? Return value.

template<typename T>

T hwdet::CheckedResult< T >::value [private]

---

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

• CheckedResult.h

---