Renamed folders for consistency, using sim/athena/shared schema (#27)

Rename the following folders: hal/lib/Athena -> hal/lib/athena hal/lib/Desktop -> hal/lib/sim hal/lib/Shared -> hal/lib/shared wpilibc/Athena -> wpilibc/athena wpilibc/simulation -> wpilibc/sim Windows users may need to run gradlew clean after updating.
2026-07-04 03:11:43 +00:00 · 2016-05-22 17:55:51 -04:00
parent 54092378e9
commit e71f454b9d
308 changed files with 14 additions and 14 deletions
--- a/wpilibc/sim/include/AnalogPotentiometer.h
+++ b/wpilibc/sim/include/AnalogPotentiometer.h
@@ -0,0 +1,95 @@
+/*----------------------------------------------------------------------------*/
+/* Copyright (c) FIRST 2016. 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 "AnalogInput.h"
+#include "LiveWindow/LiveWindowSendable.h"
+#include "interfaces/Potentiometer.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);
+};