jevois::ValidValuesSpecRange< T > Class Template Reference

#include <jevois/Component/ValidValuesSpec.H>

template<typename T>
class jevois::ValidValuesSpecRange< T >

Range-based valid values spec, bounds are included.

Definition at line 113 of file ValidValuesSpec.H.

Inheritance diagram for jevois::ValidValuesSpecRange< T >:

Collaboration diagram for jevois::ValidValuesSpecRange< T >:

Public Member Functions
	ValidValuesSpecRange ()=delete
	No default constructor, always need to provide a range.
	ValidValuesSpecRange (Range< T > const &valid_range)
	Construct from a Range of valid values (convention: bounds are inclusive)
virtual	~ValidValuesSpecRange ()
	Destructor.
virtual bool	checkValueValidity (T const &val) const
	Check whether a proposed value is valid, returns true iff value is in our range (bounds included)
virtual std::string const	str () const
	Convert to a readable string: Range:[MIN-MAX] where MIN and MAX are replaced by the actual range bounds.
Public Member Functions inherited from jevois::ValidValuesSpecBase< T >
	ValidValuesSpecBase ()
	Construct, for the base class this is a no-op.
virtual	~ValidValuesSpecBase ()
	Destructor.

Protected Attributes
Range< T > const	itsValidRange
	Our range of valid values.

Constructor & Destructor Documentation

ValidValuesSpecRange() [1/2]

template<typename T >

jevois::ValidValuesSpecRange< T >::ValidValuesSpecRange ( )

delete

No default constructor, always need to provide a range.

ValidValuesSpecRange() [2/2]

template<typename T >

jevois::ValidValuesSpecRange< T >::ValidValuesSpecRange ( Range< T > const &  valid_range )

explicit

Construct from a Range of valid values (convention: bounds are inclusive)

~ValidValuesSpecRange()

template<typename T >

virtual jevois::ValidValuesSpecRange< T >::~ValidValuesSpecRange ( )

virtual

Destructor.

Member Function Documentation

checkValueValidity()

template<typename T >

virtual bool jevois::ValidValuesSpecRange< T >::checkValueValidity ( T const &  val ) const

virtual

Check whether a proposed value is valid, returns true iff value is in our range (bounds included)

Implements jevois::ValidValuesSpecBase< T >.

str()

template<typename T >

virtual std::string const jevois::ValidValuesSpecRange< T >::str ( ) const

virtual

Convert to a readable string: Range:[MIN-MAX] where MIN and MAX are replaced by the actual range bounds.

Implements jevois::ValidValuesSpecBase< T >.

Member Data Documentation

itsValidRange

template<typename T >

Range<T> const jevois::ValidValuesSpecRange< T >::itsValidRange

protected

Our range of valid values.

Definition at line 132 of file ValidValuesSpec.H.

---

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

• include/jevois/Component/ValidValuesSpec.H