A special class for sending numeric values to the Signal K server on a specific Signal K path. More...

#include <sensesp/signalk/signalk_output.h>

Inheritance diagram for sensesp::SKOutputNumeric< T >:

Public Member Functions
	SKOutputNumeric (String sk_path, String config_path="", SKMetadata *meta=nullptr)

	SKOutputNumeric (String sk_path, SKMetadata *meta)

	SKOutputNumeric (String sk_path, String config_path, String units)

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

	SKOutput (String sk_path, String config_path="", SKMetadata *meta=nullptr)

	SKOutput (String sk_path, String config_path, std::shared_ptr< SKMetadata > meta)

	SKOutput (String sk_path, SKMetadata *meta)

virtual void	set (const T &new_value) override

virtual void	as_signalk_json (JsonDocument &doc) override

virtual bool	to_json (JsonObject &root) override

virtual bool	from_json (const JsonObject &config) override

virtual void	set_metadata (SKMetadata *meta)

virtual SKMetadata *	get_metadata () override

void	as_signalk_json (JsonDocument &doc)
	Template specialization for SKOutputPosition::as_signalk_json()

void	as_signalk_json (JsonDocument &doc)

void	as_signalk_json (JsonDocument &doc)

void	as_signalk_json (JsonDocument &doc)

void	as_signalk_json (JsonDocument &doc)

void	as_signalk_json (JsonDocument &doc)

Public Member Functions inherited from sensesp::SKEmitter
	SKEmitter (const String &sk_path)

virtual void	add_metadata (JsonArray &meta)

String &	get_sk_path ()

void	set_sk_path (const String &path)

Public Member Functions inherited from sensesp::Observable
	Observable ()

	Observable (Observable &&other)
	Move constructor.

void	notify ()

void	attach (std::function< void()> observer)

Public Member Functions inherited from sensesp::SymmetricTransform< T >
	SymmetricTransform (String config_path="")

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)

Additional Inherited Members
Public Types inherited from sensesp::ValueConsumer< T >
using	input_type = T

Static Public Member Functions inherited from sensesp::SKEmitter
static const std::vector< SKEmitter * > &	get_sources ()

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

Protected Attributes inherited from sensesp::SKOutput< T >
std::shared_ptr< SKMetadata >	meta_

Protected Attributes inherited from sensesp::SKEmitter
String	sk_path_ {}

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::SKOutputNumeric< T >

A special class for sending numeric values to the Signal K server on a specific Signal K path.

Definition at line 112 of file signalk_output.h.

Constructor & Destructor Documentation

◆ SKOutputNumeric() [1/3]

template<typename T >

sensesp::SKOutputNumeric< T >::SKOutputNumeric	(	String	sk_path,
		String	config_path = "",
		SKMetadata *	meta = nullptr )

Definition at line 6 of file signalk_output.cpp.

◆ SKOutputNumeric() [2/3]

template<typename T >

sensesp::SKOutputNumeric< T >::SKOutputNumeric	(	String	sk_path,
		SKMetadata *	meta )

inline

Definition at line 117 of file signalk_output.h.

◆ SKOutputNumeric() [3/3]

template<typename T >

sensesp::SKOutputNumeric< T >::SKOutputNumeric	(	String	sk_path,
		String	config_path,
		String	units )

inline

The Signal K specification requires that numeric values sent to the server should at minimum specify a "units". This constructor allows you to conveniently specify the numeric units as a third parameter.

Parameters

units The unit value for the number this outputs on the specified Signal K path. See https://github.com/SignalK/specification/blob/master/schemas/definitions.json#L87

See also: SKMetadata

Definition at line 129 of file signalk_output.h.

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

src/sensesp/signalk/signalk_output.h
src/sensesp/signalk/signalk_output.cpp

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ SKOutputNumeric() [1/3]

◆ SKOutputNumeric() [2/3]

◆ SKOutputNumeric() [3/3]