sensesp::Enable< T > Class Template Reference

On/off switch for signals: input is emitted as-is if the enable flag is set in the web UI. More...

#include <sensesp/transforms/enable.h>

Inheritance diagram for sensesp::Enable< T >:

Public Member Functions
	Enable (bool enabled=true, String config_path="")
virtual void	set_input (T input, uint8_t input_channel=0) override
virtual void	get_configuration (JsonObject &doc) override
virtual bool	set_configuration (const JsonObject &config) override
virtual String	get_config_schema () override
Public Member Functions inherited from sensesp::Transform< T, T >
	Transform (String config_path="")
Transform< T, T > *	connect_from (ValueProducer< T > *producer0, ValueProducer< T > *producer1=NULL, ValueProducer< T > *producer2=NULL, ValueProducer< T > *producer3=NULL, ValueProducer< T > *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)
virtual void	start ()
const int	get_start_priority ()
void	set_start_priority (int priority)
Public Member Functions inherited from sensesp::ValueConsumer< T >
void	connect_from (ValueProducer< T > *producer, uint8_t input_channel=0)
Public Member Functions inherited from sensesp::ValueProducer< T >
	ValueProducer ()
virtual const T &	get () const
void	connect_to (ValueConsumer< T > *consumer, uint8_t input_channel=0)
template<typename CT >
void	connect_to (ValueConsumer< CT > *consumer, uint8_t input_channel=0)
	Connect a producer to a consumer of a different type.
template<typename T2 >
Transform< T, T2 > *	connect_to (Transform< T, T2 > *consumer_producer, uint8_t input_channel=0)
template<typename TT , typename T2 >
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 (T 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< T >
T	output

Detailed Description

template<typename T>
class sensesp::Enable< T >

On/off switch for signals: input is emitted as-is if the enable flag is set in the web UI.

Enable transform can be used to enable or disable certain transforms. When set to false, the transform will not emit any output.

Template Parameters

T	Input and output type.

Definition at line 25 of file enable.h.

Constructor & Destructor Documentation

Enable()

template<typename T >

sensesp::Enable< T >::Enable ( bool  enabled = true, String  config_path = ""  )

inline

Definition at line 27 of file enable.h.

Here is the call graph for this function:

Member Function Documentation

get_config_schema()

template<typename T >

virtual String sensesp::Enable< T >::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 48 of file enable.h.

get_configuration()

template<typename T >

virtual void sensesp::Enable< T >::get_configuration ( JsonObject &  configObject )

inlineoverridevirtual

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 37 of file enable.h.

set_configuration()

template<typename T >

virtual bool sensesp::Enable< T >::set_configuration ( const JsonObject &  config )

inlineoverridevirtual

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

Reimplemented from sensesp::Configurable.

Definition at line 40 of file enable.h.

set_input()

template<typename T >

virtual void sensesp::Enable< T >::set_input ( T  new_value, uint8_t  input_channel = 0  )

inlineoverridevirtual

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< T >.

Definition at line 32 of file enable.h.

Here is the call graph for this function:

---

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

• src/sensesp/transforms/enable.h