UpdateableNumber Class Template Reference

#include <C:/Work/specialnumbers_svn/NumberLib/NumbersLib/UpdateableNumber.h>

Inheritance diagram for UpdateableNumber:

List of all members.

---

Detailed Description

template<class T>
class luma::numbers::UpdateableNumber< T >

Updateable numbers are used when a value is updated regularly, and logic should be performed on every update.

This is a typical example of how to use any updateable number:

declaration BufferedNumber<float> filteredSpeed(0.0f, -100.0f, 100.0f, 0.5f);

   // General update method - called every tick
   void update()
   {
      filteredSpeed.setValue(getSpeed());

      //update, for example, a GUI widget based on the filteredValue.
      speedWidget.setDisplayValue(filteredSpeed.getValue());
   }

In general, setValue should only be called once per update, but getValue can be called any number of times.

Note:

BufferedStep works like Updateable numbers, although the class does not implement the Updateable interface.

Boolean values, and enums are also considered "numbers".

Definition at line 40 of file UpdateableNumber.h.

Public Member Functions
virtual T	getValue () const =0
	Get the current value of this AbstractFilteredNumber of the given order.
virtual void	setValue (T value, float elapsedTime=TIME_UNIT)=0
	Sets a new input value.

---

Member Function Documentation

virtual T getValue

(

)

const [pure virtual]

Get the current value of this AbstractFilteredNumber of the given order.

Implemented in AbstractFilteredNumber, AbstractFilteredNumber< T, sampleCount, 0 >, BufferedBool, BufferedNumber, BufferedState, NumberWrapper, PIDBufferedNumber, AbstractFilteredNumber< T, sampleCount, 1 >, AbstractFilteredNumber< T, 2, maxOrder >, AbstractFilteredNumber< T, 2, 0 >, and AbstractFilteredNumber< T, 2, 1 >.

virtual void setValue	(	T	value,
		float	elapsedTime = TIME_UNIT
	)			[pure virtual]

Sets a new input value.

In general, this function should only be called once per update.

Implemented in AbstractFilteredNumber< T, sampleCount, 0 >, BufferedBool, BufferedNumber, BufferedState, DifferentiableNumber, DifferentiableNumber< T, 1 >, IntegrableNumber, IntegrableNumber< T, sampleCount, 1 >, NumberWrapper, PIDBufferedNumber, DifferentiableNumber< T, dn >, and IntegrableNumber< T, im, in >.

---

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

• C:/Work/specialnumbers_svn/NumberLib/NumbersLib/UpdateableNumber.h