WPILib  2014.0
WPIRoboticsLibraryforFRC
 All Classes Functions Variables Pages
Public Member Functions | List of all members
SpeedController Class Referenceabstract

#include <SpeedController.h>

Inheritance diagram for SpeedController:
PIDOutput CANJaguar Jaguar Talon Victor

Public Member Functions

virtual void Set (float speed, uint8_t syncGroup=0)=0
 
virtual float Get ()=0
 
virtual void Disable ()=0
 
- Public Member Functions inherited from PIDOutput
virtual void PIDWrite (float output)=0
 

Detailed Description

Interface for speed controlling devices.

Member Function Documentation

virtual void SpeedController::Disable ( )
pure virtual

Common interface for disabling a motor.

Implemented in CANJaguar, Jaguar, Talon, and Victor.

virtual float SpeedController::Get ( )
pure virtual

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.

Implemented in CANJaguar, Jaguar, Talon, and Victor.

virtual void SpeedController::Set ( float  speed,
uint8_t  syncGroup = 0 
)
pure virtual

Common interface for setting the speed of a speed controller.

Parameters
speedThe speed to set. Value should be between -1.0 and 1.0.
syncGroupThe update group to add this Set() to, pending UpdateSyncGroup(). If 0, update immediately.

Implemented in CANJaguar, Jaguar, Talon, and Victor.


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