OpenWareLaboratory
Public Member Functions | Static Public Member Functions | Data Fields | Static Public Attributes | Protected Attributes
StiffValue< T, Value > Class Template Reference

Applies simple hysteresis to a scalar. More...

Inheritance diagram for StiffValue< T, Value >:
Inheritance graph
[legend]
Collaboration diagram for StiffValue< T, Value >:
Collaboration graph
[legend]

Public Member Functions

const float DEFAULT_DELTA
 
const int DEFAULT_DELTA
 
const float DEFAULT_DELTA
 
const int DEFAULT_DELTA
 
const float DEFAULT_EXP_C
 
const int DEFAULT_EXP_C
 
const float DEFAULT_EXP_C
 
const int DEFAULT_EXP_C
 
const float DEFAULT_EXP_K
 
const int DEFAULT_EXP_K
 
const float DEFAULT_EXP_K
 
const int DEFAULT_EXP_K
 
const float DEFAULT_LAMBDA
 
const int DEFAULT_LAMBDA
 
const float DEFAULT_LAMBDA
 
const int DEFAULT_LAMBDA
 
const float DEFAULT_LOG_C
 
const int DEFAULT_LOG_C
 
const float DEFAULT_LOG_C
 
const int DEFAULT_LOG_C
 
const float DEFAULT_LOG_K
 
const int DEFAULT_LOG_K
 
const float DEFAULT_LOG_K
 
const int DEFAULT_LOG_K
 
T get ()
 
 operator T ()
 
StiffValue< T, Value > & operator*= (const T &other)
 
StiffValue< T, Value > & operator+= (const T &other)
 
StiffValue< T, Value > & operator-= (const T &other)
 
StiffValue< T, Value > & operator/= (const T &other)
 
StiffValue< T, Value > & operator= (const T &other)
 
void reset (T x)
 
 StiffValue ()
 
 StiffValue (const StiffValue< T, Value > &other)
 
 StiffValue (T delta, T init)
 
 StiffValue (T value)
 
void update (T newValue)
 

Static Public Member Functions

static T normal (float delta)
 

Data Fields

T delta = Value::DEFAULT_DELTA
 

Static Public Attributes

static const T DEFAULT_DELTA
 
static const T DEFAULT_EXP_C
 
static const T DEFAULT_EXP_K
 
static const T DEFAULT_LAMBDA
 
static const T DEFAULT_LOG_C
 
static const T DEFAULT_LOG_K
 

Protected Attributes

T value
 

Detailed Description

template<typename T, typename Value = SimpleValue<T>>
class StiffValue< T, Value >

Applies simple hysteresis to a scalar.

Only updates the value if the absolute difference is greater than delta

Definition at line 61 of file SmoothValue.h.

Constructor & Destructor Documentation

◆ StiffValue() [1/4]

template<typename T , typename Value = SimpleValue<T>>
StiffValue< T, Value >::StiffValue ( )
inline

Definition at line 64 of file SmoothValue.h.

◆ StiffValue() [2/4]

template<typename T , typename Value = SimpleValue<T>>
StiffValue< T, Value >::StiffValue ( T  value)
inline

Definition at line 65 of file SmoothValue.h.

◆ StiffValue() [3/4]

template<typename T , typename Value = SimpleValue<T>>
StiffValue< T, Value >::StiffValue ( T  delta,
T  init 
)
inline

Definition at line 66 of file SmoothValue.h.

◆ StiffValue() [4/4]

template<typename T , typename Value = SimpleValue<T>>
StiffValue< T, Value >::StiffValue ( const StiffValue< T, Value > &  other)
inline

Definition at line 67 of file SmoothValue.h.

Member Function Documentation

◆ DEFAULT_DELTA() [1/4]

const float SimpleValue< float >::DEFAULT_DELTA
inherited

Definition at line 11 of file SimpleValue.cpp.

◆ DEFAULT_DELTA() [2/4]

const int SimpleValue< int >::DEFAULT_DELTA
inherited

