a

Dependencies:   mbed mbed-rtos

Embed: (wiki syntax)

« Back to documentation index

IEncoderGetter Class Reference

IEncoderGetter Class Reference

Rotary encoder interface class. More...

#include <encoderinterface.hpp>

Inherited by CQuadratureEncoderTask.

Public Member Functions

virtual int16_t getCount ()=0
 Get the Count value.
virtual float getSpeedRps ()=0
 Get the Speed Rps.
virtual bool isAbs ()=0
 Get the encoder capability.

Detailed Description

Rotary encoder interface class.

Definition at line 20 of file encoderinterface.hpp.


Member Function Documentation

virtual int16_t getCount (  ) [pure virtual]

Get the Count value.

Returns:
int16_t

Implemented in CQuadratureEncoderTask, and CQuadratureEncoderWithFilterTask.

virtual float getSpeedRps (  ) [pure virtual]

Get the Speed Rps.

Returns:
float

Implemented in CQuadratureEncoderTask, and CQuadratureEncoderWithFilterTask.

virtual bool isAbs (  ) [pure virtual]

Get the encoder capability.

If it's true, than the encoder can give the oriantation, else it returns the absolute value of the rotation without the oriantation.

Returns:
bool

Implemented in CQuadratureEncoderTask.