device.hpp

Go to the documentation of this file.

 
#ifndef FCF_DEVMGR_COMMON_DEVICE_HPP
#define FCF_DEVMGR_COMMON_DEVICE_HPP
 
#include <functional>
 
#include <boost/algorithm/string/trim.hpp>
 
#include <ifw/fcf/devmgr/common/deviceConfig.hpp>
#include <ifw/fcf/devmgr/common/deviceLcsIf.hpp>
#include <ifw/fcf/devmgr/common/iDevice.hpp>
#include <ifw/fcf/devmgr/common/dataContext.hpp>
 
 
namespace ifw::fcf {
namespace devmgr {
  namespace common {
 
    class DeviceConfig;
    class DeviceLcsIf;
    class Device : public IDevice {
 
    public:
      Device(const std::string filename,
             const std::string name,
             DataContext& data_ctx);

      virtual ~Device();
 

      virtual bool IsNotReady() const override;
      virtual bool IsReady() const override;

      virtual bool IsOperational() const override;

      virtual void CheckHwFailure() const override;

      virtual bool IsDisabling() const override;

      virtual void Init() override;

      virtual void Enable() override;

      virtual void Disable() override;

      virtual void Stop() override;

      virtual void Reset() override;
 
 
 
       void GetStatusBuffer(const std::string& stat_prefix,
                           const DeviceControllerData* const data,
                           std::string& buffer);

      void GetStatusHeader(const std::string& prefix,
                          const ifw::core::dit::did::Did& dictionary,
                          std::shared_ptr<CCfits::FITS>& fits_handle);
 

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

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

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

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

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

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

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

      virtual void HwDisable(rad::AnyEvent const& last_event) override;

      virtual void StartMonitoring() override;

      virtual void StopMonitoring() override;

      inline virtual std::string GetName() const noexcept override {
        return m_name;
      };

      inline virtual std::string GetLogName() const noexcept {
        string name = "[" + m_name + "]";
        return name;
      };

      virtual std::shared_ptr<ifw::fcf::devmgr::common::DeviceLcsIf> GetLcsIf() const noexcept {
        return m_lcs_if;
      };

      virtual std::shared_ptr<ifw::fcf::devmgr::common::IDeviceConfig> GetConfig() const noexcept {
        return m_config;
      };
 

      void RegisterComm(std::shared_ptr<ifw::fnd::defs::ICommAdapter> comm_if,
                        std::function<void()> on_failure,
                        std::function<void()> on_normal);
 
    protected:

      inline bool IsMsgForMe(const std::string& id) const noexcept {
        if (m_name.compare(boost::algorithm::trim_copy(id)) == 0) {
            return true;
          }
        return false;
      };
 
      std::string GetFileName() const noexcept {
        return m_filename;
      };
 
      DataContext& GetDataCtx() const noexcept {
        return m_data_ctx;
      };

      void UpdateDb(ifw::core::utils::bat::DbVector& vec);

      void SetIgnore(bool flag);

      void SetSimulation(bool flag);

      void GetPrefix(const std::vector<std::string> prefix_list, std::string& prefix) const;
 
      std::string GetCfgPrefix(const std::vector<std::string> prefix_list) const;
      std::string GetStatPrefix(const std::vector<std::string> prefix_list) const;

      bool CheckNameParam(const std::any& payload);
 
      void GetStatusList(ifw::core::utils::bat::DbVector& cfg_list,
                                 const DeviceControllerData& status);

      virtual void WriteConfig();
 
    protected:
      // NOLINTBEGIN(misc-non-private-member-variables-in-classes)
      std::string                    m_filename; 
      std::string                    m_name;     
      DataContext&                   m_data_ctx; 

      std::function<void()>                        m_on_failure;
      std::function<void()>                        m_on_normal;

      std::shared_ptr<DeviceConfig>  m_config;

      std::shared_ptr<DeviceLcsIf>   m_lcs_if;
      // NOLINTEND(misc-non-private-member-variables-in-classes)
    private:
      log4cplus::Logger              m_logger;
 
    };
 
   }
  }
}
 
 
#endif //FCF_DEVMGR_COMMON_DEVICE_HPP