ValidifiedResult< TYPE > Class Template Reference

Validified result. More...

#include <base/ValidifiedResult.h>

Inherits AutomationObject.

Public Member Functions
	ValidifiedResult ()
	ValidifiedResult (Unspecified)
	ValidifiedResult (const TYPE &_value, bool _valid=true)
	ValidifiedResult (const ValidifiedResult &copy)
	ValidifiedResult (ValidifiedResult &&move)
ValidifiedResult &	operator= (const ValidifiedResult &assign)
ValidifiedResult &	operator= (ValidifiedResult &&move)
const TYPE &	getValue () const
const TYPE &	getValue (const TYPE &defaultValue) const noexcept
bool	isValid () const noexcept
bool	isInvalid () const noexcept
FormatOutputStream &	operator<< (FormatOutputStream &stream) const
	operator const TYPE & () const

Detailed Description

template<class TYPE>
class ValidifiedResult< TYPE >

Validified result.

Automation object used to specify the validity of a result if the type of the result is not able to represent an invalid condition.

Version

1.0

Constructor & Destructor Documentation

ValidifiedResult() [1/5]

template<class TYPE >

ValidifiedResult< TYPE >::ValidifiedResult ( )

inline

Initializes object as invalid.

ValidifiedResult() [2/5]

template<class TYPE >

ValidifiedResult< TYPE >::ValidifiedResult ( Unspecified  )

inline

Initializes object as invalid.

ValidifiedResult() [3/5]

template<class TYPE >

ValidifiedResult< TYPE >::ValidifiedResult ( const TYPE &  _value, bool  _valid = true  )

inline

Initializes object as valid.

ValidifiedResult() [4/5]

template<class TYPE >

ValidifiedResult< TYPE >::ValidifiedResult ( const ValidifiedResult< TYPE > &  copy )

inline

Initializes object by other object.

ValidifiedResult() [5/5]

template<class TYPE >

ValidifiedResult< TYPE >::ValidifiedResult ( ValidifiedResult< TYPE > &&  move )

inline

Initializes object by other object.

Member Function Documentation

getValue() [1/2]

template<class TYPE >

const TYPE& ValidifiedResult< TYPE >::getValue ( ) const

inline

Returns the value. Raises InvalidException if result is invalid.

getValue() [2/2]

template<class TYPE >

const TYPE& ValidifiedResult< TYPE >::getValue ( const TYPE &  defaultValue ) const

inlinenoexcept

Returns the value if valid and otherwise the given defaultValue.

isInvalid()

template<class TYPE >

bool ValidifiedResult< TYPE >::isInvalid ( ) const

inlinenoexcept

Returns true if the result is invalid.

isValid()

template<class TYPE >

bool ValidifiedResult< TYPE >::isValid ( ) const

inlinenoexcept

Returns true if the result is valid.

operator=() [1/2]

template<class TYPE >

ValidifiedResult& ValidifiedResult< TYPE >::operator= ( const ValidifiedResult< TYPE > &  assign )

inline

Initializes object by other object.

operator=() [2/2]

template<class TYPE >

ValidifiedResult& ValidifiedResult< TYPE >::operator= ( ValidifiedResult< TYPE > &&  move )

inline

Initializes object by other object.