ifw  0.0.1-dev
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | List of all members
devmgr::common::IDeviceConfig Class Referenceabstract

Device Configuration class. More...

#include <iDeviceConfig.hpp>

Inheritance diagram for devmgr::common::IDeviceConfig:
devmgr::common::DeviceConfig devmgr::common::DeviceConfig devmgr::common::DeviceConfig MockIDeviceConfig devmgr::lamp::LampConfig devmgr::lamp::LampConfig devmgr::lamp::LampConfig devmgr::motor::MotorConfig devmgr::motor::MotorConfig devmgr::motor::MotorConfig devmgr::sensor::SensorConfig devmgr::sensor::SensorConfig devmgr::sensor::SensorConfig devmgr::shutter::ShutterConfig devmgr::shutter::ShutterConfig devmgr::shutter::ShutterConfig MyDeviceConfig MyDeviceConfig testDeviceFacade::MyDeviceConfig testDeviceLcsIf::MyDeviceConfig devmgr::lamp::LampConfig devmgr::lamp::LampConfig devmgr::lamp::LampConfig devmgr::motor::MotorConfig devmgr::motor::MotorConfig devmgr::motor::MotorConfig devmgr::sensor::SensorConfig devmgr::sensor::SensorConfig devmgr::sensor::SensorConfig devmgr::shutter::ShutterConfig devmgr::shutter::ShutterConfig devmgr::shutter::ShutterConfig MyDeviceConfig MyDeviceConfig testDeviceFacade::MyDeviceConfig testDeviceLcsIf::MyDeviceConfig devmgr::lamp::LampConfig devmgr::lamp::LampConfig devmgr::lamp::LampConfig devmgr::motor::MotorConfig devmgr::motor::MotorConfig devmgr::motor::MotorConfig devmgr::sensor::SensorConfig devmgr::sensor::SensorConfig devmgr::sensor::SensorConfig devmgr::shutter::ShutterConfig devmgr::shutter::ShutterConfig devmgr::shutter::ShutterConfig MyDeviceConfig MyDeviceConfig testDeviceFacade::MyDeviceConfig testDeviceLcsIf::MyDeviceConfig

Public Member Functions

virtual bool Init ()=0
 Initialises a device. More...
 
virtual void ReadConfig ()=0
 Read the configuration. More...
 
virtual void GetConfig (fcf::common::VectorVariant &params)=0
 Obtain the list of configuration parameters. More...
 
virtual std::string GetIdentifier ()=0
 
virtual std::string GetPrefix ()=0
 
virtual std::string GetAddress ()=0
 
virtual std::string GetSimAddress ()=0
 
virtual std::string GetType ()=0
 
virtual int GetNamespace ()=0
 
virtual std::string GetMapFile ()=0
 
virtual std::string GetAlias ()=0
 
virtual std::string GetName ()=0
 
virtual std::string GetNodeId (const std::string &attrib)=0
 Get node id. More...
 
virtual std::string GetProcId (const std::string &attrib)=0
 Get procedure id. More...
 
virtual std::string GetObjId ()=0
 Get object id. More...
 
virtual void SetSimulateFlag (bool flag)=0
 Set simulation flag. More...
 
virtual void SetIgnoreFlag (bool flag)=0
 Set ignore flag. More...
 
virtual bool GetIgnored ()=0
 Get ignored flag. More...
 
virtual bool GetSimulated ()=0
 GetSimulated. More...
 
virtual bool Init ()=0
 Initialises a device. More...
 
virtual void ReadConfig ()=0
 Read the configuration. More...
 
virtual void GetConfig (fcf::common::VectorVariant &params)=0
 Obtain the list of configuration parameters. More...
 
virtual std::string GetIdentifier ()=0
 
virtual std::string GetPrefix ()=0
 
virtual std::string GetAddress ()=0
 
virtual std::string GetSimAddress ()=0
 
virtual std::string GetType ()=0
 
virtual int GetNamespace ()=0
 
virtual std::string GetMapFile ()=0
 
