Rover API Documentation
rover::RoverBase Class Reference

RoverBase class provides basic rover functions such as initialization, sleeping, and shutting down. More...

#include <rover_api.hpp>

Public Member Functions

 RoverBase ()
 Constructor for the RoverBase class. More...
 
virtual ~RoverBase ()
 Destructor for the RoverBase class. More...
 
void initialize (void)
 Initializes the wiringPi library. More...
 
void shutdown (void)
 Shuts down the Rover's OS. More...
 
void sleep (const unsigned int period_ms)
 Sleep function to be used in rover applications. More...
 

Private Member Functions

void initializeWiringPi (void)
 Initializes wiringPi library to access GPIO of Rover. This function should be called in every program run and must only be called once. More...
 

Private Attributes

int WIRINGPI_INIT_
 Flag for indicating whether wiringPi library initialized or not. More...
 

Detailed Description

RoverBase class provides basic rover functions such as initialization, sleeping, and shutting down.

Constructor & Destructor Documentation

rover::RoverBase::RoverBase ( )
explicit

Constructor for the RoverBase class.

rover::RoverBase::~RoverBase ( )
virtual

Destructor for the RoverBase class.

Member Function Documentation

void rover::RoverBase::initialize ( void  )

Initializes the wiringPi library.

Returns
void
Warning
This function should be called once per application.
RoverBase r_base = RoverBase();
r_base.initialize();
//.. Here comes all the rover objects and apps..
void rover::RoverBase::initializeWiringPi ( void  )
private

Initializes wiringPi library to access GPIO of Rover. This function should be called in every program run and must only be called once.

Returns
void
void rover::RoverBase::shutdown ( void  )

Shuts down the Rover's OS.

Returns
void
void rover::RoverBase::sleep ( const unsigned int  period_ms)

Sleep function to be used in rover applications.

Parameters
period_msPeriod to sleep in milliseconds
Returns
void

Member Data Documentation

int rover::RoverBase::WIRINGPI_INIT_
private

Flag for indicating whether wiringPi library initialized or not.


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