Motor Configuration class. More...

#include <motorConfig.hpp>

Inheritance diagram for fcf::devmgr::motor::MotorConfig:

Public Types
enum	{ CFG_BRAKE, CFG_BACKLASH, CFG_AXISTYPE, CFG_DEFVEL, CFG_MAXPOS, CFG_MINPOS, CFG_CHECKINPOS, CFG_LOCK, CFG_LOCKPOS, CFG_LOCKTOL, CFG_AUTODISABLE, CFG_INITTOUT, CFG_MOVETOUT, CFG_SWITCHTOUT, CFG_ACTLOWBRAKE, CFG_ACTLOWINPOS, CFG_ACTLOWLSTOP, CFG_ACTLOWLHW, CFG_ACTLOWREF, CFG_ACTLOWINDEX, CFG_ACTLOWUHW, CFG_ACTLOWUSTOP, CFG_EXECPREINIT, CFG_EXECPOSTINIT, CFG_EXECPREMOVE, CFG_EXECPOSTMOVE, END_ENUM_MOTOR }

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

	MotorConfig (const std::string name)
	MotorConfig constructor. More...

virtual	~MotorConfig ()
	MotorConfig destructor. More...

void	InitConfig ()
	Define configuration parameters for motor device. More...

virtual void	ReadConfig ()
	Read the configuration. More...

virtual void	GetConfig (fcf::common::VectorVariant &params)
	Obtain the list of configuration parameters. More...

virtual void	GetConfigList (std::vector< std::string > &cfg_list, std::string prefix)
	Get configuration list. More...

int	GetNumberOfNamedPositions ()

double	GetVelocity ()

void	SetScaleFactor (double scale)
	Set Scale Factor. More...

double	GetScaleFactor () const

const std::string	GetNamedPosition (const int index)
	GetNamedPosition. More...

const double	GetNamedPositionValue (const std::string named_pos)
	GetNamedPositionValue. More...

bool	FindNamedPositionValue (const std::string named_pos, double &position)
	Find value associated to a named position. More...

bool	FindNamedPositionValue (const double position, std::string &name)
	Find value associated to a named position in UU. More...

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

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

void	CheckConfig ()
	Verify Configuration Data. 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...

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

std::string	GetCfgAsString ()
	GetCfgAsString. 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...

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

Protected Attributes
std::unordered_map< int, InitAction >	m_init_sequence_map

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

Friends
class	Sensor

Detailed Description

Motor Configuration class.

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

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

Enumerator
CFG_BRAKE
CFG_BACKLASH
CFG_AXISTYPE
CFG_DEFVEL
CFG_MAXPOS
CFG_MINPOS
CFG_CHECKINPOS
CFG_LOCK
CFG_LOCKPOS
CFG_LOCKTOL
CFG_AUTODISABLE
CFG_INITTOUT
CFG_MOVETOUT
CFG_SWITCHTOUT
CFG_ACTLOWBRAKE
CFG_ACTLOWINPOS
CFG_ACTLOWLSTOP
CFG_ACTLOWLHW
CFG_ACTLOWREF
CFG_ACTLOWINDEX
CFG_ACTLOWUHW
CFG_ACTLOWUSTOP
CFG_EXECPREINIT
CFG_EXECPOSTINIT
CFG_EXECPREMOVE
CFG_EXECPOSTMOVE
END_ENUM_MOTOR

Constructor & Destructor Documentation

◆ MotorConfig() [1/2]

fcf::devmgr::motor::MotorConfig::MotorConfig	(	const std::string	filename,
		const std::string	name
	)

MotorConfig constructor.

Parameters

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

◆ MotorConfig() [2/2]

fcf::devmgr::motor::MotorConfig::MotorConfig ( const std::string name )

MotorConfig constructor.

Parameters

[in] name Device identifier.

◆ ~MotorConfig()

fcf::devmgr::motor::MotorConfig::~MotorConfig ( )

virtual

