Rover API Documentation
Public Member Functions | List of all members
rover::RoverSensor Class Referenceabstract

RoverSensor class is an abstract class to define interface between common sensors used in the rover. More...

#include <rover_sensor.hpp>

Inheritance diagram for rover::RoverSensor:
rover::RoverDHT22 rover::RoverGrooveUltrasonic rover::RoverGY521 rover::RoverHCSR04 rover::RoverHMC5883L rover::RoverInfraredSensor rover::RoverQMC5883L

Public Member Functions

virtual void initialize (void)=0
 Virtual function (interface) for setting up sensors. More...
 
virtual float read (void)=0
 Virtual function (interface) for reading from sensors. More...
 
virtual ~RoverSensor ()
 Destructor for the RoverSensor class. More...
 

Detailed Description

RoverSensor class is an abstract class to define interface between common sensors used in the rover.

Constructor & Destructor Documentation

virtual rover::RoverSensor::~RoverSensor ( )
inlinevirtual

Destructor for the RoverSensor class.

Member Function Documentation

virtual void rover::RoverSensor::initialize ( void  )
pure virtual

Virtual function (interface) for setting up sensors.

Returns
void

Implemented in rover::RoverHMC5883L, rover::RoverQMC5883L, rover::RoverHCSR04, rover::RoverGY521, rover::RoverGrooveUltrasonic, rover::RoverDHT22, and rover::RoverInfraredSensor.

virtual float rover::RoverSensor::read ( void  )
pure virtual

Virtual function (interface) for reading from sensors.

Returns
sensor_val Sensor value read from sensor

Implemented in rover::RoverHMC5883L, rover::RoverQMC5883L, rover::RoverHCSR04, rover::RoverGY521, rover::RoverGrooveUltrasonic, rover::RoverDHT22, and rover::RoverInfraredSensor.

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