frc::Accelerometer Class Reference

Interface for 3-axis accelerometers. More...

#include <frc/interfaces/Accelerometer.h>

Inheritance diagram for frc::Accelerometer:

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

Public Member Functions
	Accelerometer ()=default
virtual	~Accelerometer ()=default
	Accelerometer (Accelerometer &&)=default
Accelerometer &	operator= (Accelerometer &&)=default
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 Enumeration Documentation

Range

enum frc::Accelerometer::Range

Enumerator
kRange_2G
kRange_4G
kRange_8G
kRange_16G

Constructor & Destructor Documentation

Accelerometer() [1/2]

frc::Accelerometer::Accelerometer ( )

default

~Accelerometer()

virtual frc::Accelerometer::~Accelerometer ( )

virtualdefault

Accelerometer() [2/2]

frc::Accelerometer::Accelerometer ( Accelerometer &&  )

default

Member Function Documentation

GetX()

virtual double frc::Accelerometer::GetX ( )

pure virtual

Common interface for getting the x axis acceleration.

Returns

The acceleration along the x axis in g-forces

Implemented in frc::ADXL345_I2C, frc::ADXL345_SPI, frc::ADXL362, and frc::BuiltInAccelerometer.

GetY()

virtual double frc::Accelerometer::GetY ( )

pure virtual

Common interface for getting the y axis acceleration.

Returns

The acceleration along the y axis in g-forces

Implemented in frc::ADXL345_I2C, frc::ADXL345_SPI, frc::ADXL362, and frc::BuiltInAccelerometer.

GetZ()

virtual double frc::Accelerometer::GetZ ( )

pure virtual

Common interface for getting the z axis acceleration.

Returns

The acceleration along the z axis in g-forces

Implemented in frc::ADXL345_I2C, frc::ADXL345_SPI, frc::ADXL362, and frc::BuiltInAccelerometer.

operator=()

Accelerometer & frc::Accelerometer::operator= ( Accelerometer &&  )

default

SetRange()

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

pure virtual

Common interface for setting the measuring range of an accelerometer.

Parameters

range

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

Implemented in frc::ADXL345_I2C, frc::ADXL345_SPI, frc::ADXL362, and frc::BuiltInAccelerometer.

---

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

• frc/interfaces/Accelerometer.h