Class to control a simulated Xbox controller. More...

#include <frc/simulation/XboxControllerSim.h>

Inheritance diagram for frc::sim::XboxControllerSim:

Public Member Functions
	XboxControllerSim (const XboxController &joystick)
	Constructs from a XboxController object.

	XboxControllerSim (int port)
	Constructs from a joystick port number.

void	SetLeftX (double value)
	Change the left X value of the controller's joystick.

void	SetRightX (double value)
	Change the right X value of the controller's joystick.

void	SetLeftY (double value)
	Change the left Y value of the controller's joystick.

void	SetRightY (double value)
	Change the right Y value of the controller's joystick.

void	SetLeftTriggerAxis (double value)
	Change the value of the left trigger axis on the controller.

void	SetRightTriggerAxis (double value)
	Change the value of the right trigger axis on the controller.

void	SetAButton (bool value)
	Change the value of the A button on the controller.

void	SetBButton (bool value)
	Change the value of the B button on the controller.

void	SetXButton (bool value)
	Change the value of the X button on the controller.

void	SetYButton (bool value)
	Change the value of the Y button on the controller.

void	SetLeftBumperButton (bool value)
	Change the value of the left bumper button on the controller.

void	SetRightBumperButton (bool value)
	Change the value of the right bumper button on the controller.

void	SetBackButton (bool value)
	Change the value of the back button on the controller.

void	SetStartButton (bool value)
	Change the value of the start button on the controller.

void	SetLeftStickButton (bool value)
	Change the value of the left stick button on the controller.

void	SetRightStickButton (bool value)
	Change the value of the right stick button on the controller.

void	SetLeftBumper (bool value)
	Change the left bumper value of the joystick.

void	SetRightBumper (bool value)
	Change the right bumper value of the joystick.

Public Member Functions inherited from frc::sim::GenericHIDSim
	GenericHIDSim (const GenericHID &joystick)
	Constructs from a GenericHID object.

	GenericHIDSim (int port)
	Constructs from a joystick port number.

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

void	SetRawButton (int button, bool value)
	Set the value of a given button.

void	SetRawAxis (int axis, double value)
	Set the value of a given axis.

void	SetPOV (int pov, int value)
	Set the value of a given POV.

void	SetPOV (int value)
	Set the value of the default POV (port 0).

void	SetAxisCount (int count)
	Set the axis count of this device.

void	SetPOVCount (int count)
	Set the POV count of this device.

void	SetButtonCount (int count)
	Set the button count of this device.

void	SetType (GenericHID::HIDType type)
	Set the type of this device.

void	SetName (const char *name)
	Set the name of this device.

void	SetAxisType (int axis, int type)
	Set the type of an axis.

bool	GetOutput (int outputNumber)
	Read the output of a button.

int64_t	GetOutputs ()
	Get the encoded 16-bit integer that passes button values.

double	GetRumble (GenericHID::RumbleType type)
	Get the joystick rumble.

Additional Inherited Members
Protected Attributes inherited from frc::sim::GenericHIDSim
int	m_port
	GenericHID port.

Detailed Description

Class to control a simulated Xbox controller.

Constructor & Destructor Documentation

◆ XboxControllerSim() [1/2]

frc::sim::XboxControllerSim::XboxControllerSim ( const XboxController & joystick )

explicit

Constructs from a XboxController object.

Parameters

joystick controller to simulate

◆ XboxControllerSim() [2/2]

frc::sim::XboxControllerSim::XboxControllerSim ( int port )

explicit

Constructs from a joystick port number.

Parameters

port	port number

Member Function Documentation

◆ SetAButton()

void frc::sim::XboxControllerSim::SetAButton ( bool value )

Change the value of the A button on the controller.

Parameters

value the new value

◆ SetBackButton()

void frc::sim::XboxControllerSim::SetBackButton ( bool value )

Change the value of the back button on the controller.

Parameters

value the new value

◆ SetBButton()

void frc::sim::XboxControllerSim::SetBButton ( bool value )

Change the value of the B button on the controller.

Parameters

value the new value

◆ SetLeftBumper()

void frc::sim::XboxControllerSim::SetLeftBumper ( bool value )

Change the left bumper value of the joystick.

Parameters

value the new value

Deprecated: Use SetLeftBumperButton instead. This function is deprecated for removal to make function names consistent to allow the HID classes to be automatically generated.

◆ SetLeftBumperButton()

void frc::sim::XboxControllerSim::SetLeftBumperButton ( bool value )

Change the value of the left bumper button on the controller.

Parameters

value the new value

◆ SetLeftStickButton()

void frc::sim::XboxControllerSim::SetLeftStickButton ( bool value )

Change the value of the left stick button on the controller.

Parameters

value the new value

◆ SetLeftTriggerAxis()

void frc::sim::XboxControllerSim::SetLeftTriggerAxis ( double value )

Change the value of the left trigger axis on the controller.

Parameters

value the new value

◆ SetLeftX()

void frc::sim::XboxControllerSim::SetLeftX ( double value )

Change the left X value of the controller's joystick.

Parameters

value the new value

◆ SetLeftY()

void frc::sim::XboxControllerSim::SetLeftY ( double value )

Change the left Y value of the controller's joystick.

Parameters

value the new value

◆ SetRightBumper()

void frc::sim::XboxControllerSim::SetRightBumper ( bool value )

Change the right bumper value of the joystick.

Parameters

value the new value

Deprecated: Use SetRightBumperButton instead. This function is deprecated for removal to make function names consistent to allow the HID classes to be automatically generated.

◆ SetRightBumperButton()

void frc::sim::XboxControllerSim::SetRightBumperButton ( bool value )

Change the value of the right bumper button on the controller.

Parameters

value the new value

◆ SetRightStickButton()

void frc::sim::XboxControllerSim::SetRightStickButton ( bool value )

Change the value of the right stick button on the controller.

Parameters

value the new value

◆ SetRightTriggerAxis()

void frc::sim::XboxControllerSim::SetRightTriggerAxis ( double value )

Change the value of the right trigger axis on the controller.

Parameters

value the new value

◆ SetRightX()

void frc::sim::XboxControllerSim::SetRightX ( double value )

Change the right X value of the controller's joystick.

Parameters

value the new value

◆ SetRightY()

void frc::sim::XboxControllerSim::SetRightY ( double value )

Change the right Y value of the controller's joystick.

Parameters

value the new value

◆ SetStartButton()

void frc::sim::XboxControllerSim::SetStartButton ( bool value )

Change the value of the start button on the controller.

Parameters

value the new value

◆ SetXButton()

void frc::sim::XboxControllerSim::SetXButton ( bool value )

Change the value of the X button on the controller.

Parameters

value the new value

◆ SetYButton()

void frc::sim::XboxControllerSim::SetYButton ( bool value )

Change the value of the Y button on the controller.

Parameters

value the new value

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

frc/simulation/XboxControllerSim.h

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ XboxControllerSim() [1/2]

◆ XboxControllerSim() [2/2]

Member Function Documentation

◆ SetAButton()

◆ SetBackButton()

◆ SetBButton()

◆ SetLeftBumper()

◆ SetLeftBumperButton()

◆ SetLeftStickButton()

◆ SetLeftTriggerAxis()

◆ SetLeftX()

◆ SetLeftY()

◆ SetRightBumper()

◆ SetRightBumperButton()

◆ SetRightStickButton()

◆ SetRightTriggerAxis()

◆ SetRightX()

◆ SetRightY()

◆ SetStartButton()

◆ SetXButton()

◆ SetYButton()