Alex Pirciu / Mbed 2 deprecated BFMC

a

Dependencies:   mbed mbed-rtos

include/Encoders/encoderinterface.hpp@1:ceee5a608e7c, 2019-03-28 (annotated)

Committer:
alexpirciu
Date:
Thu Mar 28 07:44:42 2019 +0000
Revision:
1:ceee5a608e7c
assa

Who changed what in which revision?

UserRevisionLine numberNew contents of line
alexpirciu 1:ceee5a608e7c 1 /**
alexpirciu 1:ceee5a608e7c 2 * @file encoderinterface.hpp
alexpirciu 1:ceee5a608e7c 3 * @author RBRO/PJ-IU
alexpirciu 1:ceee5a608e7c 4 * @brief
alexpirciu 1:ceee5a608e7c 5 * @version 0.1
alexpirciu 1:ceee5a608e7c 6 * @date 2018-10-24
alexpirciu 1:ceee5a608e7c 7 *
alexpirciu 1:ceee5a608e7c 8 * @copyright Copyright (c) 2018
alexpirciu 1:ceee5a608e7c 9 *
alexpirciu 1:ceee5a608e7c 10 */
alexpirciu 1:ceee5a608e7c 11 #ifndef ENDOCER_INTERFACE_HPP
alexpirciu 1:ceee5a608e7c 12 #define ENDOCER_INTERFACE_HPP
alexpirciu 1:ceee5a608e7c 13
alexpirciu 1:ceee5a608e7c 14 #include <stdint.h>
alexpirciu 1:ceee5a608e7c 15 namespace encoders{
alexpirciu 1:ceee5a608e7c 16 /**
alexpirciu 1:ceee5a608e7c 17 * @brief Rotary encoder interface class
alexpirciu 1:ceee5a608e7c 18 *
alexpirciu 1:ceee5a608e7c 19 */
alexpirciu 1:ceee5a608e7c 20 class IEncoderGetter{
alexpirciu 1:ceee5a608e7c 21 public:
alexpirciu 1:ceee5a608e7c 22 /**
alexpirciu 1:ceee5a608e7c 23 * @brief Get the Count value
alexpirciu 1:ceee5a608e7c 24 *
alexpirciu 1:ceee5a608e7c 25 * @return int16_t
alexpirciu 1:ceee5a608e7c 26 */
alexpirciu 1:ceee5a608e7c 27 virtual int16_t getCount() = 0;
alexpirciu 1:ceee5a608e7c 28 /**
alexpirciu 1:ceee5a608e7c 29 * @brief Get the Speed Rps
alexpirciu 1:ceee5a608e7c 30 *
alexpirciu 1:ceee5a608e7c 31 * @return float
alexpirciu 1:ceee5a608e7c 32 */
alexpirciu 1:ceee5a608e7c 33 virtual float getSpeedRps() = 0;
alexpirciu 1:ceee5a608e7c 34 /**
alexpirciu 1:ceee5a608e7c 35 * @brief 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.
alexpirciu 1:ceee5a608e7c 36 *
alexpirciu 1:ceee5a608e7c 37 * @return bool
alexpirciu 1:ceee5a608e7c 38 */
alexpirciu 1:ceee5a608e7c 39 virtual bool isAbs() = 0;
alexpirciu 1:ceee5a608e7c 40 };
alexpirciu 1:ceee5a608e7c 41 }; // namepsace encoders;
alexpirciu 1:ceee5a608e7c 42
alexpirciu 1:ceee5a608e7c 43 #endif