LSST::M1M3::SS::Range Class Reference

Utility range checking functions. More...

#include <Range.h>

Static Public Member Functions
template<typename T >
static bool	InRange (T min, T max, T value)
	Template function to check if a value is inside a given range.
template<typename T >
static T	CoerceIntoRange (T min, T max, T value)
template<typename T >
static bool	InRangeAndCoerce (T min, T max, T value, T *output)
template<typename T , typename... TArgs>
static bool	InRangeTrigger (T min, T max, T value, LimitTrigger< TArgs... > &limitTrigger, TArgs... lArgs)
	Tests if value is in given range.

Detailed Description

Utility range checking functions.

Member Function Documentation

InRange()

template<typename T >

static bool LSST::M1M3::SS::Range::InRange ( T min, T max, T value )

inlinestatic

Template function to check if a value is inside a given range.

Template Parameters

T	value type. All parameters shall have the same type.

Parameters

min	range minimal value
max	range maximal value
value	value to test

Returns

true if value >= min and value <= max

Here is the caller graph for this function:

InRangeTrigger()

template<typename T , typename... TArgs>

static bool LSST::M1M3::SS::Range::InRangeTrigger ( T min, T max, T value, LimitTrigger< TArgs... > & limitTrigger, TArgs... lArgs )

inlinestatic

Tests if value is in given range.

Fires LimitTrigger if conditions aren't met. Reset LimitTrigger if conditions returned back to normal.

Template Parameters

T	test value type
TArgs	variadic arguments for LimitTrigger

Parameters

min	range minimal value
max	range maximal value
value	test value
limitTrigger	LimitTrigger subclass to report problems with range
lArgs	LimitTrigger arguments

Returns

true if value >= min and value <= max

Here is the call graph for this function:

Here is the caller graph for this function:

---

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

• Utility/Range.h