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

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

#include <sensesp/transforms/integrator.h>

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

Public Member Functions
	IntegratorT (P k=1, P value=0, String config_path="")
	Construct a new Integrator T object.
virtual void	start () override final
virtual void	set_input (C input, uint8_t inputChannel=0) override final
void	reset ()
virtual void	get_configuration (JsonObject &doc) override final
virtual bool	set_configuration (const JsonObject &config) override final
virtual String	get_config_schema () override
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 (String config_path="")
Public Member Functions inherited from sensesp::Configurable
	Configurable (String config_path="", String description="", int sort_order=1000)
String	get_description ()
void	set_description (String description)
	Set the description of the Configurable.
int	get_sort_order ()
void	set_sort_order (int sort_order)
virtual void	save_configuration ()
Public Member Functions inherited from sensesp::Startable
	Startable (int priority=0)
const int	get_start_priority ()
void	set_start_priority (int priority)
Public Member Functions inherited from sensesp::ValueConsumer< C >
void	connect_from (ValueProducer< C > *producer, uint8_t input_channel=0)
Public Member Functions inherited from sensesp::ValueProducer< P >
	ValueProducer ()
virtual const P &	get () const
void	connect_to (ValueConsumer< P > *consumer, uint8_t input_channel=0)
void	connect_to (ValueConsumer< CT > *consumer, uint8_t input_channel=0)
	Connect a producer to a consumer of a different type.
Transform< P, T2 > *	connect_to (Transform< P, T2 > *consumer_producer, uint8_t input_channel=0)
Transform< TT, T2 > *	connect_to (Transform< TT, T2 > *consumer_producer, uint8_t input_channel=0)
	Connect a producer to a transform with a different input type.
void	emit (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
Static Public Member Functions inherited from sensesp::TransformBase
static const std::set< TransformBase * > &	get_transforms ()
Static Public Member Functions inherited from sensesp::Startable
static void	start_all ()
Public Attributes inherited from sensesp::Configurable
const String	config_path_
Protected Member Functions inherited from sensesp::Configurable
virtual void	load_configuration ()
Protected Attributes inherited from sensesp::Configurable
String	description_ = ""
int	sort_order_ = 1000
Protected Attributes inherited from sensesp::ValueProducer< P >
P	output

Detailed Description

template<class C, class P>
class sensesp::IntegratorT< 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 25 of file integrator.h.

Constructor & Destructor Documentation

IntegratorT()

template<class C , class P >

sensesp::IntegratorT< C, P >::IntegratorT ( 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 34 of file integrator.h.

Here is the call graph for this function:

Member Function Documentation

get_config_schema()

template<class C , class P >

virtual String sensesp::IntegratorT< C, P >::get_config_schema ( )

inlineoverridevirtual

Returns a configuration schema that specifies the key/value pairs that can be expected when calling get_configuration(), or are expected by set_configuration(). The schema will be in JSON Schema format

See also

https://json-schema.org

Reimplemented from sensesp::Configurable.

Definition at line 66 of file integrator.h.

get_configuration()

template<class C , class P >

virtual void sensesp::IntegratorT< C, P >::get_configuration ( JsonObject &  configObject )

inlinefinaloverridevirtual

Returns the current configuration data as a JsonObject. In general, the current state of local member variables are saved to a new object created with JsonDocument::as<JsonObject>() and returned.

Reimplemented from sensesp::Configurable.

Definition at line 53 of file integrator.h.

reset()

template<class C , class P >

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

inline

Definition at line 51 of file integrator.h.

set_configuration()

template<class C , class P >

virtual bool sensesp::IntegratorT< C, P >::set_configuration ( const JsonObject &  config )

inlinefinaloverridevirtual

Sets the current state of local member variables using the data stored in config.

Reimplemented from sensesp::Configurable.

Definition at line 56 of file integrator.h.

set_input()

template<class C , class P >

virtual void sensesp::IntegratorT< C, P >::set_input ( C  new_value, uint8_t  input_channel = 0  )

inlinefinaloverridevirtual

Used to set an input of this consumer. It is usually called automatically by a ValueProducer.

Parameters

new_value	the value of the input
input_channel	Consumers can have one or more inputs feeding them. This parameter allows you to specify which input number the producer is connecting to. For single input consumers, leave the index at zero.

Reimplemented from sensesp::ValueConsumer< C >.

Definition at line 46 of file integrator.h.

Here is the call graph for this function:

start()

template<class C , class P >

virtual void sensesp::IntegratorT< C, P >::start ( )

inlinefinaloverridevirtual

Called during the initialization process. Override this method to add runtime initialization code to your class

Reimplemented from sensesp::Startable.

Definition at line 39 of file integrator.h.

---

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

• src/sensesp/transforms/integrator.h