YARP
Yet Another Robot Platform
yarp::dev::ITemperatureSensors Class Referenceabstract

Device interface to one or multiple temperature sensors. More...

#include <yarp/dev/MultipleAnalogSensorsInterfaces.h>

+ Inheritance diagram for yarp::dev::ITemperatureSensors:

Public Member Functions

virtual size_t getNrOfTemperatureSensors () const =0
 Get the number of temperature sensors exposed by this device. More...
 
virtual yarp::dev::MAS_status getTemperatureSensorStatus (size_t sens_index) const =0
 Get the status of the specified sensor. More...
 
virtual bool getTemperatureSensorName (size_t sens_index, std::string &name) const =0
 Get the name of the specified sensor. More...
 
virtual bool getTemperatureSensorFrameName (size_t sens_index, std::string &frameName) const =0
 Get the name of the frame of the specified sensor. More...
 
virtual bool getTemperatureSensorMeasure (size_t sens_index, double &out, double &timestamp) const =0
 Get the last reading of the specified sensor. More...
 
virtual bool getTemperatureSensorMeasure (size_t sens_index, yarp::sig::Vector &out, double &timestamp) const =0
 Get the last reading of the specified sensor. More...
 
virtual ~ITemperatureSensors ()
 

Detailed Description

Device interface to one or multiple temperature sensors.

Sensor Tag
TemperatureSensors

Definition at line 357 of file MultipleAnalogSensorsInterfaces.h.

Constructor & Destructor Documentation

◆ ~ITemperatureSensors()

virtual yarp::dev::ITemperatureSensors::~ITemperatureSensors ( )
inlinevirtual

Definition at line 397 of file MultipleAnalogSensorsInterfaces.h.

Member Function Documentation

◆ getNrOfTemperatureSensors()

virtual size_t yarp::dev::ITemperatureSensors::getNrOfTemperatureSensors ( ) const
pure virtual

Get the number of temperature sensors exposed by this device.

Implemented in MultipleAnalogSensorsRemapper, and MultipleAnalogSensorsClient.

◆ getTemperatureSensorFrameName()

virtual bool yarp::dev::ITemperatureSensors::getTemperatureSensorFrameName ( size_t  sens_index,
std::string &  frameName 
) const
pure virtual

Get the name of the frame of the specified sensor.

Implemented in MultipleAnalogSensorsRemapper, and MultipleAnalogSensorsClient.

◆ getTemperatureSensorMeasure() [1/2]

virtual bool yarp::dev::ITemperatureSensors::getTemperatureSensorMeasure ( size_t  sens_index,
double &  out,
double &  timestamp 
) const
pure virtual

Get the last reading of the specified sensor.

TODO(traversaro) : make the method swig-friendly

Implemented in MultipleAnalogSensorsRemapper, and MultipleAnalogSensorsClient.

◆ getTemperatureSensorMeasure() [2/2]

virtual bool yarp::dev::ITemperatureSensors::getTemperatureSensorMeasure ( size_t  sens_index,
yarp::sig::Vector out,
double &  timestamp 
) const
pure virtual

Get the last reading of the specified sensor.

Parameters
[in]sens_indexThe index of the specified sensor (should be between 0 and getNrOfTemperatureSensors()-1).
[out]outThe requested measure. The vector should be 1-dimensional. The measure is expressed in celsius degrees .
[out]timestampThe timestamp of the requested measure, expressed in seconds.
Returns
false if an error occurred, true otherwise.

Implemented in MultipleAnalogSensorsRemapper, and MultipleAnalogSensorsClient.

◆ getTemperatureSensorName()

virtual bool yarp::dev::ITemperatureSensors::getTemperatureSensorName ( size_t  sens_index,
std::string &  name 
) const
pure virtual

Get the name of the specified sensor.

Implemented in MultipleAnalogSensorsRemapper, and MultipleAnalogSensorsClient.

◆ getTemperatureSensorStatus()

virtual yarp::dev::MAS_status yarp::dev::ITemperatureSensors::getTemperatureSensorStatus ( size_t  sens_index) const
pure virtual

Get the status of the specified sensor.

Implemented in MultipleAnalogSensorsRemapper, and MultipleAnalogSensorsClient.


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