virtual std::string GetAlias ()=0
 
virtual std::string GetName ()=0
 
virtual std::string GetNodeId (const std::string &attrib)=0
 Get node id. More...
 
virtual std::string GetProcId (const std::string &attrib)=0
 Get procedure id. More...
 
virtual std::string GetObjId ()=0
 Get object id. More...
 
virtual void SetSimulateFlag (bool flag)=0
 Set simulation flag. More...
 
virtual void SetIgnoreFlag (bool flag)=0
 Set ignore flag. More...
 
virtual bool GetIgnored ()=0
 Get ignored flag. More...
 
virtual bool GetSimulated ()=0
 GetSimulated. More...
 
virtual bool Init ()=0
 Initialises a device. More...
 
virtual void ReadConfig ()=0
 Read the configuration. More...
 
virtual void GetConfig (fcf::common::VectorVariant &params)=0
 Obtain the list of configuration parameters. More...
 
virtual std::string GetIdentifier ()=0
 
virtual std::string GetPrefix ()=0
 
virtual std::string GetAddress ()=0
 
virtual std::string GetSimAddress ()=0
 
virtual std::string GetType ()=0
 
virtual int GetNamespace ()=0
 
virtual std::string GetMapFile ()=0
 
virtual std::string GetAlias ()=0
 
virtual std::string GetName ()=0
 
virtual std::string GetNodeId (const std::string &attrib)=0
 Get node id. More...
 
virtual std::string GetProcId (const std::string &attrib)=0
 Get procedure id. More...
 
virtual std::string GetObjId ()=0
 Get object id. More...
 
virtual void SetSimulateFlag (bool flag)=0
 Set simulation flag. More...
 
virtual void SetIgnoreFlag (bool flag)=0
 Set ignore flag. More...
 
virtual bool GetIgnored ()=0
 Get ignored flag. More...
 
virtual bool GetSimulated ()=0
 GetSimulated. More...
 

Detailed Description

Device Configuration class.

This class manages the configuration of a device. It reads the configuration file and provides the methods to obtain the parameters used by the various classes.

Member Function Documentation

virtual std::string devmgr::common::IDeviceConfig::GetAddress ( )
pure virtual
virtual std::string devmgr::common::IDeviceConfig::GetAddress ( )
pure virtual
virtual std::string devmgr::common::IDeviceConfig::GetAddress ( )
pure virtual
virtual std::string devmgr::common::IDeviceConfig::GetAlias ( )
pure virtual
virtual std::string devmgr::common::IDeviceConfig::GetAlias ( )
pure virtual
virtual std::string devmgr::common::IDeviceConfig::GetAlias ( )
pure virtual
virtual void devmgr::common::IDeviceConfig::GetConfig ( fcf::common::VectorVariant &  params)
pure virtual
virtual void devmgr::common::IDeviceConfig::GetConfig ( fcf::common::VectorVariant &  params)
pure virtual
virtual void devmgr::common::IDeviceConfig::GetConfig ( fcf::common::VectorVariant &  params)
pure virtual
virtual std::string devmgr::common::IDeviceConfig::GetIdentifier ( )
pure virtual
Returns
addres space identifier

Implemented in devmgr::common::DeviceConfig, devmgr::common::DeviceConfig, and devmgr::common::DeviceConfig.

virtual std::string devmgr::common::IDeviceConfig::GetIdentifier ( )
pure virtual
Returns
addres space identifier

Implemented in devmgr::common::DeviceConfig, devmgr::common::DeviceConfig, and devmgr::common::DeviceConfig.

virtual std::string devmgr::common::IDeviceConfig::GetIdentifier ( )
pure virtual
Returns
addres space identifier

Implemented in devmgr::common::DeviceConfig, devmgr::common::DeviceConfig, and devmgr::common::DeviceConfig.

