sensesp::Integrator< C, P > Class Template Reference

Integrator integrates (accumulates) the incoming values. More...

#include <sensesp/transforms/integrator.h>

Inheritance diagram for sensesp::Integrator< C, P >:

Public Member Functions
	Integrator (P k=1, P value=0, String config_path="")
	Construct a new Integrator T object.
virtual void	set (const C &input) override final
void	reset ()
virtual bool	to_json (JsonObject &doc) override final
virtual bool	from_json (const JsonObject &config) override final
Public Member Functions inherited from sensesp::Transform< C, P >
	Transform (String config_path="")
Transform< C, P > *	connect_from (ValueProducer< P > *producer0, ValueProducer< P > *producer1=NULL, ValueProducer< P > *producer2=NULL, ValueProducer< P > *producer3=NULL, ValueProducer< P > *producer4=NULL)
Public Member Functions inherited from sensesp::TransformBase
	TransformBase (const String &config_path)
Public Member Functions inherited from sensesp::FileSystemSaveable
	FileSystemSaveable (const String &config_path)
virtual bool	load () override
	Load and populate the object from a persistent storage.
virtual bool	save () override
	Save the object to a persistent storage.
virtual bool	clear () override
	Delete the data from a persistent storage.
bool	find_config_file (const String &config_path, String &filename)
Public Member Functions inherited from sensesp::Saveable
	Saveable (const String &config_path)
virtual bool	refresh ()
	Refresh the object. This may or may not access the persistent storage but is not expected to overwrite the object's state.
const String &	get_config_path () const
Public Member Functions inherited from sensesp::ValueConsumer< C >
virtual void	set_input (const C &new_value)
void	connect_from (ValueProducer< C > *producer)
Public Member Functions inherited from sensesp::ValueProducer< P >
	ValueProducer ()
	ValueProducer (const P &initial_value)
virtual const P &	get () const
std::enable_if< std::is_base_of< ValueConsumer< typenameVConsumer::input_type >, VConsumer >::value &&std::is_convertible< P, typenameVConsumer::input_type >::value, std::shared_ptr< VConsumer > >::type	connect_to (std::shared_ptr< VConsumer > consumer)
	Connect a producer to a transform with a different input type.
std::enable_if< std::is_base_of< ValueConsumer< typenameVConsumer::input_type >, VConsumer >::value &&std::is_convertible< P, typenameVConsumer::input_type >::value, VConsumer * >::type	connect_to (VConsumer *consumer)
std::enable_if< std::is_base_of< ValueConsumer< typenameVConsumer::input_type >, VConsumer >::value &&std::is_convertible< P, typenameVConsumer::input_type >::value, VConsumer * >::type	connect_to (VConsumer &consumer)
void	emit (const P &new_value)
Public Member Functions inherited from sensesp::Observable
	Observable ()
	Observable (Observable &&other)
	Move constructor.
void	notify ()
void	attach (std::function< void()> observer)

Additional Inherited Members
Public Types inherited from sensesp::ValueConsumer< C >
using	input_type
Static Public Member Functions inherited from sensesp::TransformBase
static const std::set< TransformBase * > &	get_transforms ()
Protected Attributes inherited from sensesp::Saveable
const String	config_path_
Protected Attributes inherited from sensesp::ValueProducer< P >
P	output_

Detailed Description

template<class C, class P>
class sensesp::Integrator< C, P >

Integrator integrates (accumulates) the incoming values.

The integrator output value is the sum of the all previous values plus the latest value, multiplied by the coefficient k.

Template Parameters

C	Consumer (incoming) data type
P	Producer (output) data type

Definition at line 19 of file integrator.h.

Constructor & Destructor Documentation

Integrator()

template<class C, class P>

sensesp::Integrator< C, P >::Integrator ( P k = 1, P value = 0, String config_path = "" )

inline

Construct a new Integrator T object.

Parameters

k	Multiplier coefficient
value	Initial value of the accumulator
config_path	Configuration path

Definition at line 28 of file integrator.h.

Member Function Documentation

from_json()

template<class C, class P>

virtual bool sensesp::Integrator< C, P >::from_json ( const JsonObject & root )

inlinefinaloverridevirtual

Deserializes the current object data from a JsonObject.

Reimplemented from sensesp::Serializable.

Definition at line 45 of file integrator.h.

reset()

template<class C, class P>

void sensesp::Integrator< C, P >::reset ( )

inline

Definition at line 39 of file integrator.h.

set()

template<class C, class P>

virtual void sensesp::Integrator< C, P >::set ( const C & new_value )

inlinefinaloverridevirtual

Used to set an input of this consumer. It is called automatically by a ValueProducer but can also be called manually.

Parameters

new_value

the value of the input

Reimplemented from sensesp::ValueConsumer< C >.

Definition at line 34 of file integrator.h.

to_json()

template<class C, class P>

virtual bool sensesp::Integrator< C, P >::to_json ( JsonObject & root )

inlinefinaloverridevirtual

Serializes the current object data into a JsonObject.

Reimplemented from sensesp::Serializable.

Definition at line 41 of file integrator.h.

---

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

• src/sensesp/transforms/integrator.h