mirror of
https://github.com/wpilibsuite/allwpilib
synced 2026-06-21 01:01:43 +00:00
6d854afb0e
This is a major restructuring of the WPILib repository to simply build procedures and remove the remnants of Maven from everything except the eclipse plugins. Gradle files have been largely simplified or rewritten, taking advantage of splitting up parts of the build into separate build files for ease of reading. The eclipse plugins are now in a separate project, as is ntcore. All dependencies are resolved via Maven dependencies, with the Jenkins-maintained WPILib repo. Project structures have also been simplified: we no longer have separate subprojects inside wpilibc and wpilibj. Where possible, these changes hav been done with git renames, to make sure we still have full history for all repositories. Other unrelated subprojects have also been broken out: OutlineViewer is now a separate project. Change-Id: Ib4e2a6e1a2f66427a14f16612b0e0d69ed661878
92 lines
3.0 KiB
C++
92 lines
3.0 KiB
C++
#include "AnalogInput.h"
|
|
#include "interfaces/Potentiometer.h"
|
|
#include "LiveWindow/LiveWindowSendable.h"
|
|
|
|
#include <memory>
|
|
|
|
/**
|
|
* Class for reading analog potentiometers. Analog potentiometers read
|
|
* in an analog voltage that corresponds to a position. The position is
|
|
* in whichever units you choose, by way of the scaling and offset
|
|
* constants passed to the constructor.
|
|
*
|
|
* @author Alex Henning
|
|
* @author Colby Skeggs (rail voltage)
|
|
*/
|
|
class AnalogPotentiometer : public Potentiometer, public LiveWindowSendable {
|
|
public:
|
|
/**
|
|
* AnalogPotentiometer constructor.
|
|
*
|
|
* Use the fullRange and offset values so that the output produces
|
|
* meaningful values. I.E: you have a 270 degree potentiometer and
|
|
* you want the output to be degrees with the halfway point as 0
|
|
* degrees. The fullRange value is 270.0(degrees) and the offset is
|
|
* -135.0 since the halfway point after scaling is 135 degrees.
|
|
*
|
|
* This will calculate the result from the fullRange times the
|
|
* fraction of the supply voltage, plus the offset.
|
|
*
|
|
* @param channel The analog channel this potentiometer is plugged into.
|
|
* @param fullRange The scaling to multiply the voltage by to get a meaningful
|
|
* unit.
|
|
* @param offset The offset to add to the scaled value for controlling the
|
|
* zero value
|
|
*/
|
|
explicit AnalogPotentiometer(int channel, double fullRange = 1.0,
|
|
double offset = 0.0);
|
|
|
|
DEPRECATED(
|
|
"Raw pointers are deprecated; if you just want to construct an "
|
|
"AnalogPotentiometer with its own AnalogInput, then call the "
|
|
"AnalogPotentiometer(int channel). If you want to keep your own copy of "
|
|
"the AnalogInput, use std::shared_ptr.")
|
|
explicit AnalogPotentiometer(AnalogInput *input, double fullRange = 1.0,
|
|
double offset = 0.0);
|
|
|
|
explicit AnalogPotentiometer(std::shared_ptr<AnalogInput> input,
|
|
double fullRange = 1.0, double offset = 0.0);
|
|
|
|
virtual ~AnalogPotentiometer() = default;
|
|
|
|
/**
|
|
* Get the current reading of the potentiomer.
|
|
*
|
|
* @return The current position of the potentiometer.
|
|
*/
|
|
virtual double Get() const override;
|
|
|
|
/**
|
|
* Implement the PIDSource interface.
|
|
*
|
|
* @return The current reading.
|
|
*/
|
|
virtual double PIDGet() override;
|
|
|
|
/*
|
|
* Live Window code, only does anything if live window is activated.
|
|
*/
|
|
virtual std::string GetSmartDashboardType() const override;
|
|
virtual void InitTable(std::shared_ptr<ITable> subtable) override;
|
|
virtual void UpdateTable() override;
|
|
virtual std::shared_ptr<ITable> GetTable() const override;
|
|
|
|
/**
|
|
* AnalogPotentiometers don't have to do anything special when entering the
|
|
* LiveWindow.
|
|
*/
|
|
virtual void StartLiveWindowMode() override {}
|
|
|
|
/**
|
|
* AnalogPotentiometers don't have to do anything special when exiting the
|
|
* LiveWindow.
|
|
*/
|
|
virtual void StopLiveWindowMode() override {}
|
|
|
|
private:
|
|
std::shared_ptr<AnalogInput> m_analog_input;
|
|
double m_fullRange, m_offset;
|
|
std::shared_ptr<ITable> m_table;
|
|
bool m_init_analog_input;
|
|
};
|