rover::RoverInfraredSensor Class Reference

RoverInfraredSensor is a class that is inherited from RoverSensor abstract class. RoverInfraredSensor class contains member functions and variables to set up and read from SHARP infrared sensors that are embedded on the rover. More...

#include <rover_infraredsensor.hpp>

Inheritance diagram for rover::RoverInfraredSensor:

Public Member Functions
	RoverInfraredSensor (const RoverSensorID_t sensor_id)
	Constructor for the RoverInfraredSensor class. More...
	~RoverInfraredSensor ()
	Destructor for the RoverInfraresSensor class. More...
void	initialize (void)
	Function to setup Analog to Digital converter used in infrared sensors. Should be called once per program. More...
float	read (void)
	Member function to read from infrared proximity sensor given its sensor id. More...
Public Member Functions inherited from rover::RoverSensor
virtual	~RoverSensor ()
	Destructor for the RoverSensor class. More...

Private Attributes
RoverSensorID_t	sensorID
	Sensor Identification. More...
int	ROVERINFRAREDSENSOR_SETUP_
	Flag to hold if RoverInfraredSensor is set up. More...

Detailed Description

RoverInfraredSensor is a class that is inherited from RoverSensor abstract class. RoverInfraredSensor class contains member functions and variables to set up and read from SHARP infrared sensors that are embedded on the rover.

Constructor & Destructor Documentation

rover::RoverInfraredSensor::RoverInfraredSensor ( const RoverSensorID_t  sensor_id )

explicit

Constructor for the RoverInfraredSensor class.

Parameters

sensor_id

Sensor to address

rover::RoverInfraredSensor::~RoverInfraredSensor

(

)

Destructor for the RoverInfraresSensor class.

Member Function Documentation

void rover::RoverInfraredSensor::initialize ( void  )

virtual

Function to setup Analog to Digital converter used in infrared sensors. Should be called once per program.

Returns

void

Implements rover::RoverSensor.

float rover::RoverInfraredSensor::read ( void  )

virtual

Member function to read from infrared proximity sensor given its sensor id.

Returns

sensor_val Sensor value read in centimeters from sensor

Implements rover::RoverSensor.

Member Data Documentation

int rover::RoverInfraredSensor::ROVERINFRAREDSENSOR_SETUP_

private

Flag to hold if RoverInfraredSensor is set up.

RoverSensorID_t rover::RoverInfraredSensor::sensorID

private

Sensor Identification.

---

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

• /home/travis/build/app4mc-rover/rover-app/include/roverapi/rover_infraredsensor.hpp
• /home/travis/build/app4mc-rover/rover-app/src/roverapi/rover_infraredsensor.cpp