Studica - C++ Documentation
studica::TitanQuadEncoder Class Reference

TitanQuad Encoder class c++ documentation. More...

#include <TitanQuadEncoder.h>

Inheritance diagram for studica::TitanQuadEncoder:

Public Member Functions

 TitanQuadEncoder (TitanQuad &titan, int encoder, double distPerTick)
 
int Get () const override
 
void Reset () override
 
double GetPeriod () const override
 
void SetMaxPeriod (double maxPeriod) override
 
bool GetStopped () const override
 
double GetEncoderDistance ()
 
double GetRaw ()
 
double GetSpeed ()
 
bool GetDirection () const override
 
void SetReverseDirection ()
 

Detailed Description

TitanQuad Encoder class c++ documentation.

Author
Studica Limited

Member Function Documentation

◆ GetDirection()

bool studica::TitanQuadEncoder::GetDirection ( ) const
override

Gets the direction of the encoder

◆ GetEncoderDistance()

double studica::TitanQuadEncoder::GetEncoderDistance ( )

Will give the distance traveled based on encoder data

Parameters
encoderencoder to be used
Returns
distance traveled

◆ GetRaw()

double studica::TitanQuadEncoder::GetRaw ( )

Gets the raw count of encoder

◆ GetSpeed()

double studica::TitanQuadEncoder::GetSpeed ( )

Gets the speed of the encoder

◆ SetReverseDirection()

void studica::TitanQuadEncoder::SetReverseDirection ( )

Sets the direction of the encoder


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