deviceLcsIf.hpp

Go to the documentation of this file.

#ifndef DEVMGR_DEVICE_LCS_IF_H
#define DEVMGR_DEVICE_LCS_IF_H

// Third party headers
#include <yaml-cpp/yaml.h>

// Local headers
#include <fcf/common/iComm.hpp>
#include <fcf/common/dispatcher.hpp>
#include <devmgr/common/deviceConfig.hpp>


namespace devmgr {
  namespace common {

    struct DeviceControllerData {
    public:
      DeviceControllerData();
      virtual ~DeviceControllerData();
      inline short GetState() const;
      inline void SetState(short state);
      inline short GetSubstate() const;
      inline void SetSubstate(short subtate);

      inline bool GetLocalFlag() const;
      inline void SetLocalFlag(bool local_flag);
      inline int GetErrorCode() const;
      inline void SetErrorCode(int error_code);

      void SetData(const DeviceControllerData& data);

    protected:
      short    m_state;
      short    m_substate;
      bool     m_local;
      int      m_error_code;
    };

    class DeviceLcsIf {
    public:
      explicit DeviceLcsIf(std::shared_ptr<IDeviceConfig> config);

      virtual void RegisterComm(std::shared_ptr<fcf::common::IComm> commIf,
                                fcf::common::Dispatcher<>& failure,
                                fcf::common::Dispatcher<>& normal);

      virtual void Connect();

      virtual void Disconnect();

      virtual void ReadConfig() = 0;


      virtual bool IsNotReady() ;

      virtual bool IsReady() = 0 ;

      virtual bool IsDisabling() ;

      virtual bool IsOperational() = 0;

      virtual bool IsHwFailure() = 0;

      //virtual bool IsHwFailure(short substate) = 0;

      virtual void Init();

      virtual void Enable() ;

      virtual void Disable() ;

      virtual void Stop();

      virtual void Reset();

      virtual void StartMonitoring() = 0;

      virtual void StopMonitoring() = 0;

      virtual void Listener(fcf::common::VectorVariant& params) = 0;

      virtual std::string GetRpcError(const short error_code) const = 0 ;

      virtual std::string GetHwError(int& error_code, const bool update = false) = 0;


      std::string GetMapValue(std::string category, std::string key);

      fcf::common::Dispatcher<fcf::common::VectorVariant&>& GetDispatcher();

      bool IsConfigLoaded() const;

      bool IsConnected() const;

    protected:

      void LoadConfig();

    protected:

      void GetStates(short& state, short& substate);


      YAML::Node  m_config_node;

      std::shared_ptr<fcf::common::IComm>  m_comm;

      std::shared_ptr<IDeviceConfig>  m_config;

      fcf::common::Dispatcher<fcf::common::VectorVariant&>  m_dispatcher;

      fcf::common::Dispatcher<>   m_failure;

      fcf::common::Dispatcher<>   m_normal;

      short  m_state;

      short  m_substate;

      bool m_config_loaded;

      bool m_connected;

    };
  }
}

#include "deviceLcsIf.inline"

#endif //DEVMGR_DEVICE_LAMP_IF_H