ifw-fcf  2.0.0
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Types | Public Member Functions | Public Attributes | List of all members
MyDeviceConfig Class Reference
Inheritance diagram for MyDeviceConfig:
fcf::devmgr::common::DeviceConfig fcf::devmgr::common::DeviceConfig fcf::devmgr::common::IDeviceConfig fcf::devmgr::common::IDeviceConfig

Public Types

enum  { CFG_VAL1_MAN = 0, CFG_VAL1_OPT = 1 }
 

Public Member Functions

 MyDeviceConfig (const std::string &filename, const std::string &name)
 
void ReadConfig ()
 Read the configuration. More...
 
void GetConfig (fcf::common::VectorVariant &params)
 Obtain the list of configuration parameters. More...
 
std::string GetMapFile ()
 Get name of the device mapping file. More...
 
 MyDeviceConfig (const std::string filename, const std::string name)
 
void ReadConfig ()
 Read the configuration. More...
 
void GetConfig (fcf::common::VectorVariant &params)
 Obtain the list of configuration parameters. More...
 
std::string GetMapFile ()
 Get name of the device mapping file. More...
 
- Public Member Functions inherited from fcf::devmgr::common::DeviceConfig
 DeviceConfig (const std::string &filename, const std::string &name)
 DeviceConfig constructor. More...
 
virtual ~DeviceConfig ()
 DeviceConfig destructor. More...
 
bool Init ()
 Initialises a device. More...
 
std::string GetIdentifier ()
 
std::string GetPrefix ()
 
std::string GetAddress ()
 
std::string GetSimAddress ()
 
std::string GetFitsPrefix ()
 Get Fits Prefix. More...
 
std::string GetType ()
 
int GetNamespace ()
 
std::string GetAlias ()
 
std::string GetName ()
 
std::string GetNodeId (const std::string &attrib)
 Get node id. More...
 
std::string GetProcId (const std::string &attrib)
 Get procedure id. More...
 
std::string GetObjId ()
 Get object id. More...
 
virtual void GetConfigList (std::vector< std::string > &cfg_list, std::string prefix)
 Get configuration list. More...
 
std::string GetCfgFile ()
 GetCfgFile. More...
 
virtual void SetSimulateFlag (bool flag)
 Set simulation flag. More...
 
virtual void SetIgnoreFlag (bool flag)
 Set ignore flag. More...
 
virtual bool GetIgnored ()
 Get ignored flag. More...
 
virtual bool GetSimulated ()
 Get simulated flag. More...
 

Public Attributes

const std::string cfg_active_low_closed = "low_closed"
 
const std::string cfg_active_low_fault = "low_fault"
 
const std::string cfg_active_low_open = "low_open"
 
const std::string cfg_active_low_switch = "low_switch"
 

Additional Inherited Members

- Protected Attributes inherited from fcf::devmgr::common::DeviceConfig
MapCfgBool m_map_cfg_bool
 
MapCfgShort m_map_cfg_short
 
MapCfgInt m_map_cfg_int
 
MapCfgUInt m_map_cfg_uint
 
MapCfgDouble m_map_cfg_double
 
std::string m_filename
 filename of device configuration file More...
 
std::string m_name
 device identifier More...
 
YAML::Node m_config_node
 YAML node object for configuration file. More...
 
std::string m_identifier
 Address space identifier. More...
 
std::string m_type
 Device type. More...
 
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
 

Member Enumeration Documentation

anonymous enum
Enumerator
CFG_VAL1_MAN 
CFG_VAL1_OPT 

Constructor & Destructor Documentation

MyDeviceConfig::MyDeviceConfig ( const std::string &  filename,
const std::string &  name 
)
inline
MyDeviceConfig::MyDeviceConfig ( const std::string  filename,
const std::string  name 
)
inline

Member Function Documentation

void MyDeviceConfig::GetConfig ( fcf::common::VectorVariant &  params)
inlinevirtual

Obtain the list of configuration parameters.

Parameters
[in,out]paramsoutput vector with the list of config parameters

This methods prepare a vector with all the configuration parameters of a device with the purpose to write it into the controller.

Reimplemented from fcf::devmgr::common::DeviceConfig.

void MyDeviceConfig::GetConfig ( fcf::common::VectorVariant &  params)
inlinevirtual

Obtain the list of configuration parameters.

Parameters
[in,out]paramsoutput vector with the list of config parameters

This methods prepare a vector with all the configuration parameters of a device with the purpose to write it into the controller.

Reimplemented from fcf::devmgr::common::DeviceConfig.

std::string MyDeviceConfig::GetMapFile ( )
inlinevirtual

Get name of the device mapping file.

Returns

Reimplemented from fcf::devmgr::common::DeviceConfig.

std::string MyDeviceConfig::GetMapFile ( )
inlinevirtual

Get name of the device mapping file.

Returns

Reimplemented from fcf::devmgr::common::DeviceConfig.

void MyDeviceConfig::ReadConfig ( )
inlinevirtual

Read the configuration.

This reads the device configuration attributes in memory and check the presence of all attributes that are mandatory.

Exceptions
std::runtime_errorin case of an error

Reimplemented from fcf::devmgr::common::DeviceConfig.

void MyDeviceConfig::ReadConfig ( )
inlinevirtual

Read the configuration.

This reads the device configuration attributes in memory and check the presence of all attributes that are mandatory.

Exceptions
std::runtime_errorin case of an error

Reimplemented from fcf::devmgr::common::DeviceConfig.

Member Data Documentation

const std::string MyDeviceConfig::cfg_active_low_closed = "low_closed"
const std::string MyDeviceConfig::cfg_active_low_fault = "low_fault"
const std::string MyDeviceConfig::cfg_active_low_open = "low_open"
const std::string MyDeviceConfig::cfg_active_low_switch = "low_switch"

The documentation for this class was generated from the following files: