TitanSmall Encoder class c++ documentation. More...

#include <TitanSmallEncoder.h>

Inheritance diagram for studica::TitanSmallEncoder:

Public Member Functions
	TitanSmallEncoder (TitanSmall &titan, 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	GetRPM ()

double	GetSpeed ()

bool	GetDirection () const override

void	SetReverseDirection ()

Detailed Description

TitanSmall Encoder class c++ documentation.

Author: Studica Limited

Constructor & Destructor Documentation

◆ TitanSmallEncoder()

studica::TitanSmallEncoder::TitanSmallEncoder	(	TitanSmall &	titan,
		double	distPerTick
	)

Constructor for encoders

Parameters

titan	- The reference to the TitanSmall encoders that are being initialize
distPerTick	- Distance per tick value for the encoder

Member Function Documentation

◆ GetDirection()

bool studica::TitanSmallEncoder::GetDirection ( ) const

override

Gets the direction of the encoder

Returns: direction

◆ GetEncoderDistance()

double studica::TitanSmallEncoder::GetEncoderDistance ( )

Gets the encoder distance

Returns: Encoder distance for specified encoder

◆ GetRaw()

double studica::TitanSmallEncoder::GetRaw ( )

Gets the raw count of encoder

Returns: Raw count

◆ GetRPM()

double studica::TitanSmallEncoder::GetRPM ( )

Gets the round per minute of encoder

Returns: Round pre minute

◆ GetSpeed()

double studica::TitanSmallEncoder::GetSpeed ( )

Gets the speed of the encoder

Returns: speed

◆ SetReverseDirection()

void studica::TitanSmallEncoder::SetReverseDirection ( )

Sets the direction of the encoder

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

C:/Users/Studica/Studica/Studica/src/main/native/include/studica/TitanSmallEncoder.h

Public Member Functions