devmgr::common::DeviceConfig Class Reference

Device Configuration class. More...

#include <deviceConfig.hpp>

Inheritance diagram for devmgr::common::DeviceConfig:

Public Member Functions
	DeviceConfig (const std::string &filename, const std::string &name)
	DeviceConfig constructor. More...
virtual	~DeviceConfig ()
	DeviceConfig destructor. More...
virtual 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...
	DeviceConfig (const std::string &filename, const std::string &name)
	DeviceConfig constructor. More...
virtual	~DeviceConfig ()
	DeviceConfig destructor. More...
virtual 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...
	DeviceConfig (const std::string &filename, const std::string &name)
	DeviceConfig constructor. More...
virtual	~DeviceConfig ()
	DeviceConfig destructor. More...
virtual 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 Member Functions inherited from devmgr::common::IDeviceConfig
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	GetMapFile ()=0
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	GetMapFile ()=0
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	GetMapFile ()=0

Protected Attributes
std::string	m_filename
	filename of device configuration file More...
std::string	m_name
	device identifier More...
YAML::Node	m_configNode
	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

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.

Constructor & Destructor Documentation

devmgr::common::DeviceConfig::DeviceConfig	(	const std::string &	filename,
		const std::string &	name
	)

DeviceConfig constructor.

Parameters

[in]	filename	filename of the device configuration file.
[in]	name	Device identifier.

devmgr::common::DeviceConfig::~DeviceConfig ( )

virtual

DeviceConfig destructor.

devmgr::common::DeviceConfig::DeviceConfig	(	const std::string &	filename,
		const std::string &	name
	)

DeviceConfig constructor.

Parameters

[in]	filename	filename of the device configuration file.
[in]	name	Device identifier.

virtual devmgr::common::DeviceConfig::~DeviceConfig ( )

virtual

DeviceConfig destructor.

devmgr::common::DeviceConfig::DeviceConfig	(	const std::string &	filename,
		const std::string &	name
	)

DeviceConfig constructor.

Parameters

[in]	filename	filename of the device configuration file.
[in]	name	Device identifier.

virtual devmgr::common::DeviceConfig::~DeviceConfig ( )

virtual

DeviceConfig destructor.

Member Function Documentation

string devmgr::common::DeviceConfig::GetAddress ( )

virtual

Returns

device address

Implements devmgr::common::IDeviceConfig.

std::string devmgr::common::DeviceConfig::GetAddress ( )

virtual

Returns

device address

Implements devmgr::common::IDeviceConfig.

std::string devmgr::common::DeviceConfig::GetAddress ( )

virtual

Returns

device address

Implements devmgr::common::IDeviceConfig.

string devmgr::common::DeviceConfig::GetAlias ( )

virtual

Returns

namespace

Implements devmgr::common::IDeviceConfig.

std::string devmgr::common::DeviceConfig::GetAlias ( )

virtual

Returns

namespace

Implements devmgr::common::IDeviceConfig.

std::string devmgr::common::DeviceConfig::GetAlias ( )

virtual

Returns

namespace

Implements devmgr::common::IDeviceConfig.

std::string devmgr::common::DeviceConfig::GetCfgFile

(

)

GetCfgFile.

Returns

std::string devmgr::common::DeviceConfig::GetCfgFile

(

)

GetCfgFile.

Returns

string devmgr::common::DeviceConfig::GetCfgFile

(

)

GetCfgFile.

Returns

virtual void devmgr::common::DeviceConfig::GetConfigList ( std::vector< std::string > &  cfg_list, std::string  prefix  )

virtual

Get configuration list.

Parameters

cfg_list	List of all configuration parameters.
prefix	Prefix to be added to the attributes names.

This method returs the complete of configuration parameters handled by this class. This method is used to dump the list into the DB.

Reimplemented in devmgr::motor::MotorConfig, devmgr::motor::MotorConfig, devmgr::motor::MotorConfig, devmgr::sensor::SensorConfig, devmgr::sensor::SensorConfig, devmgr::sensor::SensorConfig, devmgr::lamp::LampConfig, devmgr::lamp::LampConfig, devmgr::lamp::LampConfig, devmgr::shutter::ShutterConfig, devmgr::shutter::ShutterConfig, and devmgr::shutter::ShutterConfig.

virtual void devmgr::common::DeviceConfig::GetConfigList ( std::vector< std::string > &  cfg_list, std::string  prefix  )

virtual

Get configuration list.

Parameters

cfg_list	List of all configuration parameters.
prefix	Prefix to be added to the attributes names.

This method returs the complete of configuration parameters handled by this class. This method is used to dump the list into the DB.

