SensESP 2.7.2
Universal Signal K sensor toolkit ESP32
Loading...
Searching...
No Matches
sensesp::ThresholdTransform< C, P > Class Template Reference

A Transform base class that translates the value of type C into value of type P. Base class for classes FloatThreshold and IntThreshold. More...

#include <sensesp/transforms/threshold.h>

Inheritance diagram for sensesp::ThresholdTransform< C, P >:
[legend]

Public Member Functions

 ThresholdTransform (C min_value, C max_value, P in_range, String config_path="")
 
virtual void set_input (C new_value, uint8_t input_channel=0) 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)
 
virtual void get_configuration (JsonObject &configObject)
 
virtual bool set_configuration (const JsonObject &config)
 
virtual String get_config_schema ()
 
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)
 
virtual void start ()
 
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 Pget () 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)
 

Protected Attributes

C min_value_
 
C max_value_
 
P in_range_
 
- Protected Attributes inherited from sensesp::Configurable
String description_ = ""
 
int sort_order_ = 1000
 
- Protected Attributes inherited from sensesp::ValueProducer< P >
P output
 

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 ()
 

Detailed Description

template<typename C, typename P>
class sensesp::ThresholdTransform< C, P >

A Transform base class that translates the value of type C into value of type P. Base class for classes FloatThreshold and IntThreshold.

Parameters
min_valueMinimum value of input for output to be the value of in_range.
max_valueMaximum value of input for output to be the value of in_range.
in_rangeOutput value if input value is in range.

Definition at line 20 of file threshold.h.

Constructor & Destructor Documentation

◆ ThresholdTransform()

template<typename C , typename P >
sensesp::ThresholdTransform< C, P >::ThresholdTransform ( C  min_value,
C  max_value,
P  in_range,
String  config_path = "" 
)
inline

Definition at line 22 of file threshold.h.

Here is the call graph for this function:

Member Function Documentation

◆ set_input()

template<class C , class P >
void sensesp::ThresholdTransform< C, P >::set_input ( C  new_value,
uint8_t  input_channel = 0 
)
overridevirtual

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

Parameters
new_valuethe value of the input
input_channelConsumers 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 6 of file threshold.cpp.

Here is the call graph for this function:

Member Data Documentation

◆ in_range_

template<typename C , typename P >
P sensesp::ThresholdTransform< C, P >::in_range_
protected

Definition at line 34 of file threshold.h.

◆ max_value_

template<typename C , typename P >
C sensesp::ThresholdTransform< C, P >::max_value_
protected

Definition at line 33 of file threshold.h.

◆ min_value_

template<typename C , typename P >
C sensesp::ThresholdTransform< C, P >::min_value_
protected

Definition at line 32 of file threshold.h.


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