edu.wpi.first.wpilibj

Interface SpeedController

All Superinterfaces:

PIDOutput

All Known Implementing Classes:

CANJaguar, CANTalon, Jaguar, Talon, TalonSRX, Victor, VictorSP

public interface SpeedController
extends PIDOutput

Interface for speed controlling devices.

Method Summary

Modifier and Type	Method and Description
void	disable() Disable the speed controller
double	get() Common interface for getting the current set speed of a speed controller.
void	set(double speed) Common interface for setting the speed of a speed controller.
void	set(double speed, byte syncGroup) Common interface for setting the speed of a speed controller.

Methods inherited from interface edu.wpi.first.wpilibj.PIDOutput

pidWrite

Method Detail

get

double get()

Common interface for getting the current set speed of a speed controller.

Returns:

The current set speed. Value is between -1.0 and 1.0.

set

void set(double speed,
         byte syncGroup)

Common interface for setting the speed of a speed controller.

Parameters:

speed - The speed to set. Value should be between -1.0 and 1.0.

syncGroup - The update group to add this Set() to, pending UpdateSyncGroup(). If 0, update immediately.

set

void set(double speed)

Common interface for setting the speed of a speed controller.

Parameters:

speed - The speed to set. Value should be between -1.0 and 1.0.

disable

void disable()

Disable the speed controller