Rover API Documentation
rover_api.hpp
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2017 FH Dortmund and others
3  * All rights reserved. This program and the accompanying materials
4  * are made available under the terms of the Eclipse Public License v1.0
5  * which accompanies this distribution, and is available at
6  * http://www.eclipse.org/legal/epl-v10.html
7  *
8  * Description:
9  * Rover API - Interfaces for basic Rover application development - Header file
10  *
11  * Contributors:
12  * M.Ozcelikors <mozcelikors@gmail.com>, created API 17.11.2017
13  *
14  */
15 
16 #ifndef ROVER_API_HPP_
17 #define ROVER_API_HPP_
18 
19 #include <stdint.h>
20 
21 
293 namespace rover
294 {
295 
299  class RoverBase
300  {
301 
302  public:
306  explicit RoverBase();
307 
311  virtual ~RoverBase();
312 
324  void initialize (void);
325 
330  void shutdown (void);
331 
337  void sleep (const unsigned int period_ms);
338 
339  private:
344  void initializeWiringPi (void);
345 
350  };
351 }
352 
353 
354 
355 #endif /* ROVER_API_HPP_ */
RoverBase()
Constructor for the RoverBase class.
Definition: rover_api.cpp:29
RoverBase class provides basic rover functions such as initialization, sleeping, and shutting down...
Definition: rover_api.hpp:299
void sleep(const unsigned int period_ms)
Sleep function to be used in rover applications.
Definition: rover_api.cpp:138
rover Namespace contains classes to manage Rover sensors, gpio, buzzer, buttons, driving, utilities, and cloud.
Definition: rover_api.hpp:293
virtual ~RoverBase()
Destructor for the RoverBase class.
Definition: rover_api.cpp:38
void initializeWiringPi(void)
Initializes wiringPi library to access GPIO of Rover. This function should be called in every program...
Definition: rover_api.cpp:49
void shutdown(void)
Shuts down the Rover&#39;s OS.
Definition: rover_api.cpp:62
int WIRINGPI_INIT_
Flag for indicating whether wiringPi library initialized or not.
Definition: rover_api.hpp:349
void initialize(void)
Initializes the wiringPi library.
Definition: rover_api.cpp:44