esphome::text_sensor::SubstituteFilter Class Reference

A simple filter that replaces a substring with another substring. More...

#include <filter.h>

Inheritance diagram for esphome::text_sensor::SubstituteFilter:

Public Member Functions
	SubstituteFilter (const std::initializer_list< Substitution > &substitutions)
optional< std::string >	new_value (std::string value) override
Public Member Functions inherited from esphome::text_sensor::Filter
virtual void	initialize (TextSensor *parent, Filter *next)
	Initialize this filter, please note this can be called more than once.
void	input (const std::string &value)
void	output (const std::string &value)

Protected Attributes
FixedVector< Substitution >	substitutions_
Protected Attributes inherited from esphome::text_sensor::Filter
friend	TextSensor
Filter *	next_ {nullptr}
TextSensor *	parent_ {nullptr}

Detailed Description

A simple filter that replaces a substring with another substring.

Definition at line 118 of file filter.h.

Constructor & Destructor Documentation

SubstituteFilter()

esphome::text_sensor::SubstituteFilter::SubstituteFilter ( const std::initializer_list< Substitution > & substitutions )

explicit

Definition at line 71 of file filter.cpp.

Member Function Documentation

new_value()

optional< std::string > esphome::text_sensor::SubstituteFilter::new_value ( std::string value )

overridevirtual

Implements esphome::text_sensor::Filter.

Definition at line 74 of file filter.cpp.

Field Documentation

substitutions_

FixedVector<Substitution> esphome::text_sensor::SubstituteFilter::substitutions_

protected

Definition at line 124 of file filter.h.

---

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

• esphome/components/text_sensor/filter.h
• esphome/components/text_sensor/filter.cpp