mirror of
https://github.com/wpilibsuite/allwpilib
synced 2026-06-27 02:01:42 +00:00
[wpilibc] RobotBase::IsReal, IsSimulation: Add doxygen comments (#2735)
This commit is contained in:
@@ -185,6 +185,11 @@ class RobotBase {
|
||||
|
||||
virtual void EndCompetition() = 0;
|
||||
|
||||
/**
|
||||
* Get if the robot is real.
|
||||
*
|
||||
* @return If the robot is running in the real world.
|
||||
*/
|
||||
static constexpr bool IsReal() {
|
||||
#ifdef __FRC_ROBORIO__
|
||||
return true;
|
||||
@@ -193,6 +198,11 @@ class RobotBase {
|
||||
#endif
|
||||
}
|
||||
|
||||
/**
|
||||
* Get if the robot is a simulation.
|
||||
*
|
||||
* @return If the robot is running in simulation.
|
||||
*/
|
||||
static constexpr bool IsSimulation() { return !IsReal(); }
|
||||
|
||||
/**
|
||||
|
||||
Reference in New Issue
Block a user