SensESP 3.0.1
Universal Signal K sensor toolkit ESP32
Loading...
Searching...
No Matches
sensesp::TextToTruth Class Reference

Consumes a string and outputs boolean "true" if the text represents a human readable version of "true". More...

#include <sensesp/transforms/truth_text.h>

Inheritance diagram for sensesp::TextToTruth:
[legend]

Public Member Functions

virtual void set (const String &input) override
 
- Public Member Functions inherited from sensesp::Transform< String, bool >
 Transform (String config_path="")
 
Transform< String, bool > * connect_from (ValueProducer< bool > *producer0, ValueProducer< bool > *producer1=NULL, ValueProducer< bool > *producer2=NULL, ValueProducer< bool > *producer3=NULL, ValueProducer< bool > *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
virtual bool to_json (JsonObject &root)
 
virtual bool from_json (const JsonObject &root)
 
- Public Member Functions inherited from sensesp::ValueConsumer< String >
virtual void set_input (const String &new_value)
 
void connect_from (ValueProducer< String > *producer)
 
- Public Member Functions inherited from sensesp::ValueProducer< bool >
 ValueProducer ()
 
 ValueProducer (const bool &initial_value)
 
virtual const bool & get () const
 
std::enable_if< std::is_base_of< ValueConsumer< typenameVConsumer::input_type >, VConsumer >::value &&std::is_convertible< bool, 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.
 
std::enable_if< std::is_base_of< ValueConsumer< typenameVConsumer::input_type >, VConsumer >::value &&std::is_convertible< bool, typenameVConsumer::input_type >::value, VConsumer * >::type connect_to (VConsumer *consumer)
 
std::enable_if< std::is_base_of< ValueConsumer< typenameVConsumer::input_type >, VConsumer >::value &&std::is_convertible< bool, typenameVConsumer::input_type >::value, VConsumer * >::type connect_to (VConsumer &consumer)
 
void emit (const bool &new_value)
 
- Public Member Functions inherited from sensesp::Observable
 Observable ()
 
 Observable (Observable &&other)
 Move constructor.
 
void notify ()
 
void attach (std::function< void()> observer)
 

Static Public Member Functions

static bool is_valid_true (const String &value)
 
static bool is_valid_false (const String &value)
 
- Static Public Member Functions inherited from sensesp::TransformBase
static const std::set< TransformBase * > & get_transforms ()
 

Additional Inherited Members

- Public Types inherited from sensesp::ValueConsumer< String >
using input_type
 
- Protected Attributes inherited from sensesp::Saveable
const String config_path_
 
- Protected Attributes inherited from sensesp::ValueProducer< bool >
bool output_
 

Detailed Description

Consumes a string and outputs boolean "true" if the text represents a human readable version of "true".

The following case-insensitive values are considered true:

  • True
  • T
  • Yes
  • Y
  • On
  • Any string that represents a non-zero number
See also
TruthToText

Definition at line 24 of file truth_text.h.

Member Function Documentation

◆ is_valid_false()

bool sensesp::TextToTruth::is_valid_false ( const String & value)
static

Returns TRUE if value represents one of the boolean values recognized as a "false" value. FALSE is returned if value is a value that is normally associated with a boolean false.

Definition at line 25 of file truth_text.cpp.

◆ is_valid_true()

bool sensesp::TextToTruth::is_valid_true ( const String & value)
static

Returns TRUE if value represents one of the truth values recognized by TextToTruth

Definition at line 7 of file truth_text.cpp.

Here is the caller graph for this function:

◆ set()

void sensesp::TextToTruth::set ( const String & new_value)
overridevirtual

Used to set an input of this consumer. It is called automatically by a ValueProducer but can also be called manually.

Parameters
new_valuethe value of the input

Reimplemented from sensesp::ValueConsumer< String >.

Definition at line 40 of file truth_text.cpp.

Here is the call graph for this function:

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