Class to control a simulated driver station. More...

#include <frc/simulation/DriverStationSim.h>

Static Public Member Functions
static std::unique_ptr< CallbackStore >	RegisterEnabledCallback (NotifyCallback callback, bool initialNotify)
	Register a callback on whether the DS is enabled.

static bool	GetEnabled ()
	Check if the DS is enabled.

static void	SetEnabled (bool enabled)
	Change whether the DS is enabled.

static std::unique_ptr< CallbackStore >	RegisterAutonomousCallback (NotifyCallback callback, bool initialNotify)
	Register a callback on whether the DS is in autonomous mode.

static bool	GetAutonomous ()
	Check if the DS is in autonomous.

static void	SetAutonomous (bool autonomous)
	Change whether the DS is in autonomous.

static std::unique_ptr< CallbackStore >	RegisterTestCallback (NotifyCallback callback, bool initialNotify)
	Register a callback on whether the DS is in test mode.

static bool	GetTest ()
	Check if the DS is in test.

static void	SetTest (bool test)
	Change whether the DS is in test.

static std::unique_ptr< CallbackStore >	RegisterEStopCallback (NotifyCallback callback, bool initialNotify)
	Register a callback on the eStop state.

static bool	GetEStop ()
	Check if eStop has been activated.

static void	SetEStop (bool eStop)
	Set whether eStop is active.

static std::unique_ptr< CallbackStore >	RegisterFmsAttachedCallback (NotifyCallback callback, bool initialNotify)
	Register a callback on whether the FMS is connected.

static bool	GetFmsAttached ()
	Check if the FMS is connected.

static void	SetFmsAttached (bool fmsAttached)
	Change whether the FMS is connected.

static std::unique_ptr< CallbackStore >	RegisterDsAttachedCallback (NotifyCallback callback, bool initialNotify)
	Register a callback on whether the DS is connected.

static bool	GetDsAttached ()
	Check if the DS is attached.

static void	SetDsAttached (bool dsAttached)
	Change whether the DS is attached.

static std::unique_ptr< CallbackStore >	RegisterAllianceStationIdCallback (NotifyCallback callback, bool initialNotify)
	Register a callback on the alliance station ID.

static HAL_AllianceStationID	GetAllianceStationId ()
	Get the alliance station ID (color + number).

static void	SetAllianceStationId (HAL_AllianceStationID allianceStationId)
	Change the alliance station.

static std::unique_ptr< CallbackStore >	RegisterMatchTimeCallback (NotifyCallback callback, bool initialNotify)
	Register a callback on match time.

static double	GetMatchTime ()
	Get the current value of the match timer.

static void	SetMatchTime (double matchTime)
	Sets the match timer.

static void	NotifyNewData ()
	Updates DriverStation data so that new values are visible to the user program.

static void	SetSendError (bool shouldSend)
	Sets suppression of DriverStation::ReportError and ReportWarning messages.

static void	SetSendConsoleLine (bool shouldSend)
	Sets suppression of DriverStation::SendConsoleLine messages.

static int64_t	GetJoystickOutputs (int stick)
	Gets the joystick outputs.

static int	GetJoystickRumble (int stick, int rumbleNum)
	Gets the joystick rumble.

static void	SetJoystickButton (int stick, int button, bool state)
	Sets the state of one joystick button.

static void	SetJoystickAxis (int stick, int axis, double value)
	Gets the value of the axis on a joystick.

static void	SetJoystickPOV (int stick, int pov, int value)
	Gets the state of a POV on a joystick.

static void	SetJoystickButtons (int stick, uint32_t buttons)
	Sets the state of all the buttons on a joystick.

static void	SetJoystickAxisCount (int stick, int count)
	Sets the number of axes for a joystick.

static void	SetJoystickPOVCount (int stick, int count)
	Sets the number of POVs for a joystick.

static void	SetJoystickButtonCount (int stick, int count)
	Sets the number of buttons for a joystick.

static void	SetJoystickIsXbox (int stick, bool isXbox)
	Sets the value of isXbox for a joystick.

static void	SetJoystickType (int stick, int type)
	Sets the value of type for a joystick.

static void	SetJoystickName (int stick, std::string_view name)
	Sets the name of a joystick.

static void	SetJoystickAxisType (int stick, int axis, int type)
	Sets the types of Axes for a joystick.

static void	SetGameSpecificMessage (std::string_view message)
	Sets the game specific message.

static void	SetEventName (std::string_view name)
	Sets the event name.

static void	SetMatchType (DriverStation::MatchType type)
	Sets the match type.

