PulseTimer.h

 
#ifndef MFRAME_7F782700_B98A_43B9_8DE2_E02B6973E8FD
#define MFRAME_7F782700_B98A_43B9_8DE2_E02B6973E8FD
 
/* ***************************************************************************************
 * Include
 */
 
//----------------------------------------------------------------------------------------
#include "./../../hal/digital/EdgeTrigger.h"
#include "./../lang/Object.h"
#include "./../lang/Updatable.h"
#include "./../util/ElapsedTimer.h"
 
//----------------------------------------------------------------------------------------
 
/* ***************************************************************************************
 * Namespace
 */
namespace ufm::hw {
  class PulseTimer;
}  // namespace ufm::hw
 
/* ***************************************************************************************
 * Class/Interface/Struct/Enum
 */
 
class ufm::hw::PulseTimer : public ufm::lang::Object,
                            public hal::digital::EdgeTrigger::Event,
                            public ufm::lang::Updatable {
  /* *************************************************************************************
   * Class/Interface/Struct/Enum - Flag
   */
 public:
  union Flag {
    struct {
      bool handle : 1;
      bool direct : 1;
      bool skip   : 1;
    } bits;
    uint8 value;
  };
 
  /* *************************************************************************************
   * Class/Interface/Struct/Enum - Event
   */
 public:
  struct Event {
    /* ***********************************************************************************
     * Method
     */
 
    virtual void onHighDuration(uint32 microscronds) abstract;
 
    virtual void onLowDuration(uint32 microscronds) abstract;
  };
 
  /* *************************************************************************************
   * Class/Interface/Struct/Enum - State
   */
 
  enum class State : uint8 {
    RISE, 
    FALL, 
    NONE  
  };
 
  /* *************************************************************************************
   * Variable
   */
 public:
  ufm::util::ElapsedTimer vElapsedTimer; 
  uint32 vDebounce; 
  uint32 vRecode;   
  Event* vEvent;    
  Flag   vFlag;     
  State  vState;    
  /* *************************************************************************************
   * Abstract Method
   */
 
  /* *************************************************************************************
   * Construct Method
   */
 public:
  PulseTimer(uint32 debounce = 1000, Event* event = nullptr);
 
  virtual ~PulseTimer(void) override;
 
  /* *************************************************************************************
   * Operator Method
   */
 
  /* *************************************************************************************
   * Override - hal::digital::EdgeTrigger::Event
   */
 public:
  virtual void onEdgeRise(void) override;
 
  virtual void onEdgeFall(void) override;
 
  /* *************************************************************************************
   * Override - ufm::lang::Updatable
   */
 public:
  virtual void update(void) override;
 
  /* *************************************************************************************
   * Public Method
   */
 public:
  inline void setDebounce(uint32 micros) {
    this->vDebounce = micros;
    return;
  }
 
  inline void setEvent(Event* event) {
    this->vEvent = event;
    return;
  }
 
  inline State getState(void) {
    return this->vState;
  }
 
  inline bool isRise(void) {
    return (this->vState == State::RISE);
  }
 
  inline bool isFall(void) {
    return (this->vState == State::FALL);
  }
 
  inline uint32 getDuration(void) {
    return this->vRecode + static_cast<uint32>(this->vElapsedTimer.elapsed());
  }
 
  /* *************************************************************************************
   * Protected Method
   */
 
  /* *************************************************************************************
   * Private Method
   */
 public:
  void handle(bool direct);
 
  /* *************************************************************************************
   * Static Variable
   */
 
  /* *************************************************************************************
   * Static Method
   */
};
 
/* ***************************************************************************************
 * End of file
 */
 
#endif /* MFRAME_7F782700_B98A_43B9_8DE2_E02B6973E8FD */