alexey.zholtikov/upm
1
0
Fork 0
mirror of https://github.com/eclipse/upm.git synced 2025-12-16 22:05:18 +03:00
Code Issues Actions Packages Projects Releases Wiki Activity

kxtj3: fixed requested issues

Browse Source 
* Virtual destructor
* Add header guards
* Constructor default values
* Remove methods with pointer parameters in C++ code

Signed-off-by: Assam Boudjelthia <assam.boudjelthia@fi.rohmeurope.com>
Signed-off-by: Noel Eck <noel.eck@intel.com>
This commit is contained in:
Assam Boudjelthia
2018-06-19 12:33:01 +03:00
committed by Noel Eck
parent 09e536b4ff
commit 01cc3a0734
5 changed files with 47 additions and 63 deletions
Download Patch File Download Diff File Expand all files Collapse all files

34
src/kxtj3/kxtj3.hpp
View File

@@ -22,6 +22,8 @@
* CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*/
#pragma once
#include <vector>
#include <mraa/gpio.hpp>
@@ -30,7 +32,7 @@
/**
* @brief C API for the kxtj3 driver
* @defgroup kxtj3 libupm-kxtj3
* @ingroup Kionix i2c acceleromter
* @ingroup Kionix i2c accelerometer
*
* @include kxtj3.cxx
*/
@@ -39,7 +41,7 @@
* @library kxtj3
* @sensor kxtj3
* @comname tri-axis accelerometer
* @type acceleromter
* @type accelerometer
* @man Kionix
* @con i2c
*
@@ -62,7 +64,7 @@ public:
* @param addr I2C address of the sensor
* @throws std::runtime_error on initialization failure
*/
KXTJ3(int bus, uint8_t addr);
KXTJ3(int bus, uint8_t addr = 0x0f);
/**
* @brief KXTJ3 destructor
@@ -72,7 +74,7 @@ public:
*
* @throws std::runtime_error on initialization failure
*/
~KXTJ3();
virtual ~KXTJ3();
/**
* @brief Initializes the sensor with given sampling rate, resolution and acceleration range.
@@ -194,26 +196,6 @@ public:
*/
void SensorSoftwareReset();
/**
* @brief Gets raw accelerometer data from the sensor
*
* @param x Pointer to a floating point variable to store the x-axis value. Set to NULL if not wanted.
* @param y Pointer to a floating point variable to store the y-axis value. Set to NULL if not wanted.
* @param z Pointer to a floating point variable to store the z-axis value. Set to NULL if not wanted.
* @throws std::runtime_error on failure
*/
void GetAccelerationRaw(float *x, float *y, float *z);
/**
* @brief Gets converted (m/s^2) accelerometer data from the sensor
*
* @param x Pointer to a floating point variable to store the x-axis value. Set to NULL if not wanted.
* @param y Pointer to a floating point variable to store the y-axis value. Set to NULL if not wanted.
* @param z Pointer to a floating point variable to store the z-axis value. Set to NULL if not wanted.
* @throws std::runtime_error on failure
*/
void GetAcceleration(float *x, float *y, float *z);
/**
* Gets raw acceleration data from the sensor.
*
@@ -575,5 +557,9 @@ public:
private:
kxtj3_context m_kxtj3;
/* Disable implicit copy and assignment operators */
KXTJ3(const KXTJ3 &) = delete;
KXTJ3 &operator=(const KXTJ3 &) = delete;
};
} // namespace upm