testMotorConfig::MyDeviceConfig Class Reference

Test MotorConfig class used for testing purposes. More...

Inheritance diagram for testMotorConfig::MyDeviceConfig:

Public Member Functions
	MyDeviceConfig (const std::string &filename, const std::string &name)
void	Init ()
	Read the configuration.
void	GetConfig (protocol::base::VectorVariant &params)
void	SetMapFile (const std::string &filename)
virtual std::string	GetMapFile () const
	Get name of the device mapping file.
Public Member Functions inherited from fcf::devmgr::motor::MotorConfig
	MotorConfig (const std::string filename, const std::string name)
	MotorConfig constructor.
	MotorConfig (const std::string name)
	MotorConfig constructor.
virtual	~MotorConfig ()=default
	MotorConfig destructor.
virtual void	Init ()
	Read the configuration.
virtual void	GetConfig (protocol::base::VectorVariant &params) const override
	Obtain the list of configuration parameters.
virtual void	GetConfigList (utils::bat::DbVector &cfg_list, std::string prefix) const override
	Get configuration list.
int	GetNumberOfInitSteps () const noexcept
	Get number of initialisations steps.
double	GetScaleFactor () const override
void	SetScaleFactor (double scale)
	Set Scale Factor.
Public Member Functions inherited from fcf::devmgr::motor::MotorBaseConfig
	MotorBaseConfig (const std::string filename, const std::string name)
	MotorConfig constructor.
	MotorBaseConfig (const std::string name)
	MotorConfig constructor.
virtual	~MotorBaseConfig ()=default
	MotorConfig destructor.
virtual void	Init ()
	Read the configuration.
virtual void	GetConfigList (utils::bat::DbVector &cfg_list, std::string prefix) const override
	Get configuration list.
int	GetNumberOfNamedPositions () const noexcept
double	GetVelocity () const
virtual double	GetScaleFactor () const
std::string	GetNamedPosition (const int index) const
	GetNamedPosition.
double	GetNamedPositionValue (const int index) const
	GetNamedPositionValue.
bool	FindNamedPositionValue (const std::string named_pos, double &position) const
	Find value associated to a named position.
bool	FindNamedPositionValue (const double position, std::string &name) const
	Find value associated to a named position in UU.
double	GetNpTolerance () const
	Get named position tolerance.
Public Member Functions inherited from fcf::devmgr::common::DeviceConfig
	DeviceConfig (const std::string &filename, const std::string &name)
	DeviceConfig constructor.
	DeviceConfig (const std::string &name)
	DeviceConfig constructor.
virtual	~DeviceConfig ()
	DeviceConfig destructor.
bool	Init ()
	Initialises a device.
void	InitFromString (std::string config)
	Init the internal configuration from a string.
void	InitFromFile (const std::string &filename)
	Init the internal configuration from a given file.
virtual void	GetConfig (protocol::base::VectorVariant &params) const
	Obtain the list of configuration parameters.
std::string	GetIdentifier () const
std::string	GetPrefix () const
std::string	GetAddress () const
std::string	GetSimAddress () const
std::string	GetFitsPrefix () const
	Get Fits Prefix.
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	GetNodeIdByType (const std::string &attrib, const NodeIdType type=ATTRIB_NODE_ID) const
	Get node id.
std::string	GetNodeId (const std::string &attrib) const
	Get node id.
std::string	GetProcId (const std::string &attrib) const
	Get procedure id.
std::string	GetObjId () const
	Get object id.
virtual void	GetConfigList (utils::bat::DbVector &cfg_list, std::string prefix) const
	Get configuration list.
std::string	GetCfgFile () const
	GetCfgFile.
std::string	GetCfgAsString () const
	GetCfgAsString.
virtual void	SetSimulateFlag (const bool flag)
	Set simulation flag.
virtual void	SetIgnoreFlag (const bool flag)
	Set ignore flag.
virtual bool	GetIgnored () const
	Get ignored flag.
virtual bool	GetSimulated () const
	Get simulated flag.
virtual std::string	GetMapFile () const
	Get name of the device mapping file.
void	CheckConfig () const
	Validates the document configuration.
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.

Public Attributes
std::string	m_map_file

Additional Inherited Members
Public Types inherited from fcf::devmgr::common::DeviceConfig
enum	NodeIdType { ATTRIB_NODE_ID , RPC_NODE_ID , OBJ_NODE_ID }
Protected Member Functions inherited from fcf::devmgr::common::DeviceConfig
void	MergeConfig (const elt::configng::CiiConfigDocument &doc, bool check=true)
	Merges a configuration file.
bool	GetVariantValue (const elt::configng::CiiConfigInstanceNode node, protocol::base::Variant &value) const
	Obtain the variant value with the correct type.
bool	IsValidNodeIDFormat (const std::string &nodeIdString) const
	IsValidNodeIDFormat.
Protected Attributes inherited from fcf::devmgr::motor::MotorConfig
std::vector< InitAction >	m_init_sequence
double	m_scale_factor {1.0}
Protected Attributes inherited from fcf::devmgr::motor::MotorBaseConfig
std::unordered_map< std::string, double >	m_named_positions
int	m_num_named_pos {0}
	Number of named positions.
Protected Attributes inherited from fcf::devmgr::common::DeviceConfig
std::string	m_filename
	filename of device configuration file
std::string	m_name
	device identifier
std::string	m_identifier
	Address space identifier.
std::string	m_type
	Device type.
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.

Detailed Description

Test MotorConfig class used for testing purposes.

Constructor & Destructor Documentation

MyDeviceConfig()

testMotorConfig::MyDeviceConfig::MyDeviceConfig ( const std::string &  filename, const std::string &  name  )

inline

Member Function Documentation

GetConfig()

void testMotorConfig::MyDeviceConfig::GetConfig ( protocol::base::VectorVariant &  params )

inline

GetMapFile()

virtual std::string testMotorConfig::MyDeviceConfig::GetMapFile ( ) const

inlinevirtual

Get name of the device mapping file.

Returns

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

Init()

void testMotorConfig::MyDeviceConfig::Init ( )

inlinevirtual

Read the configuration.

This reads the motor configuration attributes in memory.

Exceptions

std::runtime_error

in case of an error

Reimplemented from fcf::devmgr::motor::MotorConfig.

SetMapFile()

void testMotorConfig::MyDeviceConfig::SetMapFile ( const std::string &  filename )

inline

Member Data Documentation

m_map_file

std::string testMotorConfig::MyDeviceConfig::m_map_file

---

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

• devmgr/devices/test/testMotorConfig.cpp