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, String config_path="")

Public Member Functions inherited from sensesp::LambdaTransform< float, float, float, float >
	LambdaTransform (std::function< float(float)> function, String config_path="")

	LambdaTransform (std::function< float(float)> function, const ParamInfo *param_info, String config_path="")

	LambdaTransform (std::function< float(float, float)> function, float param1, const ParamInfo *param_info, String config_path="")

	LambdaTransform (std::function< float(float, float, float)> function, float param1, float param2, const ParamInfo *param_info, 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, 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, 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, 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, String config_path="")

void	set_input (float input, uint8_t input_channel=0) override

void	get_configuration (JsonObject &doc) override

bool	set_configuration (const JsonObject &config) override

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

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 >
virtual void	set_input (C new_value, uint8_t input_channel=0)

void	connect_from (ValueProducer< C > *producer, uint8_t input_channel=0)

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

virtual const P &	get () 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)

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< P >
P	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,
		String	config_path = `""`
	)

Definition at line 19 of file linear.cpp.

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

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

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Linear()