mirror of
https://github.com/wpilibsuite/allwpilib
synced 2026-06-23 01:21:42 +00:00
[wpilib] Fix docs for Sharp IR simulation (NFC) (#6653)
This commit is contained in:
@@ -11,11 +11,28 @@
|
||||
|
||||
namespace frc {
|
||||
|
||||
/** Simulation class for Sharp IR sensors. */
|
||||
class SharpIRSim {
|
||||
public:
|
||||
/**
|
||||
* Constructor.
|
||||
*
|
||||
* @param sharpIR The real sensor to simulate
|
||||
*/
|
||||
explicit SharpIRSim(const SharpIR& sharpIR);
|
||||
|
||||
/**
|
||||
* Constructor.
|
||||
*
|
||||
* @param channel Analog channel for this sensor
|
||||
*/
|
||||
explicit SharpIRSim(int channel);
|
||||
|
||||
/**
|
||||
* Set the range returned by the distance sensor.
|
||||
*
|
||||
* @param rng range of the target returned by the sensor
|
||||
*/
|
||||
void SetRange(units::centimeter_t rng);
|
||||
|
||||
private:
|
||||
|
||||
@@ -8,6 +8,7 @@ import edu.wpi.first.hal.SimDouble;
|
||||
import edu.wpi.first.math.util.Units;
|
||||
import edu.wpi.first.wpilibj.SharpIR;
|
||||
|
||||
/** Simulation class for Sharp IR sensors. */
|
||||
public class SharpIRSim {
|
||||
private final SimDouble m_simRange;
|
||||
|
||||
@@ -30,10 +31,20 @@ public class SharpIRSim {
|
||||
m_simRange = simDevice.getDouble("Range (cm)");
|
||||
}
|
||||
|
||||
/**
|
||||
* Set the range in inches returned by the distance sensor.
|
||||
*
|
||||
* @param inches range in inches of the target returned by the sensor
|
||||
*/
|
||||
public void setRangeInches(double inches) {
|
||||
m_simRange.set(Units.inchesToMeters(inches) * 100.0);
|
||||
}
|
||||
|
||||
/**
|
||||
* Set the range in centimeters returned by the distance sensor.
|
||||
*
|
||||
* @param cm range in centimeters of the target returned by the sensor
|
||||
*/
|
||||
public void setRangeCm(double cm) {
|
||||
m_simRange.set(cm);
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user