From fb557f49eaf6f923878b376cc0c42697641535bf Mon Sep 17 00:00:00 2001 From: Liam Kinne Date: Fri, 2 Nov 2018 17:34:48 +1100 Subject: [PATCH] Add missing driver station documentation (#1388) --- .../main/native/include/frc/DriverStation.h | 31 +++++++++++++++++++ 1 file changed, 31 insertions(+) diff --git a/wpilibc/src/main/native/include/frc/DriverStation.h b/wpilibc/src/main/native/include/frc/DriverStation.h index 366100658b..ddbe27a197 100644 --- a/wpilibc/src/main/native/include/frc/DriverStation.h +++ b/wpilibc/src/main/native/include/frc/DriverStation.h @@ -265,10 +265,41 @@ class DriverStation : public ErrorBase { WPI_DEPRECATED("Use RobotController static class method") bool IsBrownedOut() const; + /** + * Returns the game specific message provided by the FMS. + * + * @return A string containing the game specific message. + */ std::string GetGameSpecificMessage() const; + + /** + * Returns the name of the competition event provided by the FMS. + * + * @return A string containing the event name + */ std::string GetEventName() const; + + /** + * Returns the type of match being played provided by the FMS. + * + * @return The match type enum (kNone, kPractice, kQualification, + * kElimination) + */ MatchType GetMatchType() const; + + /** + * Returns the match number provided by the FMS. + * + * @return The number of the match + */ int GetMatchNumber() const; + + /** + * Returns the number of times the current match has been replayed from the + * FMS. + * + * @return The number of replays + */ int GetReplayNumber() const; /**