ifw-fcf  3.0.0
iDeviceConfig.hpp
Go to the documentation of this file.
1 
9 #ifndef FCF_DEVMGR_COMMON_IDEVICECONFIG_HPP_
10 #define FCF_DEVMGR_COMMON_IDEVICECONFIG_HPP_
11 
12 // System headers
13 #include <string>
14 
15 // Third party headers
16 #include <yaml-cpp/yaml.h>
17 
18 #include <fcf/common/iComm.hpp>
20 
21 namespace fcf {
22  namespace devmgr {
23  namespace common {
24 
32  class IDeviceConfig {
33 
34  public:
35 
45  virtual void ReadConfig() = 0;
46 
54  virtual void GetConfig(fcf::common::VectorVariant& params) = 0;
55 
56 
61  virtual std::string GetIdentifier() = 0;
62 
67  virtual std::string GetPrefix() = 0;
68 
73  virtual std::string GetAddress() = 0;
74 
79  virtual std::string GetSimAddress() = 0;
80 
84  virtual std::string GetType() = 0;
85 
90  virtual int GetNamespace() = 0;
91 
96  virtual std::string GetMapFile() = 0;
97 
102  virtual std::string GetCfgAsString() = 0;
103 
108  virtual std::string GetAlias() = 0;
109 
114  virtual std::string GetName() = 0;
115 
124  virtual std::string GetNodeId(const std::string& attrib) = 0;
125 
136  virtual std::string GetProcId(const std::string& attrib) = 0;
137 
147  virtual std::string GetObjId() = 0;
148 
153  virtual void SetSimulateFlag(bool flag) = 0;
154 
159  virtual void SetIgnoreFlag(bool flag) = 0;
160 
165  virtual bool GetIgnored() = 0;
166 
171  virtual bool GetSimulated() = 0;
172 
173  protected:
174  };
175 
176  }
177  }
178 }
179 
180 
181 #endif //FCF_DEVMGR_COMMON_IDEVICECONFIG_HPP_
fcf::devmgr::common::IDeviceConfig::GetMapFile
virtual std::string GetMapFile()=0
fcf::devmgr::common::IDeviceConfig::GetConfig
virtual void GetConfig(fcf::common::VectorVariant &params)=0
Obtain the list of configuration parameters.
fcf::devmgr::common::IDeviceConfig::GetPrefix
virtual std::string GetPrefix()=0
fcf::devmgr::common::IDeviceConfig::SetSimulateFlag
virtual void SetSimulateFlag(bool flag)=0
Set simulation flag.
fcf::devmgr::common::IDeviceConfig::GetNamespace
virtual int GetNamespace()=0
fcf::devmgr::common::IDeviceConfig::SetIgnoreFlag
virtual void SetIgnoreFlag(bool flag)=0
Set ignore flag.
fcf
Definition: actionMgr.cpp:29
fcf::devmgr::common::IDeviceConfig::GetAddress
virtual std::string GetAddress()=0
configSet.hpp
configSet class header file.
fcf::devmgr::common::IDeviceConfig
Device Configuration class.
Definition: iDeviceConfig.hpp:32
fcf::devmgr::common::IDeviceConfig::GetAlias
virtual std::string GetAlias()=0
fcf::devmgr::common::IDeviceConfig::GetIdentifier
virtual std::string GetIdentifier()=0
fcf::devmgr::common::IDeviceConfig::GetObjId
virtual std::string GetObjId()=0
Get object id.
fcf::devmgr::common::IDeviceConfig::GetType
virtual std::string GetType()=0
fcf::devmgr::common::IDeviceConfig::GetNodeId
virtual std::string GetNodeId(const std::string &attrib)=0
Get node id.
fcf::devmgr::common::IDeviceConfig::GetName
virtual std::string GetName()=0
fcf::devmgr::common::IDeviceConfig::ReadConfig
virtual void ReadConfig()=0
Read the configuration.
fcf::devmgr::common::IDeviceConfig::GetSimAddress
virtual std::string GetSimAddress()=0
fcf::devmgr::common::IDeviceConfig::GetSimulated
virtual bool GetSimulated()=0
GetSimulated.
fcf::devmgr::common::IDeviceConfig::GetProcId
virtual std::string GetProcId(const std::string &attrib)=0
Get procedure id.
fcf::devmgr::common::IDeviceConfig::GetCfgAsString
virtual std::string GetCfgAsString()=0
fcf::devmgr::common::IDeviceConfig::GetIgnored
virtual bool GetIgnored()=0
Get ignored flag.