Definition at line 17 of file SimpleValue.cpp.

◆ DEFAULT_DELTA() [3/4]

const float SimpleValue< float >::DEFAULT_DELTA
inherited

Definition at line 61 of file SimpleValue.h.

◆ DEFAULT_DELTA() [4/4]

const int SimpleValue< int >::DEFAULT_DELTA
inherited

Definition at line 67 of file SimpleValue.h.

◆ DEFAULT_EXP_C() [1/4]

const float SimpleValue< float >::DEFAULT_EXP_C
inherited

Definition at line 12 of file SimpleValue.cpp.

◆ DEFAULT_EXP_C() [2/4]

const int SimpleValue< int >::DEFAULT_EXP_C
inherited

Definition at line 18 of file SimpleValue.cpp.

◆ DEFAULT_EXP_C() [3/4]

const float SimpleValue< float >::DEFAULT_EXP_C
inherited

Definition at line 62 of file SimpleValue.h.

◆ DEFAULT_EXP_C() [4/4]

const int SimpleValue< int >::DEFAULT_EXP_C
inherited

Definition at line 68 of file SimpleValue.h.

◆ DEFAULT_EXP_K() [1/4]

const float SimpleValue< float >::DEFAULT_EXP_K
inherited

Definition at line 13 of file SimpleValue.cpp.

◆ DEFAULT_EXP_K() [2/4]

const int SimpleValue< int >::DEFAULT_EXP_K
inherited

Definition at line 19 of file SimpleValue.cpp.

◆ DEFAULT_EXP_K() [3/4]

const float SimpleValue< float >::DEFAULT_EXP_K
inherited

Definition at line 63 of file SimpleValue.h.

◆ DEFAULT_EXP_K() [4/4]

const int SimpleValue< int >::DEFAULT_EXP_K
inherited

Definition at line 69 of file SimpleValue.h.

◆ DEFAULT_LAMBDA() [1/4]

const float SimpleValue< float >::DEFAULT_LAMBDA
inherited

Definition at line 10 of file SimpleValue.cpp.

◆ DEFAULT_LAMBDA() [2/4]

const int SimpleValue< int >::DEFAULT_LAMBDA
inherited

Definition at line 16 of file SimpleValue.cpp.

◆ DEFAULT_LAMBDA() [3/4]

const float SimpleValue< float >::DEFAULT_LAMBDA
inherited

Definition at line 60 of file SimpleValue.h.

◆ DEFAULT_LAMBDA() [4/4]

const int SimpleValue< int >::DEFAULT_LAMBDA
inherited

Definition at line 66 of file SimpleValue.h.

◆ DEFAULT_LOG_C() [1/4]

const float SimpleValue< float >::DEFAULT_LOG_C
inherited

Definition at line 14 of file SimpleValue.cpp.

◆ DEFAULT_LOG_C() [2/4]

const int SimpleValue< int >::DEFAULT_LOG_C
inherited

Definition at line 20 of file SimpleValue.cpp.

◆ DEFAULT_LOG_C() [3/4]

const float SimpleValue< float >::DEFAULT_LOG_C
inherited

Definition at line 64 of file SimpleValue.h.

◆ DEFAULT_LOG_C() [4/4]

const int SimpleValue< int >::DEFAULT_LOG_C
inherited

Definition at line 70 of file SimpleValue.h.

◆ DEFAULT_LOG_K() [1/4]

const float SimpleValue< float >::DEFAULT_LOG_K
inherited

Definition at line 15 of file SimpleValue.cpp.

◆ DEFAULT_LOG_K() [2/4]

const int SimpleValue< int >::DEFAULT_LOG_K
inherited

Definition at line 21 of file SimpleValue.cpp.

◆ DEFAULT_LOG_K() [3/4]

const float SimpleValue< float >::DEFAULT_LOG_K
inherited

Definition at line 65 of file SimpleValue.h.

◆ DEFAULT_LOG_K() [4/4]