virtual bool devmgr::common::IDeviceConfig::GetIgnored ( )
pure virtual
virtual bool devmgr::common::IDeviceConfig::GetIgnored ( )
pure virtual
virtual bool devmgr::common::IDeviceConfig::GetIgnored ( )
pure virtual
virtual std::string devmgr::common::IDeviceConfig::GetMapFile ( )
pure virtual
virtual std::string devmgr::common::IDeviceConfig::GetMapFile ( )
pure virtual
virtual std::string devmgr::common::IDeviceConfig::GetMapFile ( )
pure virtual
virtual std::string devmgr::common::IDeviceConfig::GetName ( )
pure virtual
virtual std::string devmgr::common::IDeviceConfig::GetName ( )
pure virtual
virtual std::string devmgr::common::IDeviceConfig::GetName ( )
pure virtual
virtual int devmgr::common::IDeviceConfig::GetNamespace ( )
pure virtual
virtual int devmgr::common::IDeviceConfig::GetNamespace ( )
pure virtual
virtual int devmgr::common::IDeviceConfig::GetNamespace ( )
pure virtual
virtual std::string devmgr::common::IDeviceConfig::GetNodeId ( const std::string &  attrib)
pure virtual

Get node id.

Parameters
[in]attribattribute to build the node id
Returns
Node id of the attribute given

The NodeId is composed by the following: <namespace>,<prefix>.<attribute>

Implemented in devmgr::common::DeviceConfig, devmgr::common::DeviceConfig, and devmgr::common::DeviceConfig.

virtual std::string devmgr::common::IDeviceConfig::GetNodeId ( const std::string &  attrib)
pure virtual

Get node id.

Parameters
[in]attribattribute to build the node id
Returns
Node id of the attribute given

The NodeId is composed by the following: <namespace>,<prefix>.<attribute>

Implemented in devmgr::common::DeviceConfig, devmgr::common::DeviceConfig, and devmgr::common::DeviceConfig.

virtual std::string devmgr::common::IDeviceConfig::GetNodeId ( const std::string &  attrib)
pure virtual

Get node id.

Parameters
[in]attribattribute to build the node id
Returns
Node id of the attribute given

The NodeId is composed by the following: <namespace>,<prefix>.<attribute>

Implemented in devmgr::common::DeviceConfig, devmgr::common::DeviceConfig, and devmgr::common::DeviceConfig.

virtual std::string devmgr::common::IDeviceConfig::GetObjId ( )
pure virtual

Get object id.

Returns
string with object id

This method returns the address space prefix for executing RPC calls.

<namespace>,<prefix>

Implemented in devmgr::common::DeviceConfig, devmgr::common::DeviceConfig, and devmgr::common::DeviceConfig.

virtual std::string devmgr::common::IDeviceConfig::GetObjId ( )
pure virtual

Get object id.

Returns
string with object id

This method returns the address space prefix for executing RPC calls.

<namespace>,<prefix>

Implemented in devmgr::common::DeviceConfig, devmgr::common::DeviceConfig, and devmgr::common::DeviceConfig.

virtual std::string devmgr::common::IDeviceConfig::GetObjId ( )
pure virtual

Get object id.

Returns
string with object id

This method returns the address space prefix for executing RPC calls.

<namespace>,<prefix>

Implemented in devmgr::common::DeviceConfig, devmgr::common::DeviceConfig, and devmgr::common::DeviceConfig.

virtual std::string devmgr::common::IDeviceConfig::GetPrefix ( )
pure virtual
virtual std::string devmgr::common::IDeviceConfig::GetPrefix ( )
pure virtual
virtual std::string devmgr::common::IDeviceConfig::GetPrefix ( )
pure virtual
virtual std::string devmgr::common::IDeviceConfig::GetProcId ( const std::string &  attrib)
pure virtual

Get procedure id.

Parameters
[in]attribattribute to build the node id
Returns
string with procedure id

The procedure id is the NodeId for RPC calls and it is composed by the following:

<namespace>,<prefix>#<attribute>

Implemented in devmgr::common::DeviceConfig, devmgr::common::DeviceConfig, and devmgr::common::DeviceConfig.

