Time-of-Flight-SDK
Public Member Functions | List of all members
aditof::TemperatureSensorInterface Class Referenceabstract

Interface for a temperature sensor. More...

#include <temperature_sensor_interface.h>

Public Member Functions

virtual ~TemperatureSensorInterface ()=default
 Destructor.
 
virtual aditof::Status open (void *handle)=0
 Open the communication channel with the temperature sensor. More...
 
virtual aditof::Status read (float &temperature)=0
 Read data from the temperature sensor. More...
 
virtual aditof::Status close ()=0
 Close the communication channel with the EEPROM. More...
 
virtual aditof::Status getName (std::string &name) const =0
 Retrieves the name of the temperature sensor. More...
 

Detailed Description

Interface for a temperature sensor.

Definition at line 46 of file temperature_sensor_interface.h.

Member Function Documentation

◆ close()

virtual aditof::Status aditof::TemperatureSensorInterface::close ( )
pure virtual

Close the communication channel with the EEPROM.

Returns
Status

◆ getName()

virtual aditof::Status aditof::TemperatureSensorInterface::getName ( std::string &  name) const
pure virtual

Retrieves the name of the temperature sensor.

Parameters
[out]name- This gets set with the name of the temperature sensor
Returns
Status

◆ open()

virtual aditof::Status aditof::TemperatureSensorInterface::open ( void *  handle)
pure virtual

Open the communication channel with the temperature sensor.

Parameters
handle- A handle to the object through which communication is done
Returns
Status

◆ read()

virtual aditof::Status aditof::TemperatureSensorInterface::read ( float &  temperature)
pure virtual

Read data from the temperature sensor.

Parameters
[out]temperature- This is set with the temperature read from the sensor
Returns
Status

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