MotorConfig destructor.

Member Function Documentation

◆ FindNamedPositionValue() [1/2]

bool fcf::devmgr::motor::MotorConfig::FindNamedPositionValue	(	const double	position,
		std::string &	name
	)

Find value associated to a named position in UU.

Parameters

[in]	position	in UU
[in,out]	name	Name as string

Returns: true when position was found in the map, false otherwise.

◆ FindNamedPositionValue() [2/2]

bool fcf::devmgr::motor::MotorConfig::FindNamedPositionValue	(	const std::string	named_pos,
		double &	position
	)

Find value associated to a named position.

Parameters

named_pos	position name
position	position value in UU

Returns: true when position was found in the map, false otherwise.

◆ GetConfig()

void fcf::devmgr::motor::MotorConfig::GetConfig ( fcf::common::VectorVariant & params )

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 motor with the purpose to write it into the controller or just to keep it in memory.

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

Reimplemented in testMotorConfig::MyDeviceConfig, testMotor::MyDeviceConfig, testDrotConfig::MyDeviceConfig, and testDrot::MyDeviceConfig.

◆ GetConfigList()

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

◆ GetNamedPosition()

const std::string fcf::devmgr::motor::MotorConfig::GetNamedPosition ( const int index )

GetNamedPosition.

Parameters

index

Returns

◆ GetNamedPositionValue()

const double fcf::devmgr::motor::MotorConfig::GetNamedPositionValue ( const std::string named_pos )

GetNamedPositionValue.

Parameters

named_pos

Returns

◆ GetNpTolerance()

double fcf::devmgr::motor::MotorConfig::GetNpTolerance ( ) const

Get named position tolerance.

◆ GetNumberOfNamedPositions()

int fcf::devmgr::motor::MotorConfig::GetNumberOfNamedPositions ( )

Returns: Number of named positions

◆ GetScaleFactor()

double fcf::devmgr::motor::MotorConfig::GetScaleFactor ( ) const

Returns: Scale factor

◆ GetVelocity()

double fcf::devmgr::motor::MotorConfig::GetVelocity ( )

Returns: actual velocity

◆ InitConfig()

void fcf::devmgr::motor::MotorConfig::InitConfig ( )

Define configuration parameters for motor device.

◆ ReadConfig()

void fcf::devmgr::motor::MotorConfig::ReadConfig ( )

virtual

Read the configuration.

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

Exceptions

std::runtime_error in case of an error

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

Reimplemented in testMotorConfig::MyDeviceConfig, testMotor::MyDeviceConfig, testDrotConfig::MyDeviceConfig, and testDrot::MyDeviceConfig.

◆ SetScaleFactor()

void fcf::devmgr::motor::MotorConfig::SetScaleFactor ( double scale )

Set Scale Factor.

Parameters

scale

Friends And Related Function Documentation

◆ Sensor

friend class Sensor

friend

Member Data Documentation

◆ m_init_sequence_map

std::unordered_map<int, InitAction> fcf::devmgr::motor::MotorConfig::m_init_sequence_map

protected

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

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

Public Types

Public Member Functions

Protected Attributes

Friends

Detailed Description

Member Enumeration Documentation

◆ anonymous enum

Constructor & Destructor Documentation

◆ MotorConfig() [1/2]

◆ MotorConfig() [2/2]

◆ ~MotorConfig()

Member Function Documentation

◆ FindNamedPositionValue() [1/2]

◆ FindNamedPositionValue() [2/2]

◆ GetConfig()

◆ GetConfigList()

◆ GetNamedPosition()

◆ GetNamedPositionValue()

◆ GetNpTolerance()

◆ GetNumberOfNamedPositions()

◆ GetScaleFactor()

◆ GetVelocity()

◆ InitConfig()

◆ ReadConfig()

◆ SetScaleFactor()

Friends And Related Function Documentation

◆ Sensor

Member Data Documentation

◆ m_init_sequence_map