static void	SetMatchNumber (int matchNumber)
	Sets the match number.

static void	SetReplayNumber (int replayNumber)
	Sets the replay number.

static void	ResetData ()
	Reset all simulation data for the Driver Station.

Detailed Description

Class to control a simulated driver station.

Member Function Documentation

◆ GetAllianceStationId()

static HAL_AllianceStationID frc::sim::DriverStationSim::GetAllianceStationId ( )

static

Get the alliance station ID (color + number).

Returns: the alliance station color and number

◆ GetAutonomous()

static bool frc::sim::DriverStationSim::GetAutonomous ( )

static

Check if the DS is in autonomous.

Returns: true if autonomous

◆ GetDsAttached()

static bool frc::sim::DriverStationSim::GetDsAttached ( )

static

Check if the DS is attached.

Returns: true if attached

◆ GetEnabled()

static bool frc::sim::DriverStationSim::GetEnabled ( )

static

Check if the DS is enabled.

Returns: true if enabled

◆ GetEStop()

static bool frc::sim::DriverStationSim::GetEStop ( )

static

Check if eStop has been activated.

Returns: true if eStopped

◆ GetFmsAttached()

static bool frc::sim::DriverStationSim::GetFmsAttached ( )

static

Check if the FMS is connected.

Returns: true if FMS is connected

◆ GetJoystickOutputs()

static int64_t frc::sim::DriverStationSim::GetJoystickOutputs ( int stick )

static

Gets the joystick outputs.

Parameters

stick The joystick number

Returns: The joystick outputs

◆ GetJoystickRumble()

static int frc::sim::DriverStationSim::GetJoystickRumble	(	int	stick,
		int	rumbleNum )

static

Gets the joystick rumble.

Parameters

stick	The joystick number
rumbleNum	Rumble to get (0=left, 1=right)

Returns: The joystick rumble value

◆ GetMatchTime()

static double frc::sim::DriverStationSim::GetMatchTime ( )

static

Get the current value of the match timer.

Returns: the current match time

◆ GetTest()

static bool frc::sim::DriverStationSim::GetTest ( )

static

Check if the DS is in test.

Returns: true if test

◆ NotifyNewData()

static void frc::sim::DriverStationSim::NotifyNewData ( )

static

Updates DriverStation data so that new values are visible to the user program.

◆ RegisterAllianceStationIdCallback()

static std::unique_ptr< CallbackStore > frc::sim::DriverStationSim::RegisterAllianceStationIdCallback	(	NotifyCallback	callback,
		bool	initialNotify )

staticnodiscard

Register a callback on the alliance station ID.

Parameters

callback	the callback that will be called whenever the alliance station changes
initialNotify	if true, the callback will be run on the initial value

Returns: the CallbackStore object associated with this callback

◆ RegisterAutonomousCallback()

static std::unique_ptr< CallbackStore > frc::sim::DriverStationSim::RegisterAutonomousCallback	(	NotifyCallback	callback,
		bool	initialNotify )

staticnodiscard

Register a callback on whether the DS is in autonomous mode.

Parameters

callback	the callback that will be called on autonomous mode entrance/exit
initialNotify	if true, the callback will be run on the initial value

Returns: the CallbackStore object associated with this callback

◆ RegisterDsAttachedCallback()

static std::unique_ptr< CallbackStore > frc::sim::DriverStationSim::RegisterDsAttachedCallback	(	NotifyCallback	callback,
		bool	initialNotify )

staticnodiscard

Register a callback on whether the DS is connected.

Parameters

callback	the callback that will be called whenever the DS connection changes
initialNotify	if true, the callback will be run on the initial value

Returns: the CallbackStore object associated with this callback

◆ RegisterEnabledCallback()

static std::unique_ptr< CallbackStore > frc::sim::DriverStationSim::RegisterEnabledCallback	(	NotifyCallback	callback,
		bool	initialNotify )

staticnodiscard

Register a callback on whether the DS is enabled.

Parameters

callback	the callback that will be called whenever the enabled state is changed
initialNotify	if true, the callback will be run on the initial value

Returns: the CallbackStore object associated with this callback

◆ RegisterEStopCallback()

static std::unique_ptr< CallbackStore > frc::sim::DriverStationSim::RegisterEStopCallback	(	NotifyCallback	callback,
		bool	initialNotify )

staticnodiscard

Register a callback on the eStop state.

Parameters

callback	the callback that will be called whenever the eStop state changes
initialNotify	if true, the callback will be run on the initial value