Reimplemented in devmgr::motor::MotorConfig, devmgr::motor::MotorConfig, devmgr::motor::MotorConfig, devmgr::sensor::SensorConfig, devmgr::sensor::SensorConfig, devmgr::sensor::SensorConfig, devmgr::lamp::LampConfig, devmgr::lamp::LampConfig, devmgr::lamp::LampConfig, devmgr::shutter::ShutterConfig, devmgr::shutter::ShutterConfig, and devmgr::shutter::ShutterConfig.

void devmgr::common::DeviceConfig::GetConfigList ( std::vector< std::string > &  cfg_list, std::string  prefix  )

virtual

Get configuration list.

Parameters

cfg_list	List of all configuration parameters.
prefix	Prefix to be added to the attributes names.

This method returs the complete of configuration parameters handled by this class. This method is used to dump the list into the DB.

Reimplemented in devmgr::motor::MotorConfig, devmgr::motor::MotorConfig, devmgr::motor::MotorConfig, devmgr::sensor::SensorConfig, devmgr::sensor::SensorConfig, devmgr::sensor::SensorConfig, devmgr::lamp::LampConfig, devmgr::lamp::LampConfig, devmgr::lamp::LampConfig, devmgr::shutter::ShutterConfig, devmgr::shutter::ShutterConfig, and devmgr::shutter::ShutterConfig.

std::string devmgr::common::DeviceConfig::GetFitsPrefix

(

)

Get Fits Prefix.

std::string devmgr::common::DeviceConfig::GetFitsPrefix

(

)

Get Fits Prefix.

string devmgr::common::DeviceConfig::GetFitsPrefix

(

)

Get Fits Prefix.

string devmgr::common::DeviceConfig::GetIdentifier ( )

virtual

Returns

addres space identifier

Implements devmgr::common::IDeviceConfig.

std::string devmgr::common::DeviceConfig::GetIdentifier ( )

virtual

Returns

addres space identifier

Implements devmgr::common::IDeviceConfig.

std::string devmgr::common::DeviceConfig::GetIdentifier ( )

virtual

Returns

addres space identifier

Implements devmgr::common::IDeviceConfig.

bool devmgr::common::DeviceConfig::GetIgnored ( )

virtual

Get ignored flag.

Implements devmgr::common::IDeviceConfig.

virtual bool devmgr::common::DeviceConfig::GetIgnored ( )

virtual

Get ignored flag.

Implements devmgr::common::IDeviceConfig.

virtual bool devmgr::common::DeviceConfig::GetIgnored ( )

virtual

Get ignored flag.

Implements devmgr::common::IDeviceConfig.

string devmgr::common::DeviceConfig::GetName ( )

virtual

Returns

device name

Implements devmgr::common::IDeviceConfig.

std::string devmgr::common::DeviceConfig::GetName ( )

virtual

Returns

device name

Implements devmgr::common::IDeviceConfig.

std::string devmgr::common::DeviceConfig::GetName ( )

virtual

Returns

device name

Implements devmgr::common::IDeviceConfig.

int devmgr::common::DeviceConfig::GetNamespace ( )

virtual

Returns

namespace

Implements devmgr::common::IDeviceConfig.

int devmgr::common::DeviceConfig::GetNamespace ( )

virtual

Returns

namespace

Implements devmgr::common::IDeviceConfig.

int devmgr::common::DeviceConfig::GetNamespace ( )

virtual

Returns

namespace

Implements devmgr::common::IDeviceConfig.

std::string devmgr::common::DeviceConfig::GetNodeId ( const std::string &  attrib )

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>

Implements devmgr::common::IDeviceConfig.

std::string devmgr::common::DeviceConfig::GetNodeId ( const std::string &  attrib )

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>

Implements devmgr::common::IDeviceConfig.

std::string devmgr::common::DeviceConfig::GetNodeId ( const std::string &  attrib )

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>

Implements devmgr::common::IDeviceConfig.

std::string devmgr::common::DeviceConfig::GetObjId ( )

virtual

Get object id.

Returns

string with object id

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

<namespace>,<prefix>

Implements devmgr::common::IDeviceConfig.

std::string devmgr::common::DeviceConfig::GetObjId ( )

virtual

Get object id.

Returns

string with object id

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

<namespace>,<prefix>

Implements devmgr::common::IDeviceConfig.

std::string devmgr::common::DeviceConfig::GetObjId ( )

virtual

Get object id.

Returns

string with object id

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

<namespace>,<prefix>

Implements devmgr::common::IDeviceConfig.

std::string devmgr::common::DeviceConfig::GetPrefix ( )

virtual

Returns

device prefix

Implements devmgr::common::IDeviceConfig.

std::string devmgr::common::DeviceConfig::GetPrefix ( )

virtual

Returns

device prefix

Implements devmgr::common::IDeviceConfig.

string devmgr::common::DeviceConfig::GetPrefix ( )

virtual

Returns

device prefix

Implements devmgr::common::IDeviceConfig.

std::string devmgr::common::DeviceConfig::GetProcId ( const std::string &  attrib )

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>

