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

Fix documentation for getMatchTime in Timer class to match DriverStation (#761)

Browse Source
This commit is contained in:
sciencewhiz
2017-11-23 00:19:05 -08:00
committed by Peter Johnson
parent 12c4418bda
commit 614093c0c4
3 changed files with 18 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
wpilibj/src/main/java/edu/wpi/first/wpilibj/DriverStation.java
View File

@@ -796,7 +796,7 @@ public class DriverStation implements RobotState.Interface {
}
/**
* Return the approximate match time The FMS does not send an official match time to the robots,
* Return the approximate match time. The FMS does not send an official match time to the robots,
* but does send an approximate match time. The value will count down the time remaining in the
* current period (auto or teleop). Warning: This is not an official time (so it cannot be used to
* dispute ref calls or guarantee that a function will trigger before the match ends) The

12
wpilibj/src/main/java/edu/wpi/first/wpilibj/Timer.java
View File

@@ -33,13 +33,13 @@ public class Timer {
}
/**
* Return the approximate match time The FMS does not currently send the official match time to
* the robots This returns the time since the enable signal sent from the Driver Station At the
* beginning of autonomous, the time is reset to 0.0 seconds At the beginning of teleop, the time
* is reset to +15.0 seconds If the robot is disabled, this returns 0.0 seconds Warning: This is
* not an official time (so it cannot be used to argue with referees).
* Return the approximate match time. The FMS does not send an official match time to the robots,
* but does send an approximate match time. The value will count down the time remaining in the
* current period (auto or teleop). Warning: This is not an official time (so it cannot be used to
* dispute ref calls or guarantee that a function will trigger before the match ends) The
* Practice Match function of the DS approximates the behaviour seen on the field.
*
* @return Match time in seconds since the beginning of autonomous
* @return Time remaining in current match period (auto or teleop) in seconds
*/
public static double getMatchTime() {
if (impl != null) {