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

#include <sensesp/transforms/threshold.h>

Inheritance diagram for sensesp::ThresholdTransform< C >:

[legend]

Public Member Functions
	ThresholdTransform (C min_value, C max_value, bool in_range, String config_path="")

virtual void	set (const C &new_value) override

bool	from_json (const JsonObject &root) override

bool	to_json (JsonObject &root) override

Public Member Functions inherited from sensesp::Transform< C, bool >
	Transform (String config_path="")

Transform< C, bool > *	connect_from (ValueProducer< bool > producer0, ValueProducer< bool > producer1=NULL, ValueProducer< bool > producer2=NULL, ValueProducer< bool > producer3=NULL, ValueProducer< bool > *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< bool >
	ValueProducer ()

	ValueProducer (const bool &initial_value)

virtual const bool &	get () const

std::enable_if< std::is_base_of< ValueConsumer< typenameVConsumer::input_type >, VConsumer >::value &&std::is_convertible< bool, 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< bool, 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< bool, typenameVConsumer::input_type >::value, VConsumer * >::type	connect_to (VConsumer &consumer)

void	emit (const bool &new_value)

	ValueProducer ()

	ValueProducer (const bool &initial_value)

virtual const bool &	get () const

std::enable_if< std::is_base_of< ValueConsumer< typenameVConsumer::input_type >, VConsumer >::value &&std::is_convertible< bool, 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< bool, 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< bool, typenameVConsumer::input_type >::value, VConsumer * >::type	connect_to (VConsumer &consumer)

void	emit (const bool &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_

bool	in_range_

Protected Attributes inherited from sensesp::Saveable
const String	config_path_

Protected Attributes inherited from sensesp::ValueProducer< bool >
bool	output_

bool	output_

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

Detailed Description

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

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

Parameters

min_value	Minimum value of input for output to be the value of in_range.
max_value	Maximum value of input for output to be the value of in_range.
in_range	Output value if input value is in range.
out_range	Output value if input value is out of the range.

Definition at line 22 of file threshold.h.

Constructor & Destructor Documentation

◆ ThresholdTransform()

template<typename C>

sensesp::ThresholdTransform< C >::ThresholdTransform	(	C	min_value,
		C	max_value,
		bool	in_range,
		String	config_path = "" )

inline

Definition at line 25 of file threshold.h.

Member Function Documentation

◆ from_json()

template<typename C>

bool sensesp::ThresholdTransform< C >::from_json ( const JsonObject & root )

inlineoverridevirtual

Deserializes the current object data from a JsonObject.

Reimplemented from sensesp::Serializable.

Definition at line 44 of file threshold.h.

◆ set()

template<typename C>

virtual void sensesp::ThresholdTransform< C >::set ( const C & 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< C >.

Definition at line 34 of file threshold.h.

◆ to_json()

template<typename C>

bool sensesp::ThresholdTransform< C >::to_json ( JsonObject & root )

inlineoverridevirtual

Serializes the current object data into a JsonObject.

Reimplemented from sensesp::Serializable.

Definition at line 58 of file threshold.h.

Member Data Documentation

◆ in_range_

template<typename C>

bool sensesp::ThresholdTransform< C >::in_range_

protected

Definition at line 68 of file threshold.h.

◆ max_value_

template<typename C>

C sensesp::ThresholdTransform< C >::max_value_

protected

Definition at line 67 of file threshold.h.

◆ min_value_

template<typename C>

C sensesp::ThresholdTransform< C >::min_value_

protected

Definition at line 66 of file threshold.h.

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

src/sensesp/transforms/threshold.h

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ThresholdTransform()

Member Function Documentation

◆ from_json()

◆ set()

◆ to_json()

Member Data Documentation

◆ in_range_

◆ max_value_

◆ min_value_