Returns: the CallbackStore object associated with this callback

◆ RegisterFmsAttachedCallback()

static std::unique_ptr< CallbackStore > frc::sim::DriverStationSim::RegisterFmsAttachedCallback	(	NotifyCallback	callback,
		bool	initialNotify )

staticnodiscard

Register a callback on whether the FMS is connected.

Parameters

callback	the callback that will be called whenever the FMS connection changes
initialNotify	if true, the callback will be run on the initial value

Returns: the CallbackStore object associated with this callback

◆ RegisterMatchTimeCallback()

static std::unique_ptr< CallbackStore > frc::sim::DriverStationSim::RegisterMatchTimeCallback	(	NotifyCallback	callback,
		bool	initialNotify )

staticnodiscard

Register a callback on match time.

Parameters

callback	the callback that will be called whenever match time changes
initialNotify	if true, the callback will be run on the initial value

Returns: the CallbackStore object associated with this callback

◆ RegisterTestCallback()

static std::unique_ptr< CallbackStore > frc::sim::DriverStationSim::RegisterTestCallback	(	NotifyCallback	callback,
		bool	initialNotify )

staticnodiscard

Register a callback on whether the DS is in test mode.

Parameters

callback	the callback that will be called whenever the test mode is entered or left
initialNotify	if true, the callback will be run on the initial value

Returns: the CallbackStore object associated with this callback

◆ ResetData()

static void frc::sim::DriverStationSim::ResetData ( )

static

Reset all simulation data for the Driver Station.

◆ SetAllianceStationId()

static void frc::sim::DriverStationSim::SetAllianceStationId ( HAL_AllianceStationID allianceStationId )

static

Change the alliance station.

Parameters

allianceStationId the new alliance station

◆ SetAutonomous()

static void frc::sim::DriverStationSim::SetAutonomous ( bool autonomous )

static

Change whether the DS is in autonomous.

Parameters

autonomous the new value

◆ SetDsAttached()

static void frc::sim::DriverStationSim::SetDsAttached ( bool dsAttached )

static

Change whether the DS is attached.

Parameters

dsAttached the new value

◆ SetEnabled()

static void frc::sim::DriverStationSim::SetEnabled ( bool enabled )

static

Change whether the DS is enabled.

Parameters

enabled the new value

◆ SetEStop()

static void frc::sim::DriverStationSim::SetEStop ( bool eStop )

static

Set whether eStop is active.

Parameters

eStop true to activate

◆ SetEventName()

static void frc::sim::DriverStationSim::SetEventName ( std::string_view name )

static

Sets the event name.

Parameters

name	the event name

◆ SetFmsAttached()

static void frc::sim::DriverStationSim::SetFmsAttached ( bool fmsAttached )

static

Change whether the FMS is connected.

Parameters

fmsAttached the new value

◆ SetGameSpecificMessage()

static void frc::sim::DriverStationSim::SetGameSpecificMessage ( std::string_view message )

static

Sets the game specific message.

Parameters

message the game specific message

◆ SetJoystickAxis()

static void frc::sim::DriverStationSim::SetJoystickAxis	(	int	stick,
		int	axis,
		double	value )

static

Gets the value of the axis on a joystick.

Parameters

stick	The joystick number
axis	The analog axis number
value	The value of the axis on the joystick

◆ SetJoystickAxisCount()

static void frc::sim::DriverStationSim::SetJoystickAxisCount	(	int	stick,
		int	count )

static

Sets the number of axes for a joystick.

Parameters

stick	The joystick number
count	The number of axes on the indicated joystick

◆ SetJoystickAxisType()

static void frc::sim::DriverStationSim::SetJoystickAxisType	(	int	stick,
		int	axis,
		int	type )

static

Sets the types of Axes for a joystick.

Parameters

stick	The joystick number
axis	The target axis
type	The type of axis

◆ SetJoystickButton()

static void frc::sim::DriverStationSim::SetJoystickButton	(	int	stick,
		int	button,
		bool	state )

static

Sets the state of one joystick button.

Button indexes begin at 1.

Parameters

stick	The joystick number
button	The button index, beginning at 1
state	The state of the joystick button

◆ SetJoystickButtonCount()

static void frc::sim::DriverStationSim::SetJoystickButtonCount	(	int	stick,
		int	count )

static

Sets the number of buttons for a joystick.

Parameters

stick	The joystick number
count	The number of buttons on the indicated joystick

◆ SetJoystickButtons()

static void frc::sim::DriverStationSim::SetJoystickButtons	(	int	stick,
		uint32_t	buttons )

