mirror of
https://github.com/wpilibsuite/allwpilib
synced 2026-06-21 01:01:43 +00:00
f65e697107
I'm not 100% sure whether we want these, but they are a quick find and replace to do. Basically, there are two primary things that we have done this summer that break existing user code: -Changing GetInstance() calls to return references instead of pointers. This forces users to change from doing something like LiveWindow::GetInstance()->AddSensor() to LiveWindow::GetInstance().AddSensor(). -Making PIDGet() and related calls const, forcing users to change the function signatures wherever they override them. The GetInstance() calls don't really matter to me either way, especially since there are no real ownership issues going on there, unlike the rest of the smart pointer-related changes. For the const stuff, it is certainly more correct to mandate that user PIDGet() functions be const and the such, but at the same time, I'm not sure that there is any strong need for it, and the errors generated are not the most helpful. While this wouldn't necessarily be an issue for more experienced teams or completely new teams (who don't have any old code to be reusing), it may cause issues for more average teams who aren't familiar with the intricacies of C++ anything. Change-Id: I6e7007982069292ea70e6d0fc8ca40203340df1b
86 lines
2.7 KiB
C++
86 lines
2.7 KiB
C++
#pragma once
|
|
|
|
#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. Usually the
|
|
* position is either degrees or meters. However, if no conversion is
|
|
* given it remains volts.
|
|
*
|
|
* @author Alex Henning
|
|
*/
|
|
class AnalogPotentiometer : public Potentiometer, public LiveWindowSendable {
|
|
public:
|
|
/**
|
|
* AnalogPotentiometer constructor.
|
|
*
|
|
* Use the scaling 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 scale value is 270.0(degrees)/5.0(volts) and the
|
|
* offset is -135.0 since the halfway point after scaling is 135
|
|
* degrees.
|
|
*
|
|
* @param channel The analog channel this potentiometer is plugged into.
|
|
* @param scale 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
|
|
*/
|
|
AnalogPotentiometer(int channel, double scale = 1.0, double offset = 0.0);
|
|
|
|
AnalogPotentiometer(AnalogInput *input, double scale = 1.0, double offset = 0.0);
|
|
|
|
AnalogPotentiometer(AnalogInput &input, double scale = 1.0, double offset = 0.0);
|
|
|
|
virtual ~AnalogPotentiometer();
|
|
|
|
/**
|
|
* Get the current reading of the potentiomere.
|
|
*
|
|
* @return The current position of the potentiometer.
|
|
*/
|
|
virtual double Get() const;
|
|
|
|
|
|
/**
|
|
* 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:
|
|
double m_scale, m_offset;
|
|
AnalogInput* m_analog_input;
|
|
std::shared_ptr<ITable> m_table;
|
|
bool m_init_analog_input;
|
|
|
|
/**
|
|
* Common initialization code called by all constructors.
|
|
*/
|
|
void initPot(AnalogInput *input, double scale, double offset);
|
|
};
|