Class CommandSwitch2GCController

java.lang.Object

org.wpilib.command3.button.CommandSwitch2GCController

public class CommandSwitch2GCController
extends Object

A version of Switch2GCController with Trigger factories for command-based.

See Also:

• Switch2GCController

Constructor Summary

Constructors

Constructor	Description
CommandSwitch2GCController(int port)	Construct an instance of a controller.
CommandSwitch2GCController(Scheduler scheduler, int port)	Construct an instance of a controller.
CommandSwitch2GCController(Scheduler scheduler, Switch2GCController controller)	Construct an instance of a controller.
CommandSwitch2GCController(Switch2GCController controller)	Construct an instance of a controller.

Method Summary

Modifier and Type	Method	Description
Trigger	a()	Constructs a Trigger instance around the A button's digital signal.
Trigger	a(EventLoop loop)	Constructs a Trigger instance around the A button's digital signal.
Trigger	b()	Constructs a Trigger instance around the B button's digital signal.
Trigger	b(EventLoop loop)	Constructs a Trigger instance around the B button's digital signal.
Trigger	C()	Constructs a Trigger instance around the C button's digital signal.
Trigger	C(EventLoop loop)	Constructs a Trigger instance around the C button's digital signal.
Trigger	capture()	Constructs a Trigger instance around the Capture button's digital signal.
Trigger	capture(EventLoop loop)	Constructs a Trigger instance around the Capture button's digital signal.
Trigger	dpadDown()	Constructs a Trigger instance around the Dpad Down button's digital signal.
Trigger	dpadDown(EventLoop loop)	Constructs a Trigger instance around the Dpad Down button's digital signal.
Trigger	dpadLeft()	Constructs a Trigger instance around the Dpad Left button's digital signal.
Trigger	dpadLeft(EventLoop loop)	Constructs a Trigger instance around the Dpad Left button's digital signal.
Trigger	dpadRight()	Constructs a Trigger instance around the Dpad Right button's digital signal.
Trigger	dpadRight(EventLoop loop)	Constructs a Trigger instance around the Dpad Right button's digital signal.
Trigger	dpadUp()	Constructs a Trigger instance around the Dpad Up button's digital signal.
Trigger	dpadUp(EventLoop loop)	Constructs a Trigger instance around the Dpad Up button's digital signal.
Switch2GCController	getController()	Get the wrapped controller object.
double	getCStickX()	Get the C Stick X value of the controller.
double	getCStickY()	Get the C Stick Y value of the controller.
CommandGenericHID	getHID()	Get the underlying CommandGenericHID object.
double	getLeftX()	Get the Left X value of the controller.
double	getLeftY()	Get the Left Y value of the controller.
double	getLTrigger()	Get the L Trigger value of the controller.
double	getRTrigger()	Get the R Trigger value of the controller.
Trigger	home()	Constructs a Trigger instance around the Home button's digital signal.
Trigger	home(EventLoop loop)	Constructs a Trigger instance around the Home button's digital signal.
Trigger	L()	Constructs a Trigger instance around the L button's digital signal.
Trigger	L(EventLoop loop)	Constructs a Trigger instance around the L button's digital signal.
Trigger	LTrigger()	Constructs a Trigger instance around the axis value of the L Trigger.
Trigger	LTrigger(double threshold)	Constructs a Trigger instance around the axis value of the L Trigger.
Trigger	LTrigger(double threshold, EventLoop loop)	Constructs a Trigger instance around the axis value of the L Trigger.
Trigger	R()	Constructs a Trigger instance around the R button's digital signal.
Trigger	R(EventLoop loop)	Constructs a Trigger instance around the R button's digital signal.
Trigger	RTrigger()	Constructs a Trigger instance around the axis value of the R Trigger.
Trigger	RTrigger(double threshold)	Constructs a Trigger instance around the axis value of the R Trigger.
Trigger	RTrigger(double threshold, EventLoop loop)	Constructs a Trigger instance around the axis value of the R Trigger.
Trigger	start()	Constructs a Trigger instance around the Start button's digital signal.
Trigger	start(EventLoop loop)	Constructs a Trigger instance around the Start button's digital signal.
Trigger	x()	Constructs a Trigger instance around the X button's digital signal.
Trigger	x(EventLoop loop)	Constructs a Trigger instance around the X button's digital signal.
Trigger	y()	Constructs a Trigger instance around the Y button's digital signal.
Trigger	y(EventLoop loop)	Constructs a Trigger instance around the Y button's digital signal.
Trigger	Z()	Constructs a Trigger instance around the Z button's digital signal.
Trigger	Z(EventLoop loop)	Constructs a Trigger instance around the Z button's digital signal.
Trigger	ZL()	Constructs a Trigger instance around the ZL button's digital signal.
Trigger	ZL(EventLoop loop)	Constructs a Trigger instance around the ZL button's digital signal.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

