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 (const T &input) override

virtual bool	to_json (JsonObject &doc) override

virtual bool	from_json (const JsonObject &config) 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 (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::Serializable
Public Member Functions inherited from sensesp::ValueConsumer< T >
virtual void	set_input (const T &new_value)

void	connect_from (ValueProducer< T > *producer)

Public Member Functions inherited from sensesp::ValueProducer< T >
	ValueProducer ()

	ValueProducer (const T &initial_value)

virtual const T &	get () const

template<typename VConsumer >
std::enable_if< std::is_base_of< ValueConsumer< typenameVConsumer::input_type >, VConsumer >::value &&std::is_convertible< T, 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.

template<typename VConsumer >
std::enable_if< std::is_base_of< ValueConsumer< typenameVConsumer::input_type >, VConsumer >::value &&std::is_convertible< T, typenameVConsumer::input_type >::value, VConsumer * >::type	connect_to (VConsumer *consumer)

template<typename VConsumer >
std::enable_if< std::is_base_of< ValueConsumer< typenameVConsumer::input_type >, VConsumer >::value &&std::is_convertible< T, typenameVConsumer::input_type >::value, VConsumer * >::type	connect_to (VConsumer &consumer)

void	emit (const 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
Public Types inherited from sensesp::ValueConsumer< T >
using	input_type = T

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

Here is the call graph for this function:

Member Function Documentation

◆ from_json()

template<typename T >

virtual bool sensesp::Enable< T >::from_json ( const JsonObject & root )

inlineoverridevirtual

Deserializes the current object data from a JsonObject.

Reimplemented from sensesp::Serializable.

Definition at line 35 of file enable.h.

◆ set()

template<typename T >

virtual void sensesp::Enable< T >::set ( const T & new_value )

inlineoverridevirtual

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

Definition at line 26 of file enable.h.

Here is the call graph for this function:

◆ to_json()

template<typename T >

virtual bool sensesp::Enable< T >::to_json ( JsonObject & root )

inlineoverridevirtual

Serializes the current object data into a JsonObject.

Reimplemented from sensesp::Serializable.

Definition at line 31 of file enable.h.

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

src/sensesp/transforms/enable.h

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Enable()

Member Function Documentation

◆ from_json()

◆ set()

◆ to_json()