Implements devmgr::common::IDeviceConfig.

std::string devmgr::common::DeviceConfig::GetProcId ( const std::string &  attrib )

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>

Implements devmgr::common::IDeviceConfig.

std::string devmgr::common::DeviceConfig::GetProcId ( const std::string &  attrib )

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>

Implements devmgr::common::IDeviceConfig.

string devmgr::common::DeviceConfig::GetSimAddress ( )

virtual

Returns

device simulation address

Implements devmgr::common::IDeviceConfig.

std::string devmgr::common::DeviceConfig::GetSimAddress ( )

virtual

Returns

device simulation address

Implements devmgr::common::IDeviceConfig.

std::string devmgr::common::DeviceConfig::GetSimAddress ( )

virtual

Returns

device simulation address

Implements devmgr::common::IDeviceConfig.

virtual bool devmgr::common::DeviceConfig::GetSimulated ( )

virtual

Get simulated flag.

Implements devmgr::common::IDeviceConfig.

bool devmgr::common::DeviceConfig::GetSimulated ( )

virtual

Get simulated flag.

Implements devmgr::common::IDeviceConfig.

virtual bool devmgr::common::DeviceConfig::GetSimulated ( )

virtual

Get simulated flag.

Implements devmgr::common::IDeviceConfig.

std::string devmgr::common::DeviceConfig::GetType ( )

virtual

Returns

device type

Implements devmgr::common::IDeviceConfig.

string devmgr::common::DeviceConfig::GetType ( )

virtual

Returns

device type

Implements devmgr::common::IDeviceConfig.

std::string devmgr::common::DeviceConfig::GetType ( )

virtual

Returns

device type

Implements devmgr::common::IDeviceConfig.

bool devmgr::common::DeviceConfig::Init ( )

virtual

Initialises a device.

Returns

true if initialisation finished without error, false otherwise.

Implements devmgr::common::IDeviceConfig.

virtual bool devmgr::common::DeviceConfig::Init ( )

virtual

Initialises a device.

Returns

true if initialisation finished without error, false otherwise.

Implements devmgr::common::IDeviceConfig.

virtual bool devmgr::common::DeviceConfig::Init ( )

virtual

Initialises a device.

Returns

true if initialisation finished without error, false otherwise.

Implements devmgr::common::IDeviceConfig.

void devmgr::common::DeviceConfig::SetIgnoreFlag ( bool  flag )

virtual

Set ignore flag.

Implements devmgr::common::IDeviceConfig.

virtual void devmgr::common::DeviceConfig::SetIgnoreFlag ( bool  flag )

virtual

Set ignore flag.

Implements devmgr::common::IDeviceConfig.

virtual void devmgr::common::DeviceConfig::SetIgnoreFlag ( bool  flag )

virtual

Set ignore flag.

Implements devmgr::common::IDeviceConfig.

virtual void devmgr::common::DeviceConfig::SetSimulateFlag ( bool  flag )

virtual

Set simulation flag.

Implements devmgr::common::IDeviceConfig.

virtual void devmgr::common::DeviceConfig::SetSimulateFlag ( bool  flag )

virtual

Set simulation flag.

Implements devmgr::common::IDeviceConfig.

void devmgr::common::DeviceConfig::SetSimulateFlag ( bool  flag )

virtual

Set simulation flag.

Implements devmgr::common::IDeviceConfig.

Member Data Documentation

std::string devmgr::common::DeviceConfig::m_address

protected

std::string devmgr::common::DeviceConfig::m_alias

protected

YAML::Node devmgr::common::DeviceConfig::m_configNode

protected

YAML node object for configuration file.

std::string devmgr::common::DeviceConfig::m_filename

protected

filename of device configuration file

std::string devmgr::common::DeviceConfig::m_fits_prefix

protected

std::string devmgr::common::DeviceConfig::m_identifier

protected

Address space identifier.

bool devmgr::common::DeviceConfig::m_ignored

protected

int devmgr::common::DeviceConfig::m_lcs_namespace

protected

std::string devmgr::common::DeviceConfig::m_lcs_prefix

protected

std::string devmgr::common::DeviceConfig::m_map_file

protected

std::string devmgr::common::DeviceConfig::m_name

protected

device identifier

std::string devmgr::common::DeviceConfig::m_sim_address

protected

bool devmgr::common::DeviceConfig::m_simulated

protected

std::string devmgr::common::DeviceConfig::m_type

protected

Device type.

---

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

• fcf/devmgr/common/src/include/devmgr/common/deviceConfig.hpp
• INTROOT/include/devmgr/common/deviceConfig.hpp
• INTROOT/sources/fcf/devmgr/common/src/include/devmgr/common/deviceConfig.hpp
• fcf/devmgr/common/src/deviceConfig.cpp
• INTROOT/sources/fcf/devmgr/common/src/deviceConfig.cpp