SpeedController Class Reference

#include <SpeedController.h>

Inheritance diagram for SpeedController:

List of all members.

Public Member Functions
virtual void	Set (float speed, UINT8 syncGroup=0)=0
virtual float	Get ()=0
virtual void	Disable ()=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, 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, and Victor.

virtual void SpeedController::Set	(	float	speed,
		UINT8	syncGroup = 0
	)		[pure virtual]

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.

Implemented in CANJaguar, Jaguar, and Victor.

---

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

• SpeedController.h