jevois::ValidValuesSpecStepRange< T > Class Template Reference

#include <jevois/Component/ValidValuesSpec.H>

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

StepRange-based valid values spec, bounds are included.

Definition at line 138 of file ValidValuesSpec.H.

Inheritance diagram for jevois::ValidValuesSpecStepRange< T >:

Collaboration diagram for jevois::ValidValuesSpecStepRange< T >:

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

Protected Attributes
const StepRange< T >	itsValidStepRange
	Our step-range of valid values. More...

Constructor & Destructor Documentation

ValidValuesSpecStepRange() [1/2]

template<typename T >

jevois::ValidValuesSpecStepRange< T >::ValidValuesSpecStepRange ( )

delete

No default constructor, always need to provide a range.

ValidValuesSpecStepRange() [2/2]

template<typename T >

jevois::ValidValuesSpecStepRange< T >::ValidValuesSpecStepRange ( StepRange< T > const &  valid_range )

explicit

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

~ValidValuesSpecStepRange()

template<typename T >

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

virtual

Destructor.

Member Function Documentation

checkValueValidity()

template<typename T >

virtual bool jevois::ValidValuesSpecStepRange< 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 const std::string jevois::ValidValuesSpecStepRange< T >::str ( ) const

virtual

Convert to a readable string: StepRange:[MIN-STEP-MAX] where MIN, STEP and MAX are replaced by actual values.

Implements jevois::ValidValuesSpecBase< T >.

Member Data Documentation

itsValidStepRange

template<typename T >

const StepRange<T> jevois::ValidValuesSpecStepRange< T >::itsValidStepRange

protected

Our step-range of valid values.

Definition at line 157 of file ValidValuesSpec.H.

---

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

• include/jevois/Component/ValidValuesSpec.H