rover::RoverGrooveUltrasonic Class Reference

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

#include <rover_grooveultrasonic.hpp>

Inheritance diagram for rover::RoverGrooveUltrasonic:

Public Member Functions
	RoverGrooveUltrasonic (const RoverSensorID_t sensor_id)
	Constructor for the RoverGrooveUltrasonic class. More...
	~RoverGrooveUltrasonic ()
	Destructor for the RoverGrooveUltrasonic class. More...
void	initialize (void)
	Function to setup Groove Ultrasonic sensor. More...
float	read (void)
	Member function to read from Groove ultrasonic sensor given its sensor id. More...
void	setSigPin (const int sig_pin)
	Sets the private attribute sigPin for Groove Ultrasonic Sensor. More...
int	getSigPin (void)
	Returns the private attribute sigPin for Groove Ultrasonic Sensor. 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	sigPin
	Signal pin. More...

Detailed Description

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

Constructor & Destructor Documentation

rover::RoverGrooveUltrasonic::RoverGrooveUltrasonic ( const RoverSensorID_t  sensor_id )

explicit

Constructor for the RoverGrooveUltrasonic class.

Parameters

sensor_id

Sensor to address

rover::RoverGrooveUltrasonic::~RoverGrooveUltrasonic

(

)

Destructor for the RoverGrooveUltrasonic class.

Member Function Documentation

int rover::RoverGrooveUltrasonic::getSigPin

(

void

)

Returns the private attribute sigPin for Groove Ultrasonic Sensor.

Returns

sig_pin Pin in wiringPi format for Groove Ultrasonic Sensor

void rover::RoverGrooveUltrasonic::initialize ( void  )

virtual

Function to setup Groove Ultrasonic sensor.

Returns

void

Implements rover::RoverSensor.

float rover::RoverGrooveUltrasonic::read ( void  )

virtual

Member function to read from Groove ultrasonic sensor given its sensor id.

Returns

sensor_val Sensor value read in centimeters from sensor

Implements rover::RoverSensor.

void rover::RoverGrooveUltrasonic::setSigPin

(

const int

sig_pin

)

Sets the private attribute sigPin for Groove Ultrasonic Sensor.

Parameters

sig_pin

Pin in wiringPi format for Groove Ultrasonic Sensor

Returns

void

Member Data Documentation

RoverSensorID_t rover::RoverGrooveUltrasonic::sensorID

private

Sensor Identification.

int rover::RoverGrooveUltrasonic::sigPin

private

Signal pin.

---

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

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