SlidingAverageValue Class Reference

class for cyclic buffering of the last "size" values of Type int output via = operator is the average of the last "size" values input a new value also via = operator ATTENTION: the "current-index" is driven by the trigger, so the given average is an average over the last "size" trigger-events ! More...

#include <SlidingAverageValue.h>

List of all members.

Public Member Functions
	SlidingAverageValue ()
	Constructor.
void	reset (int aSize)
	resets the SlidingAverageValue
void	trigger ()
	triggers to the next index
void	add (int value)
	adds an entry to the buffer
int	getAverage ()
int	getLastValue ()
SlidingAverageValue &	operator= (int aInt)
SlidingAverageValue &	operator-= (int aInt)
SlidingAverageValue &	operator+= (int aInt)
	operator int ()
Private Attributes
int	minIdx
int	maxIdx
int	numOfEntries
int	size
int	buffer [maxSlidingRange]
int	timeOfLastAdd
int	sum
int	trig

---

Detailed Description

class for cyclic buffering of the last "size" values of Type int output via = operator is the average of the last "size" values input a new value also via = operator ATTENTION: the "current-index" is driven by the trigger, so the given average is an average over the last "size" trigger-events !

Definition at line 23 of file SlidingAverageValue.h.

---

Constructor & Destructor Documentation

SlidingAverageValue::SlidingAverageValue (   )

Constructor. Definition at line 12 of file SlidingAverageValue.cpp. References reset().

Here is the call graph for this function:

---

Member Function Documentation

void SlidingAverageValue::reset (  int  aSize  )

resets the SlidingAverageValue Parameters: aSize  size of the sliding range Definition at line 17 of file SlidingAverageValue.cpp. References maxIdx, minIdx, numOfEntries, timeOfLastAdd, and trig. Referenced by CollectedBeliefs::CollectedBeliefs(), OpenChallengeSymbols::OpenChallengeSymbols(), SingleBeliefs::SingleBeliefs(), and SlidingAverageValue().

void SlidingAverageValue::trigger (   )

triggers to the next index Definition at line 33 of file SlidingAverageValue.cpp. References trig. Referenced by OpenChallengeSymbols::getAiboOnRamp(), CollectedBeliefs::trigger(), and OpenChallengeSymbols::update().

void SlidingAverageValue::add (  int  value  )

adds an entry to the buffer Parameters: value  value to be added Definition at line 38 of file SlidingAverageValue.cpp. References maxIdx, minIdx, numOfEntries, timeOfLastAdd, and trig. Referenced by OpenChallengeSymbols::getAiboOnRamp(), operator+=(), operator-=(), operator=(), and OpenChallengeSymbols::update().

int SlidingAverageValue::getAverage (   )

Definition at line 56 of file SlidingAverageValue.cpp. References numOfEntries. Referenced by OpenChallengeSymbols::getAiboOnRamp(), operator int(), and OpenChallengeSymbols::update().

int SlidingAverageValue::getLastValue (   )

Definition at line 64 of file SlidingAverageValue.cpp. References maxIdx, and numOfEntries. Referenced by CollectedBeliefs::broadcast().

SlidingAverageValue & SlidingAverageValue::operator= (  int  aInt  )

Definition at line 73 of file SlidingAverageValue.cpp. References add().

Here is the call graph for this function:

SlidingAverageValue & SlidingAverageValue::operator-= (  int  aInt  )

Definition at line 79 of file SlidingAverageValue.cpp. References add(), and maxIdx.

Here is the call graph for this function:

SlidingAverageValue & SlidingAverageValue::operator+= (  int  aInt  )

Definition at line 85 of file SlidingAverageValue.cpp. References add(), and maxIdx.

Here is the call graph for this function:

SlidingAverageValue::operator int (   )  [inline]

Definition at line 56 of file SlidingAverageValue.h. References getAverage().

Here is the call graph for this function:

---

Member Data Documentation

int SlidingAverageValue::minIdx [private]

Definition at line 59 of file SlidingAverageValue.h. Referenced by add(), and reset().

int SlidingAverageValue::maxIdx [private]

Definition at line 60 of file SlidingAverageValue.h. Referenced by add(), getLastValue(), operator+=(), operator-=(), and reset().

int SlidingAverageValue::numOfEntries [private]

Definition at line 61 of file SlidingAverageValue.h. Referenced by add(), getAverage(), getLastValue(), and reset().

int SlidingAverageValue::size [private]

Definition at line 62 of file SlidingAverageValue.h.

int SlidingAverageValue::buffer[maxSlidingRange] [private]

Definition at line 63 of file SlidingAverageValue.h.

int SlidingAverageValue::timeOfLastAdd [private]

Definition at line 64 of file SlidingAverageValue.h. Referenced by add(), and reset().

int SlidingAverageValue::sum [private]

Definition at line 65 of file SlidingAverageValue.h.

int SlidingAverageValue::trig [private]

Definition at line 66 of file SlidingAverageValue.h. Referenced by add(), reset(), and trigger().

---

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

• Tools/SlidingAverageValue.h
• Tools/SlidingAverageValue.cpp

---