sensesp::Linear Class Reference

Performs a linear transform on the input value: output_ = (input * multiplier) + offset. More...

#include <sensesp/transforms/linear.h>

Inheritance diagram for sensesp::Linear:

Public Member Functions
	Linear (float multiplier, float offset, const String &config_path="")
Public Member Functions inherited from sensesp::LambdaTransform< float, float, float, float >
	LambdaTransform (std::function< float(float)> function, const String &config_path="")
	LambdaTransform (std::function< float(float)> function, const ParamInfo *param_info, const String &config_path="")
	LambdaTransform (std::function< float(float, float)> function, float param1, const ParamInfo *param_info, const String &config_path="")
	LambdaTransform (std::function< float(float, float, float)> function, float param1, float param2, const ParamInfo *param_info, const String &config_path="")
	LambdaTransform constructor for two-parameter function.
	LambdaTransform (std::function< float(float, float, float, bool)> function, float param1, float param2, bool param3, const ParamInfo *param_info, const String &config_path="")
	LambdaTransform (std::function< float(float, float, float, bool, bool)> function, float param1, float param2, bool param3, bool param4, const ParamInfo *param_info, const String &config_path="")
	LambdaTransform (std::function< float(float, float, float, bool, bool, bool)> function, float param1, float param2, bool param3, bool param4, bool param5, const ParamInfo *param_info, const String &config_path="")
	LambdaTransform (std::function< float(float, float, float, bool, bool, bool, bool)> function, float param1, float param2, bool param3, bool param4, bool param5, bool param6, const ParamInfo *param_info, const String &config_path="")
void	set (const float &input) override
bool	to_json (JsonObject &doc) override
bool	from_json (const JsonObject &config) override
const ParamInfo *	get_param_info () const
Public Member Functions inherited from sensesp::Transform< float, float >
	Transform (String config_path="")
Transform< float, float > *	connect_from (ValueProducer< float > *producer0, ValueProducer< float > *producer1=NULL, ValueProducer< float > *producer2=NULL, ValueProducer< float > *producer3=NULL, ValueProducer< float > *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< float >
virtual void	set_input (const float &new_value)
void	connect_from (ValueProducer< float > *producer)
virtual void	set_input (const float &new_value)
void	connect_from (ValueProducer< float > *producer)
Public Member Functions inherited from sensesp::ValueProducer< float >
	ValueProducer ()
	ValueProducer (const float &initial_value)
virtual const float &	get () const
std::enable_if< std::is_base_of< ValueConsumer< typenameVConsumer::input_type >, VConsumer >::value &&std::is_convertible< float, 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< float, 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< float, typenameVConsumer::input_type >::value, VConsumer * >::type	connect_to (VConsumer &consumer)
void	emit (const float &new_value)
	ValueProducer ()
	ValueProducer (const float &initial_value)
virtual const float &	get () const
std::enable_if< std::is_base_of< ValueConsumer< typenameVConsumer::input_type >, VConsumer >::value &&std::is_convertible< float, 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< float, 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< float, typenameVConsumer::input_type >::value, VConsumer * >::type	connect_to (VConsumer &consumer)
void	emit (const float &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< float >
using	input_type
Static Public Member Functions inherited from sensesp::TransformBase
static const std::set< TransformBase * > &	get_transforms ()
Public Attributes inherited from sensesp::LambdaTransform< float, float, float, float >
float	param1_
float	param2_
bool	param3_
bool	param4_
bool	param5_
bool	param6_
Protected Attributes inherited from sensesp::Saveable
const String	config_path_
Protected Attributes inherited from sensesp::ValueProducer< float >
float	output_
float	output_

Detailed Description

Performs a linear transform on the input value: output_ = (input * multiplier) + offset.

Parameters

multiplier	The input is multiplied this value.
offset	This is added to (input * multiplier)
config_path	The path to configure this transform in the Config UI

Definition at line 18 of file linear.h.

Constructor & Destructor Documentation

Linear()

sensesp::Linear::Linear	(	float	multiplier,
		float	offset,
		const String &	config_path = "" )

Definition at line 19 of file linear.cpp.

Here is the call graph for this function:

---

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

• src/sensesp/transforms/linear.h
• src/sensesp/transforms/linear.cpp