LRT14  1.0
 All Classes Namespaces Functions Variables Enumerations Enumerator
LRTJaguar Class Reference

Wrapper for PWM Jaguars. More...

#include <LRTJaguar.h>

Inheritance diagram for LRTJaguar:
Collaboration diagram for LRTJaguar:

Public Member Functions

virtual void SetDutyCycle (float value)
 Sets the duty cycle of this speed controller.
 
virtual float GetDutyCycle ()
 Returns the last set duty cycle of this speed controller.
 
virtual float GetHardwareValue ()
 Returns the last duty cycle sent to the speed controller.
 
virtual void ConfigNeutralMode (LRTSpeedController::NeutralMode mode)
 Sets the neutral mode (brake or coast).
 
virtual NeutralMode GetNeutralMode ()
 Gets the neutral mode (brake or coast).
 
void Update ()
 
- Public Member Functions inherited from LRTSpeedController
void Output ()
 Checks safety and sends the saved values to the speed controllers.
 
void RegisterSafety (CounterBase *encoder, double timeoutSeconds, float threshold=0.01)
 Registers an encoder with this speed controller for stall safety.
 
virtual void SafetyCallback ()
 Called when safety fails on this speed controller.
 
virtual void Log ()
 Logs data to the Logger.
 
virtual void Send ()
 Sends data to the LiveNetworkSender.
 

Additional Inherited Members

- Static Public Member Functions inherited from LRTSpeedController
static float CurrentLimit (float dutyCycle, float speed, float forwardLimit, float reverseLimit)
 Calculates a duty cycle with current limiting applied.
 
- Protected Member Functions inherited from LiveNetworkSendable
template<typename T >
void SendToNetwork (T value, std::string key, std::string table)
 Sends a value to the network through LiveNetworkSender.
 
- Protected Member Functions inherited from Loggable
template<typename T >
void LogToFile (T *field, std::string name)
 Saves a variable to the Logger for logging.
 
template<typename T >
void LogToFile (T *field, int count, std::string name)
 Saves a dynamically allocated array to the Logger for logging.
 
template<typename T >
void LogToFile (T value, std::string name)
 Saves a value to the Logger for logging.
 

Detailed Description

Wrapper for PWM Jaguars.

Member Function Documentation

void LRTJaguar::ConfigNeutralMode ( LRTSpeedController::NeutralMode  mode)
virtual

Sets the neutral mode (brake or coast).

Parameters
modethe neutral mode (brake or coast)

Implements LRTSpeedController.

float LRTJaguar::GetDutyCycle ( )
virtual

Returns the last set duty cycle of this speed controller.

Returns
the last set duty cycle

Implements LRTSpeedController.

float LRTJaguar::GetHardwareValue ( )
virtual

Returns the last duty cycle sent to the speed controller.

Returns
the last duty cycle sent

Implements LRTSpeedController.

LRTJaguar::NeutralMode LRTJaguar::GetNeutralMode ( )
virtual

Gets the neutral mode (brake or coast).

Returns
the neutral mode (brake or coast)

Implements LRTSpeedController.

void LRTJaguar::SetDutyCycle ( float  pwm)
virtual

Sets the duty cycle of this speed controller.

Parameters
pwmthe duty cycle to set

Implements LRTSpeedController.

void LRTJaguar::Update ( )
virtual

Writes the values to the Jaguar.

Implements LRTSpeedController.


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