Studica - Java Documentation
Public Member Functions | List of all members
com.studica.frc.TitanSmallEncoder Class Reference
Inheritance diagram for com.studica.frc.TitanSmallEncoder:

Public Member Functions

 TitanSmallEncoder (TitanSmall titan, double distPerTick)
 
double getEncoderDistance ()
 
double getRaw ()
 
double getRPM ()
 
double getSpeed ()
 
void setReverseDirection ()
 
int get ()
 
void reset ()
 
double getPeriod ()
 
void setMaxPeriod (double maxPeriod)
 
boolean getStopped ()
 
boolean getDirection ()
 

Detailed Description

TitanSmall Encoder class java documentation

Constructor & Destructor Documentation

◆ TitanSmallEncoder()

com.studica.frc.TitanSmallEncoder.TitanSmallEncoder ( TitanSmall  titan,
double  distPerTick 
)
inline

Initialize encoder

Parameters
titan- TitanSmall to be set
distPerTick- distance per tick value

Member Function Documentation

◆ getEncoderDistance()

double com.studica.frc.TitanSmallEncoder.getEncoderDistance ( )
inline

get encoder distance

Returns
encoder distance

◆ getRaw()

double com.studica.frc.TitanSmallEncoder.getRaw ( )
inline

Gets encoder's raw count

Returns
Raw count

◆ getRPM()

double com.studica.frc.TitanSmallEncoder.getRPM ( )
inline

Gets encoder's round per minute

Returns
Round per minute

◆ getSpeed()

double com.studica.frc.TitanSmallEncoder.getSpeed ( )
inline

Gets encoder's speed

Returns
speed

◆ setReverseDirection()

void com.studica.frc.TitanSmallEncoder.setReverseDirection ( )
inline

Sets encoder direction

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