Team2890/allwpilib
4
0
Fork 0
mirror of https://github.com/wpilibsuite/allwpilib synced 2026-07-04 03:11:43 +00:00
Code Issues Packages Projects Releases Wiki Activity

Remove references to percent tolerance (#2380)

Browse Source 
Co-authored-by: Tyler Veness <calcmogul@gmail.com>
This commit is contained in:
sciencewhiz
2020-03-15 07:04:47 +02:00
committed by GitHub
parent 7b7f44d937
commit a26a7d217d
2 changed files with 4 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
wpilibc/src/main/native/include/frc/controller/PIDController.h
View File

@@ -1,5 +1,5 @@
/*----------------------------------------------------------------------------*/
/* Copyright (c) 2018-2019 FIRST. All Rights Reserved. */
/* Copyright (c) 2018-2020 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. */
@@ -117,7 +117,7 @@ class PIDController : public frc::Sendable,
double GetSetpoint() const;
/**
* Returns true if the error is within the tolerance of the error.
* Returns true if the error is within the tolerance of the setpoint.
*
* This will return false until at least one input value has been computed.
*/

5
wpilibj/src/main/java/edu/wpi/first/wpilibj/controller/PIDController.java
View File

@@ -62,7 +62,7 @@ public class PIDController implements Sendable, AutoCloseable {
// The sum of the errors for use in the integral calc
private double m_totalError;
// The percentage or absolute error that is considered at setpoint.
// The error that is considered at setpoint.
private double m_positionTolerance = 0.05;
private double m_velocityTolerance = Double.POSITIVE_INFINITY;
@@ -213,8 +213,7 @@ public class PIDController implements Sendable, AutoCloseable {
}
/**
* Returns true if the error is within the percentage of the total input range, determined by
* SetTolerance. This asssumes that the maximum and minimum input were set using SetInput.
* Returns true if the error is within the tolerance of the setpoint.
*
* <p>This will return false until at least one input value has been computed.
*