SmoothCompareTrans< T > Class Template Reference
#include <SmoothCompareTrans.h>
Inheritance diagram for SmoothCompareTrans< T >:
Detailed Description
template<class T>
class SmoothCompareTrans< T >
A subclass of CompareTrans, which provides monitoring of exponentially weighted averages to a threshold.
Has the additional requirement that template types must supply operator*=(float) and operator+=(T) for the weighted average
The gamma parameter is how much to weight the preceeding value - 1 will cause it to never update, 0 will cause it to only look at most recent. So, the lower the value, the faster it is to switch, but more prone to noise
Definition at line 15 of file SmoothCompareTrans.h.
Public Member Functions | |
| SmoothCompareTrans (StateNode *destination, const T *monitor, typename SmoothCompareTrans< T >::Test_t test, const T &value, const EventBase &poll, float gammap=0) | |
| constructor, see SmoothCompareTrans class notes for information | |
| SmoothCompareTrans (const std::string &name, StateNode *destination, const T *monitor, typename SmoothCompareTrans< T >::Test_t test, const T &value, const EventBase &poll, float gammap=0) | |
| constructor, see SmoothCompareTrans class notes for information | |
| virtual void | DoStart () |
| starts listening | |
| void | setBurnIn (unsigned int i) |
| sets number of tests to perform before allowing a transition; default 1/(1-g) | |
| unsigned int | getBurnIn () |
| returns number of tests to perform before allowing a transition; default 1/(1-g) | |
| virtual void | processEvent (const EventBase &e) |
| don't care about the event, just a pulse to check the values | |
Protected Attributes | |
| T | avg |
| the current running average | |
| const T * | realmon |
| pointer to the value being monitored | |
| unsigned int | burnin |
| number of tests to perform before allowing a transition; default 1/(1-g) | |
| unsigned int | tests |
| counter of tests made since last DoStart() | |
| float | g |
| the gamma value controlling the exponential average, see the class documentation at the top | |
Private Member Functions | |
| SmoothCompareTrans (const SmoothCompareTrans &node) | |
| don't call this | |
| SmoothCompareTrans | operator= (const SmoothCompareTrans &node) |
| don't call this | |
The documentation for this class was generated from the following file:
