edu.wpi.first.wpilibj

Class JoystickBase

java.lang.Object

edu.wpi.first.wpilibj.GenericHID

edu.wpi.first.wpilibj.JoystickBase

Direct Known Subclasses:

Joystick

public abstract class JoystickBase
extends GenericHID

JoystickBase Interface.

Nested Class Summary

Nested classes/interfaces inherited from class edu.wpi.first.wpilibj.GenericHID

GenericHID.Hand, GenericHID.HIDType, GenericHID.RumbleType

Constructor Summary

Constructors

Constructor and Description
JoystickBase(int port)

Method Summary

Modifier and Type	Method and Description
abstract java.lang.String	getName() Get the name of the HID.
abstract int	getPOV(int pov) Get the angle in degrees of a POV on the HID.
abstract int	getPOVCount() For the current HID, return the number of POVs.
abstract double	getThrottle() Get the throttle.
boolean	getTop() Is the top button pressed.
abstract boolean	getTop(GenericHID.Hand hand) Is the top button pressed.
boolean	getTrigger() Is the trigger pressed.
abstract boolean	getTrigger(GenericHID.Hand hand) Is the trigger pressed.
abstract double	getTwist() Get the twist value.
abstract GenericHID.HIDType	getType() Get the type of the HID.
double	getZ()
abstract double	getZ(GenericHID.Hand hand) Get the z position of the HID.
abstract void	setOutput(int outputNumber, boolean value) Set a single HID output value for the HID.
abstract void	setOutputs(int value) Set all HID output values for the HID.
abstract void	setRumble(GenericHID.RumbleType type, double value) Set the rumble output for the HID.

Methods inherited from class edu.wpi.first.wpilibj.GenericHID

getPort, getPOV, getRawAxis, getRawButton, getX, getX, getY, getY

Methods inherited from class java.lang.Object

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

Constructor Detail

JoystickBase

public JoystickBase(int port)

Method Detail

getZ

public abstract double getZ(GenericHID.Hand hand)

Get the z position of the HID.

Parameters:

hand - which hand, left or right

Returns:

the z position

getZ

public double getZ()

getTwist

public abstract double getTwist()

Get the twist value.

Returns:

the twist value

getThrottle

public abstract double getThrottle()

Get the throttle.

Returns:

the throttle value

getTrigger

public final boolean getTrigger()

Is the trigger pressed.

Returns:

true if pressed

getTrigger

public abstract boolean getTrigger(GenericHID.Hand hand)

Is the trigger pressed.

Parameters:

hand - which hand

Returns:

true if the trigger for the given hand is pressed

getTop

public final boolean getTop()

Is the top button pressed.

Returns:

true if the top button is pressed

getTop

public abstract boolean getTop(GenericHID.Hand hand)

Is the top button pressed.

Parameters:

hand - which hand

Returns:

true if hte top button for the given hand is pressed

getPOV

public abstract int getPOV(int pov)

Description copied from class: GenericHID

Get the angle in degrees of a POV on the HID.

The POV angles start at 0 in the up direction, and increase clockwise (eg right is 90, upper-left is 315).

Specified by:

getPOV in class GenericHID

Parameters:

pov - The index of the POV to read (starting at 0)

Returns:

the angle of the POV in degrees, or -1 if the POV is not pressed.

getPOVCount

public abstract int getPOVCount()

Description copied from class: GenericHID

For the current HID, return the number of POVs.

Specified by:

getPOVCount in class GenericHID

getType

public abstract GenericHID.HIDType getType()

Description copied from class: GenericHID

Get the type of the HID.

Specified by:

getType in class GenericHID

Returns:

the type of the HID.

getName

public abstract java.lang.String getName()

Description copied from class: GenericHID

Get the name of the HID.

Specified by:

getName in class GenericHID

Returns:

the name of the HID.

setOutput

public abstract void setOutput(int outputNumber,
                               boolean value)

Description copied from class: GenericHID

Set a single HID output value for the HID.

Specified by:

setOutput in class GenericHID

Parameters:

outputNumber - The index of the output to set (1-32)

value - The value to set the output to

setOutputs

public abstract void setOutputs(int value)

Description copied from class: GenericHID

Set all HID output values for the HID.

Specified by:

setOutputs in class GenericHID

Parameters:

value - The 32 bit output value (1 bit for each output)

setRumble

public abstract void setRumble(GenericHID.RumbleType type,
                               double value)

Description copied from class: GenericHID

Set the rumble output for the HID. The DS currently supports 2 rumble values, left rumble and right rumble.

Specified by:

setRumble in class GenericHID

Parameters:

type - Which rumble value to set

value - The normalized value (0 to 1) to set the rumble to