SerialBusDevice.h

 
#ifndef MFRAME_883AFE3A_63E9_470C_B1ED_2E02C0817EF2
#define MFRAME_883AFE3A_63E9_470C_B1ED_2E02C0817EF2
 
/* ***************************************************************************************
 * Include
 */
 
//----------------------------------------------------------------------------------------
#include "./../io/SerialBus.h"
#include "./../lang/Object.h"
//----------------------------------------------------------------------------------------
 
/* ***************************************************************************************
 * Namespace
 */
namespace ufm::io {
  class SerialBusDevice;
}  // namespace ufm::io
 
/* ***************************************************************************************
 * Class/Interface/Struct/Enum
 */
 
class ufm::io::SerialBusDevice : public ufm::lang::Object,
                                 public ufm::io::SerialBus::Event {
  /* *************************************************************************************
   * Status
   */
 public:
  enum struct State : uint8_t {
    IDLE        = 0,
    COMPLETE    = 1,
    NO_RESPONSE = 2,
    BUS_ERROR   = 3,
    CANCEL      = 4
  };
  /* *************************************************************************************
   * Variable
   */
 private:
  int   vCompletedQuantity;
  State vState;
 
  /* *************************************************************************************
   * Abstract Method
   */
 
  /* *************************************************************************************
   * Construct Method
   */
 public:
  SerialBusDevice(void);
 
  virtual ~SerialBusDevice(void) override;
 
  /* *************************************************************************************
   * Operator Method
   */
 
  /* *************************************************************************************
   * Override Method - hal::serial::SerialBusEvent
   */
 public:
  virtual void onComplete(void) override;
 
  virtual void onNoResponseEvent(int completedQuantity) override;
 
  virtual void onBusErrorEvent(int completedQuantity) override;
 
  virtual void onCancel(int completedQuantity) override;
 
  /* *************************************************************************************
   * Public Method
   */
 public:
  void flush(void);
 
  inline int getCompletedQuantity(void) const {
    return this->vCompletedQuantity;
  }
 
  inline State getStatus(void) const {
    return this->vState;
  }
 
  inline bool isIdle(void) const {
    return (this->vState == State::IDLE);
  }
 
  inline bool isComplete(void) const {
    return (this->vState == State::COMPLETE);
  }
 
  inline bool isNoResponse(void) const {
    return (this->vState == State::NO_RESPONSE);
  }
 
  inline bool isBusError(void) const {
    return (this->vState == State::BUS_ERROR);
  }
 
  inline bool isCancel(void) const {
    return (this->vState == State::CANCEL);
  }
 
  /* *************************************************************************************
   * Protected Method
   */
 
  /* *************************************************************************************
   * Private Method
   */
 
  /* *************************************************************************************
   * Static Variable
   */
 
  /* *************************************************************************************
   * Static Method
   */
};
 
/* ***************************************************************************************
 * End of file
 */
 
#endif /* MFRAME_883AFE3A_63E9_470C_B1ED_2E02C0817EF2 */