CommandSwitch2GCController

public CommandSwitch2GCController(int port)

Construct an instance of a controller. Commands bound to buttons on the controller will be scheduled on the default scheduler using its default event loop.

Parameters:

port - The port index on the Driver Station that the controller is plugged into.

CommandSwitch2GCController

public CommandSwitch2GCController(Switch2GCController controller)

Construct an instance of a controller. Commands bound to buttons on the controller will be scheduled on the default scheduler using its default event loop.

Parameters:

controller - The Switch2GCController object to use for this controller.

CommandSwitch2GCController

public CommandSwitch2GCController(Scheduler scheduler,
 int port)

Construct an instance of a controller. Commands bound to buttons on the controller will be scheduled on the given scheduler using its default event loop.

Parameters:

scheduler - The scheduler that should execute the triggered commands.

port - The port index on the Driver Station that the controller is plugged into.

CommandSwitch2GCController

public CommandSwitch2GCController(Scheduler scheduler,
 Switch2GCController controller)

Construct an instance of a controller. Commands bound to buttons on the controller will be scheduled on the given scheduler using its default event loop.

Parameters:

scheduler - The scheduler that should execute the triggered commands.

controller - The Switch2GCController object to use for this controller.

Method Details

getHID

public CommandGenericHID getHID()

Get the underlying CommandGenericHID object.

Returns:

the wrapped CommandGenericHID object

getController

public Switch2GCController getController()

Get the wrapped controller object.

Returns:

the wrapped controller object

a

public Trigger a()

Constructs a Trigger instance around the A button's digital signal.

Returns:

a Trigger instance representing the A button's digital signal attached to the default scheduler event loop on the scheduler passed to the controller's constructor, or the default scheduler if a scheduler was not explicitly provided.

See Also:

• a(EventLoop)

a

public Trigger a(EventLoop loop)

Constructs a Trigger instance around the A button's digital signal.

Parameters:

loop - the event loop instance to attach the event to.

Returns:

a Trigger instance representing the A button's digital signal attached to the given loop.

x

public Trigger x()

Constructs a Trigger instance around the X button's digital signal.

Returns:

a Trigger instance representing the X button's digital signal attached to the default scheduler event loop on the scheduler passed to the controller's constructor, or the default scheduler if a scheduler was not explicitly provided.

See Also:

• x(EventLoop)

x

public Trigger x(EventLoop loop)

Constructs a Trigger instance around the X button's digital signal.

Parameters:

loop - the event loop instance to attach the event to.

Returns:

a Trigger instance representing the X button's digital signal attached to the given loop.

b

public Trigger b()

Constructs a Trigger instance around the B button's digital signal.

Returns:

a Trigger instance representing the B button's digital signal attached to the default scheduler event loop on the scheduler passed to the controller's constructor, or the default scheduler if a scheduler was not explicitly provided.

See Also:

• b(EventLoop)

b

public Trigger b(EventLoop loop)

Constructs a Trigger instance around the B button's digital signal.

Parameters:

loop - the event loop instance to attach the event to.

Returns:

a Trigger instance representing the B button's digital signal attached to the given loop.

y

public Trigger y()

Constructs a Trigger instance around the Y button's digital signal.

Returns:

a Trigger instance representing the Y button's digital signal attached to the default scheduler event loop on the scheduler passed to the controller's constructor, or the default scheduler if a scheduler was not explicitly provided.

See Also:

• y(EventLoop)

y

public Trigger y(EventLoop loop)

Constructs a Trigger instance around the Y button's digital signal.

Parameters:

loop - the event loop instance to attach the event to.

Returns:

a Trigger instance representing the Y button's digital signal attached to the given loop.

home

public Trigger home()

Constructs a Trigger instance around the Home button's digital signal.

Returns:

a Trigger instance representing the Home button's digital signal attached to the default scheduler event loop on the scheduler passed to the controller's constructor, or the default scheduler if a scheduler was not explicitly provided.

See Also:

• home(EventLoop)

home

public Trigger home(EventLoop loop)

Constructs a Trigger instance around the Home button's digital signal.

Parameters:

loop - the event loop instance to attach the event to.

Returns:

a Trigger instance representing the Home button's digital signal attached to the given loop.

start

public Trigger start()

Constructs a Trigger instance around the Start button's digital signal.

Returns:

a Trigger instance representing the Start button's digital signal attached to the default scheduler event loop on the scheduler passed to the controller's constructor, or the default scheduler if a scheduler was not explicitly provided.

See Also:

• start(EventLoop)

start

public Trigger start(EventLoop loop)

Constructs a Trigger instance around the Start button's digital signal.

Parameters:

