argos::CRange< T > Class Template Reference

#include <range.h>

Public Member Functions
	CRange (const T &t_min=T(), const T &t_max=T())
T	GetMin () const
void	SetMin (const T &t_min)
T	GetMax () const
void	SetMax (const T &t_max)
T	GetSpan () const
void	Set (const T &t_min, const T &t_max)
bool	WithinMinBoundIncludedMaxBoundIncluded (const T &t_value) const
bool	WithinMinBoundIncludedMaxBoundExcluded (const T &t_value) const
bool	WithinMinBoundExcludedMaxBoundIncluded (const T &t_value) const
bool	WithinMinBoundExcludedMaxBoundExcluded (const T &t_value) const
void	TruncValue (T &t_value) const
Real	NormalizeValue (const T &t_value) const
template<typename U >
void	MapValueIntoRange (U &t_output_value, const T &t_input_value, const CRange< U > &c_range) const
void	WrapValue (T &t_value) const

Friends
std::ostream &	operator<< (std::ostream &os, const CRange &c_range)
std::istream &	operator>> (std::istream &is, CRange &c_range)

Detailed Description

template<typename T>
class argos::CRange< T >

Definition at line 17 of file range.h.

Constructor & Destructor Documentation

CRange()

template<typename T>

argos::CRange< T >::CRange ( const T &  t_min = T(), const T &  t_max = T()  )

inline

Definition at line 21 of file range.h.

Member Function Documentation

GetMax()

template<typename T>

T argos::CRange< T >::GetMax ( ) const

inline

Definition at line 48 of file range.h.

GetMin()

template<typename T>

T argos::CRange< T >::GetMin ( ) const

inline

Definition at line 32 of file range.h.

GetSpan()

template<typename T>

T argos::CRange< T >::GetSpan ( ) const

inline

Definition at line 64 of file range.h.

MapValueIntoRange()

template<typename T>

template<typename U >

void argos::CRange< T >::MapValueIntoRange ( U &  t_output_value, const T &  t_input_value, const CRange< U > &  c_range  ) const

inline

Definition at line 109 of file range.h.

NormalizeValue()

template<typename T>

Real argos::CRange< T >::NormalizeValue ( const T &  t_value ) const

inline

Definition at line 102 of file range.h.

Set()

template<typename T>

void argos::CRange< T >::Set ( const T &  t_min, const T &  t_max  )

inline

Definition at line 68 of file range.h.

SetMax()

template<typename T>

void argos::CRange< T >::SetMax ( const T &  t_max )

inline

Definition at line 52 of file range.h.

SetMin()

template<typename T>

void argos::CRange< T >::SetMin ( const T &  t_min )

inline

Definition at line 36 of file range.h.

TruncValue()

template<typename T>

void argos::CRange< T >::TruncValue ( T &  t_value ) const

inline

Definition at line 97 of file range.h.

WithinMinBoundExcludedMaxBoundExcluded()

template<typename T>

bool argos::CRange< T >::WithinMinBoundExcludedMaxBoundExcluded ( const T &  t_value ) const

inline

Definition at line 93 of file range.h.

WithinMinBoundExcludedMaxBoundIncluded()

template<typename T>

bool argos::CRange< T >::WithinMinBoundExcludedMaxBoundIncluded ( const T &  t_value ) const

inline

Definition at line 89 of file range.h.

WithinMinBoundIncludedMaxBoundExcluded()

template<typename T>

bool argos::CRange< T >::WithinMinBoundIncludedMaxBoundExcluded ( const T &  t_value ) const

inline

Definition at line 85 of file range.h.

WithinMinBoundIncludedMaxBoundIncluded()

template<typename T>

bool argos::CRange< T >::WithinMinBoundIncludedMaxBoundIncluded ( const T &  t_value ) const

inline

Definition at line 81 of file range.h.

WrapValue()

template<typename T>

void argos::CRange< T >::WrapValue ( T &  t_value ) const

inline

Definition at line 116 of file range.h.

Friends And Related Function Documentation

operator<<

template<typename T>

std::ostream& operator<< ( std::ostream &  os, const CRange< T > &  c_range  )

friend

Definition at line 121 of file range.h.

operator>>

template<typename T>

std::istream& operator>> ( std::istream &  is, CRange< T > &  c_range  )

friend

Definition at line 128 of file range.h.