KettleVolSensor Class Reference

#include <Sensor.h>

Inheritance diagram for KettleVolSensor:

Public Member Functions
void	begin (void) override
	Initializes the sensors used by this object. Not needed if only using simulated sensor values.
void	read (void) override
	Reads the sensor and updates the value stored within this object.
Public Member Functions inherited from Sensor
void	simulate (void)
	Simulates a new sensor value, storing the results in this object.
const sensorVal_t	value (void) const
	Returns the sensor value.

Static Public Member Functions
static KettleVolSensor &	getInstance (void)
	Returns reference to the single instance of the KettleVolSensor class.

Additional Inherited Members
Public Types inherited from Sensor
using	sensorVal_t = float
	Type definition used by Sensor class.
Protected Member Functions inherited from Sensor
	Sensor (sensorVal_t initialValue, sensorVal_t maxVal, sensorVal_t minVal, sensorVal_t simDelta)
	Protected constructor for Sensor.
	~Sensor (void)=default
	Destroy the Sensor object.
Protected Attributes inherited from Sensor
sensorVal_t	_value
	Most recent sensor reading.

Member Function Documentation

begin()

void KettleVolSensor::begin ( void )

overridevirtual

Initializes the sensors used by this object. Not needed if only using simulated sensor values.

Parameters

None.

Implements Sensor.

getInstance()

static KettleVolSensor & KettleVolSensor::getInstance ( void )

inlinestatic

Returns reference to the single instance of the KettleVolSensor class.

Returns

Reference to the KettleVolSensor object

read()

void KettleVolSensor::read ( void )

overridevirtual

Reads the sensor and updates the value stored within this object.

Parameters

None.

Implements Sensor.

---

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

• C:/Users/david/Documents/PlatformIO/Solo_Controller/Solo_Controller_Repo/src/Sensor.h
• C:/Users/david/Documents/PlatformIO/Solo_Controller/Solo_Controller_Repo/src/Sensor.cpp