mirror of
https://github.com/wpilibsuite/allwpilib
synced 2026-06-19 00:41:43 +00:00
7eb8550bdb
The changes made in this commit do not affect any actual code,
they are purely aesthetic. I ran clang-format with google style
over all .h/.cpp files in wpilibc that weren't in wpilibC++Sim
or gtest, and the eclipse formatter over all of the Java files
using the Google eclipse formatting configuration.
Change-Id: I9627bca0bc103c398ecc1c5ba17467193291ae63
46 lines
1.4 KiB
C++
46 lines
1.4 KiB
C++
/*----------------------------------------------------------------------------*/
|
|
/* Copyright (c) FIRST 2014. All Rights Reserved. */
|
|
/* Open Source Software - may be modified and shared by FRC teams. The code */
|
|
/* must be accompanied by the FIRST BSD license file in $(WIND_BASE)/WPILib. */
|
|
/*----------------------------------------------------------------------------*/
|
|
#pragma once
|
|
|
|
/**
|
|
* Interface for 3-axis accelerometers
|
|
*/
|
|
class Accelerometer {
|
|
public:
|
|
virtual ~Accelerometer(){};
|
|
|
|
enum Range { kRange_2G = 0, kRange_4G = 1, kRange_8G = 2, kRange_16G = 3 };
|
|
|
|
/**
|
|
* Common interface for setting the measuring range of an accelerometer.
|
|
*
|
|
* @param range The maximum acceleration, positive or negative, that the
|
|
* accelerometer will measure. Not all accelerometers support all ranges.
|
|
*/
|
|
virtual void SetRange(Range range) = 0;
|
|
|
|
/**
|
|
* Common interface for getting the x axis acceleration
|
|
*
|
|
* @return The acceleration along the x axis in g-forces
|
|
*/
|
|
virtual double GetX() = 0;
|
|
|
|
/**
|
|
* Common interface for getting the y axis acceleration
|
|
*
|
|
* @return The acceleration along the y axis in g-forces
|
|
*/
|
|
virtual double GetY() = 0;
|
|
|
|
/**
|
|
* Common interface for getting the z axis acceleration
|
|
*
|
|
* @return The acceleration along the z axis in g-forces
|
|
*/
|
|
virtual double GetZ() = 0;
|
|
};
|