virtual std::string devmgr::common::IDeviceConfig::GetProcId ( const std::string &  attrib)
pure virtual

Get procedure id.

Parameters
[in]attribattribute to build the node id
Returns
string with procedure id

The procedure id is the NodeId for RPC calls and it is composed by the following:

<namespace>,<prefix>#<attribute>

Implemented in devmgr::common::DeviceConfig, devmgr::common::DeviceConfig, and devmgr::common::DeviceConfig.

virtual std::string devmgr::common::IDeviceConfig::GetProcId ( const std::string &  attrib)
pure virtual

Get procedure id.

Parameters
[in]attribattribute to build the node id
Returns
string with procedure id

The procedure id is the NodeId for RPC calls and it is composed by the following:

<namespace>,<prefix>#<attribute>

Implemented in devmgr::common::DeviceConfig, devmgr::common::DeviceConfig, and devmgr::common::DeviceConfig.

virtual std::string devmgr::common::IDeviceConfig::GetSimAddress ( )
pure virtual
Returns
device simulation address

Implemented in devmgr::common::DeviceConfig, devmgr::common::DeviceConfig, and devmgr::common::DeviceConfig.

virtual std::string devmgr::common::IDeviceConfig::GetSimAddress ( )
pure virtual
Returns
device simulation address

Implemented in devmgr::common::DeviceConfig, devmgr::common::DeviceConfig, and devmgr::common::DeviceConfig.

virtual std::string devmgr::common::IDeviceConfig::GetSimAddress ( )
pure virtual
Returns
device simulation address

Implemented in devmgr::common::DeviceConfig, devmgr::common::DeviceConfig, and devmgr::common::DeviceConfig.

virtual bool devmgr::common::IDeviceConfig::GetSimulated ( )
pure virtual
virtual bool devmgr::common::IDeviceConfig::GetSimulated ( )
pure virtual
virtual bool devmgr::common::IDeviceConfig::GetSimulated ( )
pure virtual
virtual std::string devmgr::common::IDeviceConfig::GetType ( )
pure virtual
virtual std::string devmgr::common::IDeviceConfig::GetType ( )
pure virtual
virtual std::string devmgr::common::IDeviceConfig::GetType ( )
pure virtual
virtual bool devmgr::common::IDeviceConfig::Init ( )
pure virtual

Initialises a device.

Returns
true if initialisation finished without error, false otherwise.

Implemented in devmgr::common::DeviceConfig, devmgr::common::DeviceConfig, and devmgr::common::DeviceConfig.

virtual bool devmgr::common::IDeviceConfig::Init ( )
pure virtual

Initialises a device.

Returns
true if initialisation finished without error, false otherwise.

Implemented in devmgr::common::DeviceConfig, devmgr::common::DeviceConfig, and devmgr::common::DeviceConfig.

virtual bool devmgr::common::IDeviceConfig::Init ( )
pure virtual

Initialises a device.

Returns
true if initialisation finished without error, false otherwise.

Implemented in devmgr::common::DeviceConfig, devmgr::common::DeviceConfig, and devmgr::common::DeviceConfig.

virtual void devmgr::common::IDeviceConfig::ReadConfig ( )
pure virtual
virtual void devmgr::common::IDeviceConfig::ReadConfig ( )
pure virtual
virtual void devmgr::common::IDeviceConfig::ReadConfig ( )
pure virtual
virtual void devmgr::common::IDeviceConfig::SetIgnoreFlag ( bool  flag)
pure virtual
virtual void devmgr::common::IDeviceConfig::SetIgnoreFlag ( bool  flag)
pure virtual
virtual void devmgr::common::IDeviceConfig::SetIgnoreFlag ( bool  flag)
pure virtual
virtual void devmgr::common::IDeviceConfig::SetSimulateFlag ( bool  flag)
pure virtual
virtual void devmgr::common::IDeviceConfig::SetSimulateFlag ( bool  flag)
pure virtual
virtual void devmgr::common::IDeviceConfig::SetSimulateFlag ( bool  flag)
pure virtual

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