loop - the event loop instance to attach the event to.

Returns:

a Trigger instance representing the Start button's digital signal attached to the given loop.

ZL

public Trigger ZL()

Constructs a Trigger instance around the ZL button's digital signal.

Returns:

a Trigger instance representing the ZL button's digital signal attached to the default scheduler event loop on the scheduler passed to the controller's constructor, or the default scheduler if a scheduler was not explicitly provided.

See Also:

• ZL(EventLoop)

ZL

public Trigger ZL(EventLoop loop)

Constructs a Trigger instance around the ZL button's digital signal.

Parameters:

loop - the event loop instance to attach the event to.

Returns:

a Trigger instance representing the ZL button's digital signal attached to the given loop.

Z

public Trigger Z()

Constructs a Trigger instance around the Z button's digital signal.

Returns:

a Trigger instance representing the Z button's digital signal attached to the default scheduler event loop on the scheduler passed to the controller's constructor, or the default scheduler if a scheduler was not explicitly provided.

See Also:

• Z(EventLoop)

Z

public Trigger Z(EventLoop loop)

Constructs a Trigger instance around the Z button's digital signal.

Parameters:

loop - the event loop instance to attach the event to.

Returns:

a Trigger instance representing the Z button's digital signal attached to the given loop.

dpadUp

public Trigger dpadUp()

Constructs a Trigger instance around the Dpad Up button's digital signal.

Returns:

a Trigger instance representing the Dpad Up button's digital signal attached to the default scheduler event loop on the scheduler passed to the controller's constructor, or the default scheduler if a scheduler was not explicitly provided.

See Also:

• dpadUp(EventLoop)

dpadUp

public Trigger dpadUp(EventLoop loop)

Constructs a Trigger instance around the Dpad Up button's digital signal.

Parameters:

loop - the event loop instance to attach the event to.

Returns:

a Trigger instance representing the Dpad Up button's digital signal attached to the given loop.

dpadDown

public Trigger dpadDown()

Constructs a Trigger instance around the Dpad Down button's digital signal.

Returns:

a Trigger instance representing the Dpad Down button's digital signal attached to the default scheduler event loop on the scheduler passed to the controller's constructor, or the default scheduler if a scheduler was not explicitly provided.

See Also:

• dpadDown(EventLoop)

dpadDown

public Trigger dpadDown(EventLoop loop)

Constructs a Trigger instance around the Dpad Down button's digital signal.

Parameters:

loop - the event loop instance to attach the event to.

Returns:

a Trigger instance representing the Dpad Down button's digital signal attached to the given loop.

dpadLeft

public Trigger dpadLeft()

Constructs a Trigger instance around the Dpad Left button's digital signal.

Returns:

a Trigger instance representing the Dpad Left button's digital signal attached to the default scheduler event loop on the scheduler passed to the controller's constructor, or the default scheduler if a scheduler was not explicitly provided.

See Also:

• dpadLeft(EventLoop)

dpadLeft

public Trigger dpadLeft(EventLoop loop)

Constructs a Trigger instance around the Dpad Left button's digital signal.

Parameters:

loop - the event loop instance to attach the event to.

Returns:

a Trigger instance representing the Dpad Left button's digital signal attached to the given loop.

dpadRight

public Trigger dpadRight()

Constructs a Trigger instance around the Dpad Right button's digital signal.

Returns:

a Trigger instance representing the Dpad Right button's digital signal attached to the default scheduler event loop on the scheduler passed to the controller's constructor, or the default scheduler if a scheduler was not explicitly provided.

See Also:

• dpadRight(EventLoop)

dpadRight

public Trigger dpadRight(EventLoop loop)

Constructs a Trigger instance around the Dpad Right button's digital signal.

Parameters:

loop - the event loop instance to attach the event to.

Returns:

a Trigger instance representing the Dpad Right button's digital signal attached to the given loop.

capture

public Trigger capture()

Constructs a Trigger instance around the Capture button's digital signal.

Returns:

a Trigger instance representing the Capture button's digital signal attached to the default scheduler event loop on the scheduler passed to the controller's constructor, or the default scheduler if a scheduler was not explicitly provided.

See Also:

• capture(EventLoop)

capture

public Trigger capture(EventLoop loop)

Constructs a Trigger instance around the Capture button's digital signal.

Parameters:

loop - the event loop instance to attach the event to.

Returns:

a Trigger instance representing the Capture button's digital signal attached to the given loop.

C

public Trigger C()

Constructs a Trigger instance around the C button's digital signal.

Returns:

a Trigger instance representing the C button's digital signal attached to the default scheduler event loop on the scheduler passed to the controller's constructor, or the default scheduler if a scheduler was not explicitly provided.

See Also:

• C(EventLoop)

C

public Trigger C(EventLoop loop)

