SensESP 3.4.1-alpha
Universal Signal K sensor toolkit ESP32
Loading...
Searching...
No Matches
sensesp::SKOutputTime Class Reference

#include <sensesp/signalk/signalk_time.h>

Inheritance diagram for sensesp::SKOutputTime:
[legend]

Public Member Functions

 SKOutputTime (const String &sk_path, const String &config_path="")
 
virtual void as_signalk_json (JsonDocument &doc) override
 
virtual bool to_json (JsonObject &doc) override
 
virtual bool from_json (const JsonObject &config) override
 
- Public Member Functions inherited from sensesp::TimeString
 TimeString (const String &config_path="")
 
virtual void set (const time_t &input) 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 (const String &config_path)
 
virtual ~TransformBase ()
 
- 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::ValueConsumer< T >
virtual void set (const T &new_value)
 
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)
 
- Public Member Functions inherited from sensesp::Observable
 Observable ()
 
 Observable (Observable &&other)
 Move constructor.
 
void notify ()
 
int attach (std::function< void()> observer)
 Attach an observer callback.
 
void detach (int id)
 Remove a previously attached observer by its ID.
 
- Public Member Functions inherited from sensesp::SKEmitter
 SKEmitter (const String &sk_path)
 
virtual ~SKEmitter ()
 
virtual SKMetadataget_metadata ()
 
virtual void add_metadata (JsonArray &meta)
 
String & get_sk_path ()
 
void set_sk_path (const String &path)
 

Additional Inherited Members

- Public Types inherited from sensesp::ValueConsumer< T >
using input_type = T
 
- Static Public Member Functions inherited from sensesp::TransformBase
static const std::set< TransformBase * > & get_transforms ()
 
static void clear_registry ()
 
- Static Public Member Functions inherited from sensesp::SKEmitter
static const std::vector< SKEmitter * > & get_sources ()
 
static void clear_registry ()
 
- Protected Attributes inherited from sensesp::Saveable
const String config_path_
 
- Protected Attributes inherited from sensesp::ValueProducer< T >
output_
 
- Protected Attributes inherited from sensesp::SKEmitter
String sk_path_ {}
 

Detailed Description

Definition at line 10 of file signalk_time.h.

Constructor & Destructor Documentation

◆ SKOutputTime()

sensesp::SKOutputTime::SKOutputTime ( const String &  sk_path,
const 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_json()

void sensesp::SKOutputTime::as_signalk_json ( JsonDocument &  doc)
overridevirtual

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

Reimplemented from sensesp::SKEmitter.

Definition at line 11 of file signalk_time.cpp.

◆ from_json()

bool sensesp::SKOutputTime::from_json ( const JsonObject &  root)
overridevirtual

Deserializes the current object data from a JsonObject.

Reimplemented from sensesp::Serializable.

Definition at line 21 of file signalk_time.cpp.

◆ to_json()

bool sensesp::SKOutputTime::to_json ( JsonObject &  root)
overridevirtual

Serializes the current object data into a JsonObject.

Reimplemented from sensesp::Serializable.

Definition at line 16 of file signalk_time.cpp.


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