sensesp::SKOutputTime Class Reference

#include <sensesp/signalk/signalk_time.h>

Inheritance diagram for sensesp::SKOutputTime:

Public Member Functions
	SKOutputTime (String sk_path, String config_path="")
virtual String	as_signalk () override
virtual void	get_configuration (JsonObject &doc) override
virtual bool	set_configuration (const JsonObject &config) override
virtual String	get_config_schema () override
Public Member Functions inherited from sensesp::TimeString
	TimeString (String config_path="")
virtual void	set_input (time_t input, uint8_t input_channel=0) override
Public Member Functions inherited from sensesp::Transform< time_t, String >
	Transform (String config_path="")
Transform< time_t, String > *	connect_from (ValueProducer< String > *producer0, ValueProducer< String > *producer1=NULL, ValueProducer< String > *producer2=NULL, ValueProducer< String > *producer3=NULL, ValueProducer< String > *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 >
virtual void	set_input (T new_value, uint8_t input_channel=0)
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)
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::SKEmitter
	SKEmitter (String sk_path)
virtual SKMetadata *	get_metadata ()
virtual void	add_metadata (JsonArray &meta)
String &	get_sk_path ()
void	set_sk_path (const String &path)

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 ()
Static Public Member Functions inherited from sensesp::SKEmitter
static const std::vector< SKEmitter * > &	get_sources ()
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< T >
T	output
Protected Attributes inherited from sensesp::SKEmitter
String	sk_path

Detailed Description

Definition at line 9 of file signalk_time.h.

Constructor & Destructor Documentation

SKOutputTime()

sensesp::SKOutputTime::SKOutputTime	(	String	sk_path,
		String	config_path = ""
	)

Definition at line 6 of file signalk_time.cpp.

Here is the call graph for this function:

Member Function Documentation

as_signalk()

String sensesp::SKOutputTime::as_signalk ( )

overridevirtual

Returns the data to be reported to the server as a Signal K json string.

Reimplemented from sensesp::SKEmitter.

Definition at line 11 of file signalk_time.cpp.

get_config_schema()

String sensesp::SKOutputTime::get_config_schema ( )

overridevirtual

Returns a configuration schema that specifies the key/value pairs that can be expected when calling get_configuration(), or are expected by set_configuration(). The schema will be in JSON Schema format

See also

https://json-schema.org

Reimplemented from sensesp::Configurable.

Definition at line 32 of file signalk_time.cpp.

get_configuration()

void sensesp::SKOutputTime::get_configuration ( JsonObject &  configObject )

overridevirtual

Returns the current configuration data as a JsonObject. In general, the current state of local member variables are saved to a new object created with JsonDocument::as<JsonObject>() and returned.

Reimplemented from sensesp::Configurable.

Definition at line 20 of file signalk_time.cpp.

set_configuration()

bool sensesp::SKOutputTime::set_configuration ( const JsonObject &  config )

overridevirtual

Sets the current state of local member variables using the data stored in config.

Reimplemented from sensesp::Configurable.

Definition at line 34 of file signalk_time.cpp.

---

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

• src/sensesp/signalk/signalk_time.h
• src/sensesp/signalk/signalk_time.cpp