mirror of
https://github.com/wpilibsuite/allwpilib
synced 2026-06-27 02:01:42 +00:00
Add missing driver station documentation (#1388)
This commit is contained in:
committed by
Peter Johnson
parent
746f950a0b
commit
fb557f49ea
@@ -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;
|
||||
|
||||
/**
|
||||
|
||||
Reference in New Issue
Block a user