sensesp::SKOutputNumeric< T > Class Template Reference

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=NULL)
	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=NULL)
	SKOutput (String sk_path, SKMetadata *meta)
virtual void	set_input (T new_value, uint8_t input_channel=0) override
virtual String	as_signalk () override
virtual void	get_configuration (JsonObject &root) override
String	get_config_schema () override
virtual bool	set_configuration (const JsonObject &config) override
virtual void	set_metadata (SKMetadata *meta)
virtual SKMetadata *	get_metadata () override
String	as_signalk ()
	Template specialization for SKOutputPosition::as_signalk()
String	as_signalk ()
Public Member Functions inherited from sensesp::SKEmitter
	SKEmitter (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 (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< T >
void	connect_from (ValueProducer< T > *producer, uint8_t input_channel=0)
Public Member Functions inherited from sensesp::ValueProducer< T >
	ValueProducer ()
virtual const T &	get () const
void	connect_to (ValueConsumer< T > *consumer, uint8_t input_channel=0)
template<typename CT >
void	connect_to (ValueConsumer< CT > *consumer, uint8_t input_channel=0)
	Connect a producer to a consumer of a different type.
template<typename T2 >
Transform< T, T2 > *	connect_to (Transform< T, T2 > *consumer_producer, uint8_t input_channel=0)
template<typename TT , typename T2 >
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 (T new_value)

Additional Inherited Members
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 ()
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::SKOutput< T >
SKMetadata *	meta_
Protected Attributes inherited from sensesp::SKEmitter
String	sk_path
Protected Attributes inherited from sensesp::Configurable
String	description_ = ""
int	sort_order_ = 1000
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 111 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 = NULL
	)

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 116 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 128 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