iDevice.hpp

Go to the documentation of this file.

#ifndef FCF_DEVMGR_COMMON_IDEVICE_HPP
#define FCF_DEVMGR_COMMON_IDEVICE_HPP

#include <any>

#include <rad/getPayload.hpp>
#include <dit/fits/fits.hpp>
#include <fcf/common/dispatcher.hpp>


// 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 "fcf/devmgr/common/deviceMaker.hpp"
#define REGISTER_DEVICE(T) static fcf::devmgr::common::DeviceMaker<T> maker(#T)

namespace fcf {
  namespace devmgr {
    namespace common {

      class IDeviceConfig;
      class DeviceLcsIf;
      class IDevice {

      public:


        virtual void CreateObjects(std::shared_ptr<fcf::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 UpdateStatus() = 0;

        virtual void Setup(const std::any& payload) = 0;

        virtual bool IsSetupActive(const std::any& payload) const = 0;

        virtual void Status(const std::any& payload, std::string& buffer) = 0;


        virtual void Status(bool end_acq,
                            const dit::did::Did& dictionary,
                            std::shared_ptr<CCfits::FITS>& fits_handle) = 0;

        virtual void Simulate(rad::AnyEvent const& last_event) = 0;

        virtual void StopSim(rad::AnyEvent const& last_event) = 0;

        virtual void Ignore(rad::AnyEvent const& last_event) = 0;

        virtual void StopIgn(rad::AnyEvent const& last_event) = 0;

        virtual void HwReset(rad::AnyEvent const& last_event) = 0;

        virtual void HwInit(rad::AnyEvent const& last_event) = 0;

        virtual void HwEnable(rad::AnyEvent const& last_event) = 0;

        virtual void HwDisable(rad::AnyEvent const& last_event) = 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 //FCF_DEVMGR_COMMON_IDEVICE_HPP