fcf::devmgr::common::IDeviceConfig Class Reference

Device Configuration class. More...

#include <iDeviceConfig.hpp>

Inheritance diagram for fcf::devmgr::common::IDeviceConfig:

Public Member Functions
virtual void	GetConfig (protocol::base::VectorVariant &params) const =0
	Obtain the list of configuration parameters.
virtual std::string	GetIdentifier () const =0
virtual std::string	GetPrefix () const =0
virtual std::string	GetAddress () const =0
virtual std::string	GetSimAddress () const =0
virtual std::string	GetType () const =0
virtual int	GetNamespace () const =0
virtual std::string	GetMapFile () const =0
virtual std::string	GetCfgAsString () const =0
virtual std::string	GetAlias () const =0
virtual std::string	GetName () const =0
virtual std::string	GetNodeId (const std::string &attrib) const =0
	Get node id.
virtual std::string	GetProcId (const std::string &attrib) const =0
	Get procedure id.
virtual std::string	GetObjId () const =0
	Get object id.
virtual void	SetSimulateFlag (const bool flag)=0
	Set simulation flag.
virtual void	SetIgnoreFlag (const bool flag)=0
	Set ignore flag.
virtual bool	GetIgnored () const =0
	Get ignored flag.
virtual bool	GetSimulated () const =0
	GetSimulated.

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

GetAddress()

virtual std::string fcf::devmgr::common::IDeviceConfig::GetAddress ( ) const

pure virtual

Returns

device address

Implemented in fcf::devmgr::common::DeviceConfig.

GetAlias()

virtual std::string fcf::devmgr::common::IDeviceConfig::GetAlias ( ) const

pure virtual

Returns

device alias

Implemented in fcf::devmgr::common::DeviceConfig.

GetCfgAsString()

virtual std::string fcf::devmgr::common::IDeviceConfig::GetCfgAsString ( ) const

pure virtual

Returns

mapping file

Implemented in fcf::devmgr::common::DeviceConfig.

GetConfig()

virtual void fcf::devmgr::common::IDeviceConfig::GetConfig ( protocol::base::VectorVariant &  params ) const

pure virtual

Obtain the list of configuration parameters.

Parameters

[in,out]

params

output 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.

Implemented in fcf::devmgr::common::DeviceConfig, MyDeviceConfig, testDeviceFacade::MyDeviceConfig, MyDeviceConfig, testDeviceLcsIf::MyDeviceConfig, fcf::devmgr::adc::AdcConfig, fcf::devmgr::iodev::IODevConfig, fcf::devmgr::maxis::MAxisConfig, and fcf::devmgr::motor::MotorConfig.

GetIdentifier()

virtual std::string fcf::devmgr::common::IDeviceConfig::GetIdentifier ( ) const

pure virtual

Returns

addres space identifier

Implemented in fcf::devmgr::common::DeviceConfig.

GetIgnored()

virtual bool fcf::devmgr::common::IDeviceConfig::GetIgnored ( ) const

pure virtual

Get ignored flag.

Implemented in fcf::devmgr::common::DeviceConfig.

GetMapFile()

virtual std::string fcf::devmgr::common::IDeviceConfig::GetMapFile ( ) const

pure virtual

Returns

mapping file

Implemented in fcf::devmgr::common::DeviceConfig, MyDeviceConfig, testDrotConfig::MyDeviceConfig, testDrotLcsIf::TestDrotConfig, TestIODev::MyDeviceConfig, testIODevConfig::MyDeviceConfig, testIODevLcsIf::TestIODevConfig, testLampConfig::MyDeviceConfig, testLampLcsIf::TestLampConfig, testMotorConfig::MyDeviceConfig, testMotorLcsIf::TestMotorConfig, testShutterConfig::MyDeviceConfig, and testShutterLcsIf::TestShutterConfig.

GetName()

virtual std::string fcf::devmgr::common::IDeviceConfig::GetName ( ) const

pure virtual

Returns

device name

Implemented in fcf::devmgr::common::DeviceConfig.

GetNamespace()

virtual int fcf::devmgr::common::IDeviceConfig::GetNamespace ( ) const

pure virtual

Returns

namespace

Implemented in fcf::devmgr::common::DeviceConfig.

GetNodeId()

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

pure virtual

Get node id.

Parameters

[in]

attrib

attribute to build the node id

Returns

Node id of the attribute given

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

Implemented in fcf::devmgr::common::DeviceConfig.

GetObjId()

virtual std::string fcf::devmgr::common::IDeviceConfig::GetObjId ( ) const

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 fcf::devmgr::common::DeviceConfig.

GetPrefix()

virtual std::string fcf::devmgr::common::IDeviceConfig::GetPrefix ( ) const

pure virtual

Returns

device prefix

Implemented in fcf::devmgr::common::DeviceConfig.

GetProcId()

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

pure virtual

Get procedure id.

Parameters

[in]

attrib

attribute 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 fcf::devmgr::common::DeviceConfig.

GetSimAddress()

virtual std::string fcf::devmgr::common::IDeviceConfig::GetSimAddress ( ) const

pure virtual

Returns

device simulation address

Implemented in fcf::devmgr::common::DeviceConfig.

GetSimulated()

virtual bool fcf::devmgr::common::IDeviceConfig::GetSimulated ( ) const

pure virtual

GetSimulated.

Implemented in fcf::devmgr::common::DeviceConfig.

GetType()

virtual std::string fcf::devmgr::common::IDeviceConfig::GetType ( ) const

pure virtual

Returns

device type

Implemented in fcf::devmgr::common::DeviceConfig.

SetIgnoreFlag()

virtual void fcf::devmgr::common::IDeviceConfig::SetIgnoreFlag ( const bool  flag )

pure virtual

Set ignore flag.

Implemented in fcf::devmgr::common::DeviceConfig.

SetSimulateFlag()

virtual void fcf::devmgr::common::IDeviceConfig::SetSimulateFlag ( const bool  flag )

pure virtual

Set simulation flag.

Implemented in fcf::devmgr::common::DeviceConfig.

---

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

• devmgr/common/src/include/fcf/devmgr/common/iDeviceConfig.hpp