const int SimpleValue< int >::DEFAULT_LOG_K
inherited

Definition at line 71 of file SimpleValue.h.

◆ get()

template<typename T >
T SimpleValue< T >::get ( )
inlineinherited

Definition at line 19 of file SimpleValue.h.

References SimpleValue< T >::value.

Referenced by SimpleValue< T >::operator T().

◆ normal()

template<typename T , typename Value = SimpleValue<T>>
static T StiffValue< T, Value >::normal ( float  delta)
static

◆ operator T()

template<typename T , typename Value = SimpleValue<T>>
StiffValue< T, Value >::operator T ( )
inline

Definition at line 92 of file SmoothValue.h.

◆ operator*=()

template<typename T , typename Value = SimpleValue<T>>
StiffValue<T, Value>& StiffValue< T, Value >::operator*= ( const T &  other)
inline

Definition at line 84 of file SmoothValue.h.

◆ operator+=()

template<typename T , typename Value = SimpleValue<T>>
StiffValue<T, Value>& StiffValue< T, Value >::operator+= ( const T &  other)
inline

Definition at line 76 of file SmoothValue.h.

◆ operator-=()

template<typename T , typename Value = SimpleValue<T>>
StiffValue<T, Value>& StiffValue< T, Value >::operator-= ( const T &  other)
inline

Definition at line 80 of file SmoothValue.h.

◆ operator/=()

template<typename T , typename Value = SimpleValue<T>>
StiffValue<T, Value>& StiffValue< T, Value >::operator/= ( const T &  other)
inline

Definition at line 88 of file SmoothValue.h.

◆ operator=()

template<typename T , typename Value = SimpleValue<T>>
StiffValue<T, Value>& StiffValue< T, Value >::operator= ( const T &  other)
inline

Definition at line 72 of file SmoothValue.h.

◆ reset()

template<typename T >
void SimpleValue< T >::reset ( T  x)
inlineinherited

Definition at line 22 of file SimpleValue.h.

References SimpleValue< T >::value.

◆ update()

template<typename T , typename Value = SimpleValue<T>>
void StiffValue< T, Value >::update ( T  newValue)
inline

Definition at line 68 of file SmoothValue.h.

References abs.

Field Documentation

◆ DEFAULT_DELTA

template<typename T >
const T SimpleValue< T >::DEFAULT_DELTA
staticinherited

Definition at line 52 of file SimpleValue.h.

◆ DEFAULT_EXP_C

template<typename T >
const T SimpleValue< T >::DEFAULT_EXP_C
staticinherited

Definition at line 53 of file SimpleValue.h.

◆ DEFAULT_EXP_K

template<typename T >
const T SimpleValue< T >::DEFAULT_EXP_K
staticinherited

Definition at line 54 of file SimpleValue.h.

◆ DEFAULT_LAMBDA

template<typename T >
const T SimpleValue< T >::DEFAULT_LAMBDA
staticinherited

Definition at line 51 of file SimpleValue.h.

◆ DEFAULT_LOG_C

template<typename T >
const T SimpleValue< T >::DEFAULT_LOG_C
staticinherited

Definition at line 55 of file SimpleValue.h.

◆ DEFAULT_LOG_K

template<typename T >
const T SimpleValue< T >::DEFAULT_LOG_K
staticinherited

Definition at line 56 of file SimpleValue.h.

◆ delta

template<typename T , typename Value = SimpleValue<T>>
T StiffValue< T, Value >::delta = Value::DEFAULT_DELTA

Definition at line 63 of file SmoothValue.h.

◆ value

template<typename T >
T SimpleValue< T >::value
protectedinherited

Definition at line 14 of file SimpleValue.h.

Referenced by SimpleValue< T >::get(), SimpleValue< T >::operator*=(), SimpleValue< T >::operator+=(), SimpleValue< T >::operator-=(), SimpleValue< T >::operator/=(), SimpleValue< T >::reset(), TakeoverValue< T, Value >::setLocked(), and SimpleValue< T >::update().

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