SensESP 2.7.2
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_input (String input, uint8_t input_channel=0) 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 (String config_path="")
 
- Public Member Functions inherited from sensesp::Configurable
 Configurable (String config_path="", String description="", int sort_order=1000)
 
virtual void get_configuration (JsonObject &configObject)
 
virtual bool set_configuration (const JsonObject &config)
 
virtual String get_config_schema ()
 
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)
 

Static Public Member Functions

static bool is_valid_true (String value)
 
static bool is_valid_false (String value)
 
- 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 ()
 

Additional Inherited Members

- 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 >
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 ( 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 23 of file truth_text.cpp.

Here is the caller graph for this function:

◆ is_valid_true()

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

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

Definition at line 5 of file truth_text.cpp.

Here is the caller graph for this function:

◆ set_input()

void sensesp::TextToTruth::set_input ( String  input,
uint8_t  input_channel = 0 
)
overridevirtual

Definition at line 38 of file truth_text.cpp.

Here is the call graph for this function:

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