Diff: Sensors/GyroSensor.h

Revision:

3:b1bb477e115e

Parent:

1:a7810e7acf8d

--- a/Sensors/GyroSensor.h	Tue Nov 29 17:43:48 2016 +0000
+++ b/Sensors/GyroSensor.h	Fri Mar 10 10:50:53 2017 +0100
@@ -36,71 +36,78 @@
  ******************************************************************************
  */
 
+
 /* Define to prevent from recursive inclusion --------------------------------*/
+
 #ifndef __GYRO_SENSOR_CLASS_H
 #define __GYRO_SENSOR_CLASS_H
 
+
 /* Includes ------------------------------------------------------------------*/
-#include <ComponentObject.h>
+
+#include <Component.h>
+
 
 /* Classes  ------------------------------------------------------------------*/
-/** An abstract class for a Gyroscope
+
+/**
+ * An abstract class for a Gyroscope
  */
-class GyroSensor : public ComponentObject
-{
- public:
+class GyroSensor : public Component {
+public:
+
 	/**
 	 * @brief       Get current gyroscope angular rate X/Y/Z-axes values 
 	 *              in standard data units [mdps]
-	 * @param[out]  pData Pointer to where to store angular rates to.
-	 *              pData must point to an array of (at least) three elements, where:
-	 *              pData[0] corresponds to X-axis,
-	 *              pData[1] corresponds to Y-axis, and
-	 *              pData[2] corresponds to Z-axis.
+	 * @param[out]  p_data Pointer to where to store angular rates to.
+	 *              p_data must point to an array of (at least) three elements, where:
+	 *              p_data[0] corresponds to X-axis,
+	 *              p_data[1] corresponds to Y-axis, and
+	 *              p_data[2] corresponds to Z-axis.
 	 * @return      0 in case of success, an error code otherwise
 	 */
-	virtual int Get_G_Axes(int32_t *pData) = 0;
+	virtual int get_g_axes(int32_t *p_data) = 0;
 
 	/**
 	 * @brief       Get current gyroscope raw data X/Y/Z-axes values 
 	 *              in device sepcific LSB units
-	 * @param[out]  pData Pointer to where to store gyroscope raw data to.
-	 *              pData must point to an array of (at least) three elements, where:
-	 *              pData[0] corresponds to X-axis,
-	 *              pData[1] corresponds to Y-axis, and
-	 *              pData[2] corresponds to Z-axis.
+	 * @param[out]  p_data Pointer to where to store gyroscope raw data to.
+	 *              p_data must point to an array of (at least) three elements, where:
+	 *              p_data[0] corresponds to X-axis,
+	 *              p_data[1] corresponds to Y-axis, and
+	 *              p_data[2] corresponds to Z-axis.
 	 * @return      0 in case of success, an error code otherwise
 	 */
-	virtual int Get_G_AxesRaw(int16_t *pData) = 0;
+	virtual int get_g_axes_raw(int16_t *p_data) = 0;
 
 	/**
 	 * @brief       Get gyroscope's current sensitivity [mdps/LSB]
-	 * @param[out]  pfData Pointer to where the gyroscope's sensitivity is stored to
+	 * @param[out]  pf_data Pointer to where the gyroscope's sensitivity is stored to
 	 * @return      0 in case of success, an error code otherwise
 	 */
-	virtual int Get_G_Sensitivity(float *pfData) = 0;
+	virtual int get_g_sensitivity(float *pf_data) = 0;
 	
 	/**
 	 * @brief       Get gyroscope's current output data rate [Hz]
-	 * @param[out]  pfData Pointer to where the gyroscope output data rate is stored to
+	 * @param[out]  pf_data Pointer to where the gyroscope output data rate is stored to
 	 * @return      0 in case of success, an error code otherwise
 	 */
-	virtual int Get_G_ODR(float *pfData) = 0;
+	virtual int get_g_odr(float *pf_data) = 0;
 
 	/**
 	 * @brief      Set gyroscope's output data rate
 	 * @param[in]  odr New value for gyroscope's output data rate in [Hz]
 	 * @return     0 in case of success, an error code otherwise
 	 */
-	virtual int Set_G_ODR(float odr) = 0;
+	virtual int set_g_odr(float odr) = 0;
 	
 	/**
 	 * @brief       Get gyroscope's full scale value
 	 *              i.e.\ min/max measurable value [dps]
-	 * @param[out]  pfData Pointer to where the gyroscope full scale value is stored to
+	 * @param[out]  pf_data Pointer to where the gyroscope full scale value is stored to
 	 * @return      0 in case of success, an error code otherwise
 	 */
-	virtual int Get_G_FS(float *pfData) = 0;
+	virtual int get_g_fs(float *pf_data) = 0;
 	
 	/**
 	 * @brief      Set gyroscope's full scale value
@@ -108,7 +115,12 @@
 	 * @param[in]  fs New full scale value for gyroscope in [dps]
 	 * @return     0 in case of success, an error code otherwise
 	 */
-	virtual int Set_G_FS(float fs) = 0;
+	virtual int set_g_fs(float fs) = 0;
+
+    /**
+     * @brief Destructor.
+     */
+	virtual ~GyroSensor() {};
 };
 
 #endif /* __GYRO_SENSOR_CLASS_H */