iodevConfig.hpp

Go to the documentation of this file.

 
#ifndef FCF_DEVMGR_DEVICE_IODEV_CONFIG_HPP
#define FCF_DEVMGR_DEVICE_IODEV_CONFIG_HPP
 
#include <string>
#include <vector>
#include <utility>
 
#include <yaml-cpp/yaml.h>
 
#include <ifw/core/utils/bat/logger.hpp>
#include <ifw/fcf/devmgr/common/deviceConfig.hpp>
#include <ifw/fcf/devmgr/common/dataContext.hpp>
#include <ifw/fcf/devmgr/devices/iodevRpcErrors.hpp>
#include <ifw/fcf/devmgr/devices/iodevHwErrors.hpp>
 
 
namespace ifw::fcf::devmgr::iodev {
 
constexpr auto LOGGER_NAME     = "iodev";
constexpr auto CI_NO_RPC       = "norpc";
constexpr auto CI_SENSOR       = "sensor";
 
// Constants for internal mapping
constexpr auto CI_CHANNELS       = "channels";
constexpr auto CI_NAME           = "name";
constexpr auto CI_DESCRIPTION    = "description";
constexpr auto CI_ALIAS          = "alias";
constexpr auto CI_TYPE           = "type";
constexpr auto CI_HEADER         = "header";
constexpr auto CI_LOG            = "log";
constexpr auto CI_UNIT           = "unit";
constexpr auto CI_MAP            = "map";
constexpr auto CI_VALUE          = "value";
constexpr auto CI_NAMED_MAPPING  = "named_values";
 
 
// Specific constant values for Sensor device state/substate
constexpr int SUBSTATE_OP_MONITORING      =  200;
constexpr auto SUBSTATE_OP_MONITORING_STR = "Monitoring";
 
const std::unordered_map<short, std::string>  SUBSTATE_MAP = {
    {fcf::devmgr::common::SUBSTATE_NOTREADY,      ifw::fcf::devmgr::common::SUBSTATE_NOTREADY_STR},
    {fcf::devmgr::common::SUBSTATE_READY,         ifw::fcf::devmgr::common::SUBSTATE_READY_STR},
    {fcf::devmgr::common::SUBSTATE_ERROR,         ifw::fcf::devmgr::common::SUBSTATE_ERROR_STR},
    {SUBSTATE_OP_MONITORING,                 SUBSTATE_OP_MONITORING_STR},
    {fcf::devmgr::common::SUBSTATE_OP_ERROR,      ifw::fcf::devmgr::common::SUBSTATE_OP_ERROR_STR},
};
 
constexpr auto DI_TYPE_STR = "DI";
constexpr auto AI_TYPE_STR = "AI";
constexpr auto II_TYPE_STR = "II";
constexpr auto SI_TYPE_STR = "SI";
 
constexpr auto DO_TYPE_STR = "DO";
constexpr auto AO_TYPE_STR = "AO";
constexpr auto IO_TYPE_STR = "IO";
constexpr auto SO_TYPE_STR = "SO";
 
constexpr auto DI_CAT_STR = "diChannels";
constexpr auto AI_CAT_STR = "aiChannels";
constexpr auto II_CAT_STR = "iiChannels";
constexpr auto SI_CAT_STR = "siChannels";
 
constexpr auto DO_CAT_STR = "doChannels";
constexpr auto AO_CAT_STR = "aoChannels";
constexpr auto IO_CAT_STR = "ioChannels";
constexpr auto SO_CAT_STR = "soChannels";
 
// Specific iodev RPC
constexpr auto RPC_SET_OUTPUTS           = "rpcSetOutputs";
 
 
const std::unordered_map<std::string, std::string> IO_DEV_TYPE_MAP = {
    {DI_TYPE_STR, DI_CAT_STR},
    {AI_TYPE_STR, AI_CAT_STR},
    {II_TYPE_STR, II_CAT_STR},
    {SI_TYPE_STR, SI_CAT_STR},
    {DO_TYPE_STR, DO_CAT_STR},
    {AO_TYPE_STR, AO_CAT_STR},
    {IO_TYPE_STR, IO_CAT_STR},
    {SO_TYPE_STR, SO_CAT_STR},
};
 
 
struct IODevChannel  {
public:
    IODevChannel();
    virtual ~IODevChannel() = default;
 
    inline std::string GetDescription() const;
    inline std::string GetAlias() const;
    inline std::string GetType() const;
    inline bool        GetHeaderFlag() const;
    inline bool        GetLogFlag() const;
    inline std::string GetUnit() const;
    inline std::string GetMap() const;
    inline std::string GetCat() const;
    inline std::string GetFitsPrefix() const;
    inline std::string GetNamedValue(std::string value) const;
 
    inline void SetDescription(std::string description);
    inline void SetAlias(std::string alias);
    inline void SetType(std::string type);
    inline void SetHeaderFlag(bool flag);
    inline void SetLogFlag(bool flag);
    inline void SetUnit(std::string unit);
    inline void SetMap(std::string map);
    inline void SetFitsPrefix(std::string prefix);
    inline void AddNamedValue(std::string value, std::string name);
 
 
protected:
    std::string m_description; // NOLINT(misc-non-private-member-variables-in-classes)
    std::string m_alias; // NOLINT(misc-non-private-member-variables-in-classes)
    std::string m_type; // NOLINT(misc-non-private-member-variables-in-classes)
    bool        m_header; // NOLINT(misc-non-private-member-variables-in-classes)
    bool        m_log; // NOLINT(misc-non-private-member-variables-in-classes)
    std::string m_unit; // NOLINT(misc-non-private-member-variables-in-classes)
    std::string m_map; // NOLINT(misc-non-private-member-variables-in-classes)
    std::string m_prefix; // NOLINT(misc-non-private-member-variables-in-classes)
    std::unordered_map<std::string, string> m_named_values_map; // NOLINT(misc-non-private-member-variables-in-classes)
};
 
class IODev;
class IODevConfig : public ifw::fcf::devmgr::common::DeviceConfig {
 
    friend class IODev;
    friend class IODevLcsIf;
 
public:
 
    IODevConfig(const std::string filename,
                const std::string name);
 
    IODevConfig(const std::string name);
 
    virtual ~IODevConfig() = default;
 
    void Init();
 
    virtual void GetConfig(ifw::core::protocol::base::VectorVariant& params) const override;
 
    virtual void GetConfigList(ifw::core::utils::bat::DbVector& cfg_list,
                               std::string prefix) const override;
 
    virtual void GetInputList(std::vector<std::string>& channel_list) const ;
 
    virtual void GetOutputList(std::vector<std::pair<std::string, std::string>>& channel_list) const ;
 
    bool IsNoRpc() const;
 
    bool IsSensor() const;
 
     std::string GetChannelType(const std::string& channel) const;
     std::string GetChannelDescription(const std::string& channel) const;
     std::string GetChannelNamedValue(const std::string& channel,
                                      const std::string& value) const;
 
     std::optional<IODevChannel> GetChannelConfig(const std::string& channel) const;
 
private:
    std::map<std::string, IODevChannel> m_channel_map;
    log4cplus::Logger  m_logger;
};
 
}
 
#include "iodevConfig.ipp"
#endif //FCF_DEVMGR_DEVICE_IODEV_CONFIG_HPP