Constructs a Trigger instance around the C button's digital signal.

Parameters:

loop - the event loop instance to attach the event to.

Returns:

a Trigger instance representing the C button's digital signal attached to the given loop.

L

public Trigger L()

Constructs a Trigger instance around the L button's digital signal.

Returns:

a Trigger instance representing the L button's digital signal attached to the default scheduler event loop on the scheduler passed to the controller's constructor, or the default scheduler if a scheduler was not explicitly provided.

See Also:

• L(EventLoop)

L

public Trigger L(EventLoop loop)

Constructs a Trigger instance around the L button's digital signal.

Parameters:

loop - the event loop instance to attach the event to.

Returns:

a Trigger instance representing the L button's digital signal attached to the given loop.

R

public Trigger R()

Constructs a Trigger instance around the R button's digital signal.

Returns:

a Trigger instance representing the R button's digital signal attached to the default scheduler event loop on the scheduler passed to the controller's constructor, or the default scheduler if a scheduler was not explicitly provided.

See Also:

• R(EventLoop)

R

public Trigger R(EventLoop loop)

Constructs a Trigger instance around the R button's digital signal.

Parameters:

loop - the event loop instance to attach the event to.

Returns:

a Trigger instance representing the R button's digital signal attached to the given loop.

LTrigger

public Trigger LTrigger(double threshold,
 EventLoop loop)

Constructs a Trigger instance around the axis value of the L Trigger. The returned trigger will be true when the axis value is greater than threshold.

Parameters:

threshold - the minimum axis value for the returned Trigger to be true. This value should be in the range [0, 1] where 0 is the unpressed state of the axis.

loop - the event loop instance to attach the Trigger to.

Returns:

a Trigger instance that is true when the L Trigger axis exceeds the provided threshold, attached to the given event loop

LTrigger

public Trigger LTrigger(double threshold)

Constructs a Trigger instance around the axis value of the L Trigger. The returned trigger will be true when the axis value is greater than threshold.

Parameters:

threshold - the minimum axis value for the returned Trigger to be true. This value should be in the range [0, 1] where 0 is the unpressed state of the axis.

Returns:

a Trigger instance that is true when the L Trigger axis exceeds the provided threshold, attached to the default scheduler event loop on the scheduler passed to the controller's constructor, or the default scheduler if a scheduler was not explicitly provided.

LTrigger

public Trigger LTrigger()

Constructs a Trigger instance around the axis value of the L Trigger. The returned trigger will be true when the axis value is greater than 0.5.

Returns:

a Trigger instance that is true when the L Trigger axis exceeds 0.5, attached to the default scheduler event loop on the scheduler passed to the controller's constructor, or the default scheduler if a scheduler was not explicitly provided.

RTrigger

public Trigger RTrigger(double threshold,
 EventLoop loop)

Constructs a Trigger instance around the axis value of the R Trigger. The returned trigger will be true when the axis value is greater than threshold.

Parameters:

threshold - the minimum axis value for the returned Trigger to be true. This value should be in the range [0, 1] where 0 is the unpressed state of the axis.

loop - the event loop instance to attach the Trigger to.

Returns:

a Trigger instance that is true when the R Trigger axis exceeds the provided threshold, attached to the given event loop

RTrigger

public Trigger RTrigger(double threshold)

Constructs a Trigger instance around the axis value of the R Trigger. The returned trigger will be true when the axis value is greater than threshold.

Parameters:

threshold - the minimum axis value for the returned Trigger to be true. This value should be in the range [0, 1] where 0 is the unpressed state of the axis.

Returns:

a Trigger instance that is true when the R Trigger axis exceeds the provided threshold, attached to the default scheduler event loop on the scheduler passed to the controller's constructor, or the default scheduler if a scheduler was not explicitly provided.

RTrigger

public Trigger RTrigger()

Constructs a Trigger instance around the axis value of the R Trigger. The returned trigger will be true when the axis value is greater than 0.5.

Returns:

a Trigger instance that is true when the R Trigger axis exceeds 0.5, attached to the default scheduler event loop on the scheduler passed to the controller's constructor, or the default scheduler if a scheduler was not explicitly provided.

getLeftX

public double getLeftX()

Get the Left X value of the controller.

Returns:

The axis value.

getLeftY

public double getLeftY()

Get the Left Y value of the controller.

Returns:

The axis value.

getCStickX

public double getCStickX()

Get the C Stick X value of the controller.

Returns:

The axis value.

getCStickY

public double getCStickY()

Get the C Stick Y value of the controller.

Returns:

The axis value.

getLTrigger

public double getLTrigger()

Get the L Trigger value of the controller.

Returns:

The axis value.

getRTrigger

public double getRTrigger()

Get the R Trigger value of the controller.

Returns:

The axis value.