deviceConfig.hpp

Go to the documentation of this file.

#ifndef DEVMGR_COMMON_DEVICECONFIG_HPP_
#define DEVMGR_COMMON_DEVICECONFIG_HPP_

// System headers
#include <string>
#include <unordered_map>

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

#include <fcf/common/iComm.hpp>
#include <devmgr/common/iDeviceConfig.hpp>
#include <devmgr/common/configSet.hpp>

namespace devmgr {
  namespace common {

    // Constants for common configuration
    const std::string CI_IDENTIFIER             = "identifier";
    const std::string CI_SIMULATED              = "simulated";
    const std::string CI_IGNORED                = "ignored";
    const std::string CI_ADDRESS                = "address";
    const std::string CI_SIM_ADDRESS            = "simaddr";
    const std::string CI_TYPE                   = "type";
    const std::string CI_PREFIX                 = "prefix";
    const std::string CI_NAMESPACE              = "namespace";
    const std::string CI_MAP_FILE               = "mapfile";
    const std::string CI_FITS_PREFIX            = "fits_prefix";
    const std::string CI_ALIAS                  = "alias";
    const std::string CI_CFG_FILE               = "cfgfile";
    const std::string CI_CTRL_CONFIG            = "ctrl_config";

    // Constants for common RPC calls
    const std::string RPC_INIT                  = "rpcInit";
    const std::string RPC_ENABLE                = "rpcEnable";
    const std::string RPC_DISABLE               = "rpcDisable";
    const std::string RPC_STOP                  = "rpcStop";
    const std::string RPC_RESET                 = "rpcReset";

    // Constants for common status attributes
    const std::string CI_STAT_SUBSTATE          = "substate";
    const std::string CI_STAT_STATE             = "state";
    const std::string CI_STAT_STATU             = "status";
    const std::string CI_STAT_LOCAL             = "local";
    const std::string CI_STAT_ERROR_CODE        = "error_code";
    const std::string CI_STAT_ERROR_STR         = "error_str";
    const std::string DB_CONTROLLER_PREFIX      = "lcs";

    // Constants for address categories
    const std::string CAT_STAT                  = "stat";
    const std::string CAT_CFG                   = "cfg";
    const std::string CAT_RPC                   = "rpc";

    // Constants for state values
    const short STATE_STANDBY                   =  1;
    const short STATE_OPERATIONAL               =  2;

    const std::string STATE_STANDBY_STR         =  "NotOperational";
    const std::string STATE_OPERATIONAL_STR     =  "Operational";
    const std::string STATE_UNAVAILABLE_STR     =  "Unavailable";

    const std::unordered_map<short, std::string>  StateMap = {
      {STATE_STANDBY,       STATE_STANDBY_STR},
      {STATE_OPERATIONAL,   STATE_OPERATIONAL_STR},
    };

    const std::unordered_map<std::string, short>  StateStrMap = {
      {STATE_STANDBY_STR,       STATE_STANDBY},
      {STATE_OPERATIONAL_STR,   STATE_OPERATIONAL},
    };

    // Constants for substate values
    const short SUBSTATE_NOTREADY               =  100;
    const short SUBSTATE_INITIALISING           =  101;
    const short SUBSTATE_READY                  =  102;
    const short SUBSTATE_DISABLING              =  200;

    const std::string SUBSTATE_NOTREADY_STR     =  "NotReady";
    const std::string SUBSTATE_INITIALISING_STR =  "Initialising";
    const std::string SUBSTATE_READY_STR        =  "Ready";
    const std::string SUBSTATE_DISABLING_STR    =  "Disabling";

    const std::string FITS_PARAM_ID             = "ID";
    const std::string FITS_PARAM_NAME           = "NAME";
    const std::string FITS_PARAM_STAT           = "STAT";
    const std::string FITS_PARAM_DEVSIM         = "DEVSIM";
    const std::string FITS_PARAM_DEVIGN         = "DEVIGN";


    // Type definitions
    using CfgBool    = devmgr::common::ConfigSet<bool>;
    using CfgInt     = devmgr::common::ConfigSet<int>;
    using CfgUInt    = devmgr::common::ConfigSet<unsigned int>;
    using CfgDouble  = devmgr::common::ConfigSet<double>;

    using MapCfgBool   = std::map<int, CfgBool>;
    using MapCfgInt    = std::map<int, CfgInt>;
    using MapCfgUInt   = std::map<int, CfgUInt>;
    using MapCfgDouble = std::map<int, CfgDouble>;

    class DeviceConfig : public IDeviceConfig {

    public:
      DeviceConfig(const std::string& filename, const std::string& name);

      virtual ~DeviceConfig();

      virtual bool Init();


      std::string  GetIdentifier();

      std::string  GetPrefix();

      std::string  GetAddress();

      std::string  GetSimAddress();

      std::string  GetFitsPrefix();


      std::string  GetType();

      int          GetNamespace();

      std::string  GetAlias();

      std::string  GetName();

      std::string  GetNodeId(const std::string& attrib);

      std::string  GetProcId(const std::string& attrib);

      std::string  GetObjId();

      virtual void GetConfigList(std::vector<std::string>& cfg_list, std::string prefix);

      std::string GetCfgFile();


      virtual void SetSimulateFlag(bool flag);

      virtual void SetIgnoreFlag(bool flag);

      virtual bool GetIgnored();

      virtual bool GetSimulated();

    protected:

      std::string         m_filename;    
      std::string         m_name;        
      YAML::Node          m_configNode;  
      std::string         m_identifier;  
      std::string         m_type;        
      std::string         m_fits_prefix;
      bool                m_simulated;
      bool                m_ignored;
      std::string         m_lcs_prefix;
      std::string         m_address;
      std::string         m_sim_address;
      std::string         m_map_file;
      std::string         m_alias;
      int                 m_lcs_namespace;
    };
  }
}


#endif //DEVMGR_COMMON_DEVICECONFIG_HPP_