Team2890/allwpilib
4
0
Fork 0
mirror of https://github.com/wpilibsuite/allwpilib synced 2026-06-23 01:21:42 +00:00
Code Issues Packages Projects Releases Wiki Activity

PIDController: Mention unit for 'period' (#1305)

Browse Source
This commit is contained in:
Kay Kasemir
2018-09-12 00:38:19 -04:00
committed by Peter Johnson
parent 025af24523
commit 59700882f1
2 changed files with 20 additions and 16 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -45,9 +45,9 @@ class PIDController : public PIDBase, public Controller {
* @param Kd the derivative coefficient
* @param source The PIDSource object that is used to get values
* @param output The PIDOutput object that is set to the output value
* @param period the loop time for doing calculations. This particularly
* effects calculations of the integral and differental terms.
* The default is 50ms.
* @param period the loop time for doing calculations in seconds. This
* particularly affects calculations of the integral and
* differental terms. The default is 0.05 (50ms).
*/
PIDController(double p, double i, double d, PIDSource* source,
PIDOutput* output, double period = 0.05);
@@ -60,9 +60,9 @@ class PIDController : public PIDBase, public Controller {
* @param Kd the derivative coefficient
* @param source The PIDSource object that is used to get values
* @param output The PIDOutput object that is set to the output value
* @param period the loop time for doing calculations. This particularly
* effects calculations of the integral and differental terms.
* The default is 50ms.
* @param period the loop time for doing calculations in seconds. This
* particularly affects calculations of the integral and
* differental terms. The default is 0.05 (50ms).
*/
PIDController(double p, double i, double d, double f, PIDSource* source,
PIDOutput* output, double period = 0.05);
@@ -75,9 +75,9 @@ class PIDController : public PIDBase, public Controller {
* @param Kd the derivative coefficient
* @param source The PIDSource object that is used to get values
* @param output The PIDOutput object that is set to the output value
* @param period the loop time for doing calculations. This particularly
* effects calculations of the integral and differental terms.
* The default is 50ms.
* @param period the loop time for doing calculations in seconds. This
* particularly affects calculations of the integral and
* differental terms. The default is 0.05 (50ms).
*/
PIDController(double p, double i, double d, PIDSource& source,
PIDOutput& output, double period = 0.05);
@@ -90,9 +90,9 @@ class PIDController : public PIDBase, public Controller {
* @param Kd the derivative coefficient
* @param source The PIDSource object that is used to get values
* @param output The PIDOutput object that is set to the output value
* @param period the loop time for doing calculations. This particularly
* effects calculations of the integral and differental terms.
* The default is 50ms.
* @param period the loop time for doing calculations in seconds. This
* particularly affects calculations of the integral and
* differental terms. The default is 0.05 (50ms).
*/
PIDController(double p, double i, double d, double f, PIDSource& source,
PIDOutput& output, double period = 0.05);