iDevice.hpp

Go to the documentation of this file.

#ifndef DEVMGR_COMMON_IDEVICE_HPP
#define DEVMGR_COMMON_IDEVICE_HPP

#include <dit/fits/fits.hpp>
#include <fcf/common/dispatcher.hpp>
#include <devmgr/modif/requests.pb.h>

// For convenience this macro has been added.
// This allows you to register the second you inherited from Device class
// without the need to include anything else

#include "devmgr/common/deviceMaker.hpp"
#define REGISTER_DEVICE(T) static devmgr::common::DeviceMaker<T> maker(#T)


namespace devmgr {
  namespace common {

    class IDeviceConfig;
    class DeviceLcsIf;
    class IDevice {

    public:


      virtual void CreateObjects(std::shared_ptr<devmgr::common::IDeviceConfig> config = nullptr)=0;
      virtual void RegisterComm(std::shared_ptr<fcf::common::IComm> comm_if,
                                fcf::common::Dispatcher<>& failure,
                                fcf::common::Dispatcher<>& normal) = 0;


      virtual bool IsNotReady() const = 0;
      virtual bool IsReady() const = 0;

      virtual bool IsOperational() const = 0;

      virtual void CheckHwFailure() const = 0;

      virtual bool IsDisabling() const = 0;

      virtual void Init() = 0;

      virtual void Enable() = 0;

      virtual void Disable() = 0;

      virtual void Stop() = 0;

      virtual void Reset() = 0;

      virtual void HwReset(modif::ReqHwReset& hwResetMsg) = 0;

      virtual void HwInit(modif::ReqHwInit& hwInitMsg) = 0;

      virtual void HwEnable(modif::ReqHwEnable& hwEnableMsg) = 0;

      virtual void HwDisable(modif::ReqHwDisable& hwDisableMsg) = 0;

      virtual void UpdateStatus() = 0;

      virtual void Setup(const modif::ReqSetup& setupMsg) = 0;

      virtual bool IsSetupActive(const modif::ReqSetup& setupMsg) const = 0;

      virtual void Status(const modif::ReqStatus& statusMsg, std::string& buffer) = 0;


      virtual void Status(bool end_acq,
                          const dit::did::Did& dictionary,
                          CCfits::FITS* fits_handle = nullptr) = 0;

      virtual void Simulate(const modif::ReqSimulate& msg) = 0;

      virtual void StopSim(const modif::ReqStopSim& msg) = 0;

      virtual void Ignore(const modif::ReqIgnore& msg) = 0;

      virtual void StopIgn(const modif::ReqStopIgn& msg) = 0;

      virtual std::shared_ptr<DeviceLcsIf> GetLcsIf() const = 0;

      virtual std::shared_ptr<IDeviceConfig> GetConfig() const = 0;

      virtual void StartMonitoring() = 0;

      virtual void StopMonitoring() = 0;


      virtual std::string GetName() const = 0;

    };
  }
}


#endif //DEVMGR_COMMON_IDEVICE_HPP