adc Configuration class More...

#include <adcConfig.hpp>

Inheritance diagram for fcf::devmgr::adc::AdcConfig:

Public Member Functions
	AdcConfig (const std::string filename, const std::string name)
	DeviceConfig constructor. More...

	AdcConfig (const std::string name)
	DeviceConfig constructor. More...

virtual	~AdcConfig ()=default
	DeviceConfig destructor. More...

void	Init ()
	Define configuration parameters for adc device. More...

virtual void	GetConfig (protocol::base::VectorVariant &params) const override
	Obtain the list of configuration parameters. More...

virtual void	GetMotorConfig (protocol::base::VectorVariant &params) const
	Obtain the list of ADC motor configuration parameters. More...

virtual void	GetMotorConfig (const std::string motor, protocol::base::VectorVariant &params) const

virtual void	SetScaleFactor (const std::string motor, double scale_factor)

double	GetNpTolerance () const
	Get named position tolerance. More...

virtual void	GetConfigList (utils::bat::DbVector &cfg_list, std::string prefix) const override
	Get configuration list. More...

virtual std::string	GetMotorMapFile () const

virtual std::string	GetMotorType () const

std::string	GetMotorPrefix (const int &index) const

std::string	GetMotorPrefix (const std::string &motor) const

std::string	GetMotorName (const int &index) const

void	GetMotorNames (std::vector< std::string > &motor_names) const

void	GetMotorPrefixes (std::vector< std::string > &motor_prefixes) const

double	GetMotorVelocity (const int axis_num) const

double	GetMotorScaleFactor (const int axis_num) const

double	GetMotorScaleFactor (const std::string motor_name) const

std::string	GetMotorName (const std::string nodeid) const

Public Member Functions inherited from fcf::devmgr::common::DeviceConfig
	DeviceConfig (const std::string &filename, const std::string &name)
	DeviceConfig constructor. More...

	DeviceConfig (const std::string &name)
	DeviceConfig constructor. More...

virtual	~DeviceConfig ()
	DeviceConfig destructor. More...

bool	Init ()
	Initialises a device. More...

void	InitFromString (std::string config)
	Init the internal configuration from a string. More...

void	InitFromFile (const std::string &filename)
	Init the internal configuration from a given file. More...

std::string	GetIdentifier () const

std::string	GetPrefix () const

std::string	GetAddress () const

std::string	GetSimAddress () const

std::string	GetFitsPrefix () const
	Get Fits Prefix. More...

std::string	GetType () const

int	GetNamespace () const

std::string	GetAlias () const

std::string	GetId () const

std::string	GetOverview () const

std::string	GetDescription () const

std::string	GetName () const noexcept

std::string	GetLogName () const noexcept

std::string	GetNodeId (const std::string &attrib) const
	Get node id. More...

std::string	GetProcId (const std::string &attrib) const
	Get procedure id. More...

std::string	GetObjId () const
	Get object id. More...

std::string	GetCfgFile () const
	GetCfgFile. More...

std::string	GetCfgAsString () const
	GetCfgAsString. More...

virtual void	SetSimulateFlag (const bool flag)
	Set simulation flag. More...

virtual void	SetIgnoreFlag (const bool flag)
	Set ignore flag. More...

virtual bool	GetIgnored () const
	Get ignored flag. More...

virtual bool	GetSimulated () const
	Get simulated flag. More...

virtual std::string	GetMapFile () const
	Get name of the device mapping file. More...

void	CheckConfig () const
	Validates the document configuration. More...

Protected Attributes
int	m_num_axis

std::map< std::string, std::unique_ptr< fcf::devmgr::motor::MotorConfig > >	m_motor_config_map
	Maps of ADC axes configuration. More...

std::map< std::string, std::string >	m_motor_prefix_map

Protected Attributes inherited from fcf::devmgr::common::DeviceConfig
std::string	m_filename
	filename of device configuration file More...

std::string	m_name
	device identifier 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

std::unique_ptr< elt::configng::CiiConfigDocument >	m_config_doc
	Internal configuration document object. More...

Additional Inherited Members
Protected Member Functions inherited from fcf::devmgr::common::DeviceConfig
void	MergeConfig (const elt::configng::CiiConfigDocument &doc, bool check=true)
	Merges a configuration file. More...

bool	GetVariantValue (const elt::configng::CiiConfigInstanceNode node, protocol::base::Variant &value) const
	Obtain the variant value with the correct type. More...

Detailed Description

adc Configuration class

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

Constructor & Destructor Documentation

◆ AdcConfig() [1/2]

fcf::devmgr::adc::AdcConfig::AdcConfig	(	const std::string	filename,
		const std::string	name
	)

DeviceConfig constructor.

Parameters

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

◆ AdcConfig() [2/2]

fcf::devmgr::adc::AdcConfig::AdcConfig ( const std::string name )

DeviceConfig constructor.

Parameters

[in] name Device identifier.

◆ ~AdcConfig()

