Now you can download a copy of these docs so you can use them offline! Download now

Victor Class Reference

#include <Victor.h>

Inheritance diagram for Victor:
Collaboration diagram for Victor:

List of all members.

Public Member Functions

 Victor (UINT32 channel)
 Victor (UINT8 moduleNumber, UINT32 channel)
virtual void Set (float value, UINT8 syncGroup=0)
virtual float Get ()
virtual void Disable ()
virtual void PIDWrite (float output)

Detailed Description

IFI Victor Speed Controller

Definition at line 17 of file Victor.h.


Constructor & Destructor Documentation

Victor::Victor ( UINT32  channel  )  [explicit]

Constructor that assumes the default digital module.

Parameters:
channel The PWM channel on the digital module that the Victor is attached to.

Definition at line 39 of file Victor.cpp.

Victor::Victor ( UINT8  moduleNumber,
UINT32  channel 
)

Constructor that specifies the digital module.

Parameters:
moduleNumber The digital module (1 or 2).
channel The PWM channel on the digital module that the Victor is attached to (1..10).

Definition at line 50 of file Victor.cpp.


Member Function Documentation

void Victor::Disable (  )  [virtual]

Common interface for disabling a motor.

Definition at line 86 of file Victor.cpp.

float Victor::Get (  )  [virtual]

Get the recently set value of the PWM.

Returns:
The most recently set value for the PWM between -1.0 and 1.0.

Definition at line 78 of file Victor.cpp.

void Victor::PIDWrite ( float  output  )  [virtual]

Write out the PID value as seen in the PIDOutput base object.

Parameters:
output Write out the PWM value as was found in the PIDController

Implements PIDOutput.

Definition at line 96 of file Victor.cpp.

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

Set the PWM value.

The PWM value is set using a range of -1.0 to 1.0, appropriately scaling the value for the FPGA.

Parameters:
speed The speed value between -1.0 and 1.0 to set.
syncGroup Unused interface.

Definition at line 68 of file Victor.cpp.


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

Generated on Thu Jan 12 2012 22:35:38 for WPILibC++ by doxygen 1.7.1