The base class for all transforms. A transforms takes a value in, transforms it in some way, and outputs the transformed value. More...

Inheritance diagram for sensesp::TransformBase:

Public Member Functions
	TransformBase (String config_path="")

Public Member Functions inherited from sensesp::Configurable
	Configurable (String config_path="", String description="", int sort_order=1000)

virtual bool	is_async ()
	Return true if the Configurable is asynchronous.

bool	requires_restart ()
	Return true if the Configurable requires restart after saving.

void	set_requires_restart (bool requires_restart)
	Set the requires_restart flag.

virtual void	get_configuration (JsonObject &configObject)

virtual ConfigurableResult	async_get_configuration ()
	Initiate an asynchronous request to get the current configuration.

virtual ConfigurableResult	poll_get_result (JsonObject &config)
	Return the current status of the last async_get_configuration() call.

virtual bool	set_configuration (const JsonObject &config)

virtual ConfigurableResult	async_set_configuration (const JsonObject &config)
	Initiate an asynchronous request to set the configuration.

virtual ConfigurableResult	poll_set_result ()
	Return the current status of the last async set_configuration call.

virtual String	get_config_schema ()

String	get_description ()

Configurable *	set_description (String description)
	Set the description of the Configurable.

int	get_sort_order ()

Configurable *	set_sort_order (int sort_order)

virtual void	save_configuration ()

virtual void	clear_configuration ()
	Clear existing configuration data.

Static Public Member Functions
static const std::set< TransformBase * > &	get_transforms ()

Static Public Member Functions inherited from sensesp::Configurable
static std::vector< Configurable * >	get_configurables ()
	Get configurables.

static Configurable *	get_configurable (String key)
	Get a single Configurable by key.

Additional Inherited Members
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

bool	requires_restart_ = false
	Flag to indicate if the Configurable requires a restart after saving the configuration.

Static Protected Attributes inherited from sensesp::Configurable
static std::map< String, Configurable * >	configurables_

Detailed Description

The base class for all transforms. A transforms takes a value in, transforms it in some way, and outputs the transformed value.

All transforms are subscribed to by calling attach() (inherited from Observable).

Parameters

config_path The path to configure the Transform in the Config UI.

Definition at line 30 of file transform.h.

Constructor & Destructor Documentation

sensesp::TransformBase::TransformBase ( String config_path = "" )

Definition at line 12 of file transform.cpp.

static const std::set< TransformBase * > & sensesp::TransformBase::get_transforms ( )

inlinestatic

Definition at line 37 of file transform.h.

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