wpi::sim::GenericHIDSim Class Reference

Class to control a simulated generic joystick. More...

#include <wpi/simulation/GenericHIDSim.hpp>

Inheritance diagram for wpi::sim::GenericHIDSim:

Public Member Functions
	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, DriverStation::POVDirection value)
	Set the value of a given POV.
void	SetPOV (DriverStation::POVDirection value)
	Set the value of the default POV (port 0).
void	SetAxesMaximumIndex (int maximumIndex)
void	SetAxesAvailable (int count)
	Set the axis count of this device.
void	SetPOVsMaximumIndex (int maximumIndex)
void	SetPOVsAvailable (int count)
	Set the POV count of this device.
void	SetButtonsMaximumIndex (int maximumIndex)
void	SetButtonsAvailable (uint64_t count)
	Set the button count of this device.
void	SetGamepadType (GenericHID::HIDType type)
	Set the type of this device.
void	SetSupportedOutputs (GenericHID::SupportedOutputs supportedOutputs)
void	SetName (const char *name)
	Set the name of this device.
int32_t	GetLeds ()
	Get the value of set LEDs.
double	GetRumble (GenericHID::RumbleType type)
	Get the joystick rumble.

Protected Attributes
int	m_port
	GenericHID port.

Detailed Description

Class to control a simulated generic joystick.

Constructor & Destructor Documentation

GenericHIDSim() [1/2]

wpi::sim::GenericHIDSim::GenericHIDSim ( const GenericHID & joystick )

explicit

Constructs from a GenericHID object.

Parameters

joystick

joystick to simulate

GenericHIDSim() [2/2]

wpi::sim::GenericHIDSim::GenericHIDSim ( int port )

explicit

Constructs from a joystick port number.

Parameters

port	port number

Member Function Documentation

GetLeds()

int32_t wpi::sim::GenericHIDSim::GetLeds

(

)

Get the value of set LEDs.

Returns

the led color

GetRumble()

double wpi::sim::GenericHIDSim::GetRumble

(

GenericHID::RumbleType

type

)

Get the joystick rumble.

Parameters

type	the rumble to read

Returns

the rumble value

NotifyNewData()

void wpi::sim::GenericHIDSim::NotifyNewData

(

)

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

SetAxesAvailable()

void wpi::sim::GenericHIDSim::SetAxesAvailable

(

int

count

)

Set the axis count of this device.

Parameters

count

the new axis count

SetAxesMaximumIndex()

void wpi::sim::GenericHIDSim::SetAxesMaximumIndex

(

int

maximumIndex

)

SetButtonsAvailable()

void wpi::sim::GenericHIDSim::SetButtonsAvailable

(

uint64_t

count

)

Set the button count of this device.

Parameters

count

the new button count

SetButtonsMaximumIndex()

void wpi::sim::GenericHIDSim::SetButtonsMaximumIndex

(

int

maximumIndex

)

SetGamepadType()

void wpi::sim::GenericHIDSim::SetGamepadType

(

GenericHID::HIDType

type

)

Set the type of this device.

Parameters

type	the new device type

SetName()

void wpi::sim::GenericHIDSim::SetName

(

const char *

name

)

Set the name of this device.

Parameters

name	the new device name

SetPOV() [1/2]

void wpi::sim::GenericHIDSim::SetPOV

(

DriverStation::POVDirection

value

)

Set the value of the default POV (port 0).

Parameters

value

the new value

SetPOV() [2/2]

void wpi::sim::GenericHIDSim::SetPOV	(	int	pov,
		DriverStation::POVDirection	value )

Set the value of a given POV.

Parameters

pov	the POV to set
value	the new value

SetPOVsAvailable()

void wpi::sim::GenericHIDSim::SetPOVsAvailable

(

int

count

)

Set the POV count of this device.

Parameters

count

the new POV count

SetPOVsMaximumIndex()

void wpi::sim::GenericHIDSim::SetPOVsMaximumIndex

(

int

maximumIndex

)

SetRawAxis()

void wpi::sim::GenericHIDSim::SetRawAxis	(	int	axis,
		double	value )

Set the value of a given axis.

Parameters

axis	the axis to set
value	the new value

SetRawButton()

void wpi::sim::GenericHIDSim::SetRawButton	(	int	button,
		bool	value )

Set the value of a given button.

Parameters

button	the button to set
value	the new value

SetSupportedOutputs()

void wpi::sim::GenericHIDSim::SetSupportedOutputs

(

GenericHID::SupportedOutputs

supportedOutputs

)

Member Data Documentation

m_port

int wpi::sim::GenericHIDSim::m_port

protected

GenericHID port.

---

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

• wpi/simulation/GenericHIDSim.hpp