Files
allwpilib/wpilibc/src/main/native/include/BuiltInAccelerometer.h
Tyler Veness 8c680a26f8 Moved C++ comments from source files to headers (#1111)
Also sorted functions in C++ sources to match order in related headers.
2018-05-31 20:47:15 -07:00

61 lines
1.7 KiB
C++

/*----------------------------------------------------------------------------*/
/* Copyright (c) 2014-2018 FIRST. 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 the root directory of */
/* the project. */
/*----------------------------------------------------------------------------*/
#pragma once
#include "ErrorBase.h"
#include "SmartDashboard/SendableBase.h"
#include "interfaces/Accelerometer.h"
namespace frc {
/**
* Built-in accelerometer.
*
* This class allows access to the roboRIO's internal accelerometer.
*/
class BuiltInAccelerometer : public ErrorBase,
public SendableBase,
public Accelerometer {
public:
/**
* Constructor.
*
* @param range The range the accelerometer will measure
*/
explicit BuiltInAccelerometer(Range range = kRange_8G);
// Accelerometer interface
/**
* Set the measuring range of the accelerometer.
*
* @param range The maximum acceleration, positive or negative, that the
* accelerometer will measure. Not all accelerometers support all
* ranges.
*/
void SetRange(Range range) override;
/**
* @return The acceleration of the roboRIO along the X axis in g-forces
*/
double GetX() override;
/**
* @return The acceleration of the roboRIO along the Y axis in g-forces
*/
double GetY() override;
/**
* @return The acceleration of the roboRIO along the Z axis in g-forces
*/
double GetZ() override;
void InitSendable(SendableBuilder& builder) override;
};
} // namespace frc