virtual fcf::devmgr::adc::AdcConfig::~AdcConfig ( )

virtualdefault

DeviceConfig destructor.

Member Function Documentation

◆ GetConfig()

void fcf::devmgr::adc::AdcConfig::GetConfig ( protocol::base::VectorVariant & params ) const

overridevirtual

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 adc with the purpose to write it into the controller.

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

◆ GetConfigList()

void fcf::devmgr::adc::AdcConfig::GetConfigList	(	utils::bat::DbVector &	cfg_list,
		std::string	prefix
	)		const

overridevirtual

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

◆ GetMotorConfig() [1/2]

void fcf::devmgr::adc::AdcConfig::GetMotorConfig	(	const std::string	motor,
		protocol::base::VectorVariant &	params
	)		const

virtual

◆ GetMotorConfig() [2/2]

void fcf::devmgr::adc::AdcConfig::GetMotorConfig ( protocol::base::VectorVariant & params ) const

virtual

Obtain the list of ADC motor configuration parameters.

Parameters

[in,out] params output vector with the list of ADC motor config parameters

This methods prepare a vector with all ADC motor configuration parameters. These parameters have to be handled separately from the ADC normal configuration because they use a different mapping file.

◆ GetMotorMapFile()

string fcf::devmgr::adc::AdcConfig::GetMotorMapFile ( ) const

virtual

Returns: mapping file

◆ GetMotorName() [1/2]

std::string fcf::devmgr::adc::AdcConfig::GetMotorName ( const int & index ) const

◆ GetMotorName() [2/2]

std::string fcf::devmgr::adc::AdcConfig::GetMotorName ( const std::string nodeid ) const

◆ GetMotorNames()

void fcf::devmgr::adc::AdcConfig::GetMotorNames ( std::vector< std::string > & motor_names ) const

◆ GetMotorPrefix() [1/2]

std::string fcf::devmgr::adc::AdcConfig::GetMotorPrefix ( const int & index ) const

Returns: ADC motor prefix

◆ GetMotorPrefix() [2/2]

std::string fcf::devmgr::adc::AdcConfig::GetMotorPrefix ( const std::string & motor ) const

◆ GetMotorPrefixes()

void fcf::devmgr::adc::AdcConfig::GetMotorPrefixes ( std::vector< std::string > & motor_prefixes ) const

◆ GetMotorScaleFactor() [1/2]

double fcf::devmgr::adc::AdcConfig::GetMotorScaleFactor ( const int axis_num ) const

◆ GetMotorScaleFactor() [2/2]

double fcf::devmgr::adc::AdcConfig::GetMotorScaleFactor ( const std::string motor_name ) const

◆ GetMotorType()

string fcf::devmgr::adc::AdcConfig::GetMotorType ( ) const

virtual

Returns: ADC motor type

◆ GetMotorVelocity()

double fcf::devmgr::adc::AdcConfig::GetMotorVelocity ( const int axis_num ) const

◆ GetNpTolerance()

double fcf::devmgr::adc::AdcConfig::GetNpTolerance ( ) const

Get named position tolerance.

◆ Init()

void fcf::devmgr::adc::AdcConfig::Init ( )

Define configuration parameters for adc device.

◆ SetScaleFactor()

void fcf::devmgr::adc::AdcConfig::SetScaleFactor	(	const std::string	motor,
		double	scale_factor
	)

virtual

Member Data Documentation

◆ m_motor_config_map

std::map<std::string, std::unique_ptr<fcf::devmgr::motor::MotorConfig> > fcf::devmgr::adc::AdcConfig::m_motor_config_map

protected

Maps of ADC axes configuration.

◆ m_motor_prefix_map

std::map<std::string, std::string> fcf::devmgr::adc::AdcConfig::m_motor_prefix_map

protected

Map between motor prefix and motor name This is needed to map the correct motor name when receiving OPCUA events.

◆ m_num_axis

int fcf::devmgr::adc::AdcConfig::m_num_axis

protected

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

devmgr/devices/src/include/fcf/devmgr/devices/adcConfig.hpp
devmgr/devices/src/adcConfig.cpp

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ AdcConfig() [1/2]

◆ AdcConfig() [2/2]

◆ ~AdcConfig()

Member Function Documentation

◆ GetConfig()

◆ GetConfigList()

◆ GetMotorConfig() [1/2]

◆ GetMotorConfig() [2/2]

◆ GetMotorMapFile()

◆ GetMotorName() [1/2]

◆ GetMotorName() [2/2]

◆ GetMotorNames()

◆ GetMotorPrefix() [1/2]

◆ GetMotorPrefix() [2/2]

◆ GetMotorPrefixes()

◆ GetMotorScaleFactor() [1/2]

◆ GetMotorScaleFactor() [2/2]

◆ GetMotorType()

◆ GetMotorVelocity()

◆ GetNpTolerance()

◆ Init()

◆ SetScaleFactor()

Member Data Documentation

◆ m_motor_config_map

◆ m_motor_prefix_map

◆ m_num_axis