WPILibC++  unspecified
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Pages
Public Types | Public Member Functions | List of all members
Accelerometer Class Referenceabstract

Interface for 3-axis accelerometers. More...

#include <Accelerometer.h>

Inheritance diagram for Accelerometer:
ADXL345_I2C ADXL345_SPI ADXL362 BuiltInAccelerometer

Public Types

enum  Range { kRange_2G = 0, kRange_4G = 1, kRange_8G = 2, kRange_16G = 3 }
 

Public Member Functions

virtual void SetRange (Range range)=0
 Common interface for setting the measuring range of an accelerometer. More...
 
virtual double GetX ()=0
 Common interface for getting the x axis acceleration. More...
 
virtual double GetY ()=0
 Common interface for getting the y axis acceleration. More...
 
virtual double GetZ ()=0
 Common interface for getting the z axis acceleration. More...
 

Detailed Description

Interface for 3-axis accelerometers.

Member Function Documentation

virtual double Accelerometer::GetX ( )
pure virtual

Common interface for getting the x axis acceleration.

Returns
The acceleration along the x axis in g-forces

Implemented in ADXL345_SPI, ADXL345_I2C, ADXL362, and BuiltInAccelerometer.

virtual double Accelerometer::GetY ( )
pure virtual

Common interface for getting the y axis acceleration.

Returns
The acceleration along the y axis in g-forces

Implemented in ADXL345_SPI, ADXL345_I2C, ADXL362, and BuiltInAccelerometer.

virtual double Accelerometer::GetZ ( )
pure virtual

Common interface for getting the z axis acceleration.

Returns
The acceleration along the z axis in g-forces

Implemented in ADXL345_SPI, ADXL345_I2C, ADXL362, and BuiltInAccelerometer.

virtual void Accelerometer::SetRange ( Range  range)
pure virtual

Common interface for setting the measuring range of an accelerometer.

Parameters
rangeThe maximum acceleration, positive or negative, that the accelerometer will measure. Not all accelerometers support all ranges.

Implemented in ADXL345_SPI, ADXL345_I2C, ADXL362, and BuiltInAccelerometer.

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