WPILibC++  unspecified
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Pages
SpeedController Class Referenceabstract

Interface for speed controlling devices. More...

#include <SpeedController.h>

Inheritance diagram for SpeedController:
PIDOutput CANSpeedController Jaguar SD540 Spark Talon TalonSRX Victor VictorSP

Public Member Functions

virtual void Set (float speed, uint8_t syncGroup=0)=0
 Common interface for setting the speed of a speed controller. More...
 
virtual float Get () const =0
 Common interface for getting the current set speed of a speed controller. More...
 
virtual void SetInverted (bool isInverted)=0
 Common interface for inverting direction of a speed controller. More...
 
virtual void Disable ()=0
 Common interface for disabling a motor.
 
virtual bool GetInverted () const =0
 Common interface for returning the inversion state of a speed controller. More...
 
virtual void StopMotor ()=0
 Common interface to stop the motor until Set is called again.
 
- Public Member Functions inherited from PIDOutput
virtual void PIDWrite (float output)=0
 

Detailed Description

Interface for speed controlling devices.

Member Function Documentation

virtual float SpeedController::Get ( ) const
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 CANTalon, CANJaguar, CANSpeedController, Victor, TalonSRX, VictorSP, Talon, SD540, Jaguar, and Spark.

virtual bool SpeedController::GetInverted ( ) const
pure virtual

Common interface for returning the inversion state of a speed controller.

Returns
isInverted The state of inversion, true is inverted.

Implemented in CANTalon, CANJaguar, Victor, VictorSP, TalonSRX, SD540, Spark, Jaguar, and Talon.

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 CANTalon, CANJaguar, CANSpeedController, Victor, TalonSRX, VictorSP, Talon, SD540, Jaguar, and Spark.

virtual void SpeedController::SetInverted ( bool  isInverted)
pure virtual

Common interface for inverting direction of a speed controller.

Parameters
isInvertedThe state of inversion, true is inverted.

Implemented in CANTalon, CANJaguar, Victor, VictorSP, TalonSRX, SD540, Spark, Jaguar, and Talon.


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