static

Sets the state of all the buttons on a joystick.

Parameters

stick	The joystick number
buttons	The bitmap state of the buttons on the joystick

◆ SetJoystickIsXbox()

static void frc::sim::DriverStationSim::SetJoystickIsXbox	(	int	stick,
		bool	isXbox )

static

Sets the value of isXbox for a joystick.

Parameters

stick	The joystick number
isXbox	The value of isXbox

◆ SetJoystickName()

static void frc::sim::DriverStationSim::SetJoystickName	(	int	stick,
		std::string_view	name )

static

Sets the name of a joystick.

Parameters

stick	The joystick number
name	The value of name

◆ SetJoystickPOV()

static void frc::sim::DriverStationSim::SetJoystickPOV	(	int	stick,
		int	pov,
		int	value )

static

Gets the state of a POV on a joystick.

Parameters

stick	The joystick number
pov	The POV number
value	the angle of the POV in degrees, or -1 for not pressed

◆ SetJoystickPOVCount()

static void frc::sim::DriverStationSim::SetJoystickPOVCount	(	int	stick,
		int	count )

static

Sets the number of POVs for a joystick.

Parameters

stick	The joystick number
count	The number of POVs on the indicated joystick

◆ SetJoystickType()

static void frc::sim::DriverStationSim::SetJoystickType	(	int	stick,
		int	type )

static

Sets the value of type for a joystick.

Parameters

stick	The joystick number
type	The value of type

◆ SetMatchNumber()

static void frc::sim::DriverStationSim::SetMatchNumber ( int matchNumber )

static

Sets the match number.

Parameters

matchNumber the match number

◆ SetMatchTime()

static void frc::sim::DriverStationSim::SetMatchTime ( double matchTime )

static

Sets the match timer.

Parameters

matchTime the new match time

◆ SetMatchType()

static void frc::sim::DriverStationSim::SetMatchType ( DriverStation::MatchType type )

static

Sets the match type.

Parameters

type	the match type

◆ SetReplayNumber()

static void frc::sim::DriverStationSim::SetReplayNumber ( int replayNumber )

static

Sets the replay number.

Parameters

replayNumber the replay number

◆ SetSendConsoleLine()

static void frc::sim::DriverStationSim::SetSendConsoleLine ( bool shouldSend )

static

Sets suppression of DriverStation::SendConsoleLine messages.

Parameters

shouldSend If false then messages will be suppressed.

◆ SetSendError()

static void frc::sim::DriverStationSim::SetSendError ( bool shouldSend )

static

Sets suppression of DriverStation::ReportError and ReportWarning messages.

Parameters

shouldSend If false then messages will be suppressed.

◆ SetTest()

static void frc::sim::DriverStationSim::SetTest ( bool test )

static

Change whether the DS is in test.

Parameters

test	the new value

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

frc/simulation/DriverStationSim.h

Static Public Member Functions

Detailed Description

Member Function Documentation

◆ GetAllianceStationId()

◆ GetAutonomous()

◆ GetDsAttached()

◆ GetEnabled()

◆ GetEStop()

◆ GetFmsAttached()

◆ GetJoystickOutputs()

◆ GetJoystickRumble()

◆ GetMatchTime()

◆ GetTest()

◆ NotifyNewData()

◆ RegisterAllianceStationIdCallback()

◆ RegisterAutonomousCallback()

◆ RegisterDsAttachedCallback()

◆ RegisterEnabledCallback()

◆ RegisterEStopCallback()

◆ RegisterFmsAttachedCallback()

◆ RegisterMatchTimeCallback()

◆ RegisterTestCallback()

◆ ResetData()

◆ SetAllianceStationId()

◆ SetAutonomous()

◆ SetDsAttached()

◆ SetEnabled()

◆ SetEStop()

◆ SetEventName()

◆ SetFmsAttached()

◆ SetGameSpecificMessage()

◆ SetJoystickAxis()

◆ SetJoystickAxisCount()

◆ SetJoystickAxisType()

◆ SetJoystickButton()

◆ SetJoystickButtonCount()

◆ SetJoystickButtons()

◆ SetJoystickIsXbox()

◆ SetJoystickName()

◆ SetJoystickPOV()

◆ SetJoystickPOVCount()

◆ SetJoystickType()

◆ SetMatchNumber()

◆ SetMatchTime()

◆ SetMatchType()

◆ SetReplayNumber()

◆ SetSendConsoleLine()

◆ SetSendError()

◆ SetTest()