Inheritance diagram for valor::Robot:

Public Member Functions
	Robot (units::second_t period=kDefaultPeriod)
	Robot (units::hertz_t frequency)

Static Public Member Functions
static Robot &	GetRobot ()
static bool	HasRobot ()

Constructor & Destructor Documentation

◆ Robot() [1/2]

valor::Robot::Robot ( units::second_t period = kDefaultPeriod )

explicit

Constructor for Robot. Aborts if another robot instance is detected.

Parameters

period The period of the robot loop function.

valor::Robot::Robot ( units::hertz_t frequency )

inlineexplicit

Constructor for Robot.

Parameters

frequency The frequency of the robot loop function.

Robot & valor::Robot::GetRobot ( )

static

Get the current running robot.

Returns: The reference to the currently running robot. Aborts if the robot pointer is nullptr

bool valor::Robot::HasRobot ( )

inlinestatic

Gets whether a Robot instance is active.

Returns: A boolean representing whether there is a robot instance. Implies that GetRobot() is safe to call.

The documentation for this class was generated from the following file: