ifw-fcf  5.0.0-pre2
Public Member Functions | Public Attributes | List of all members
testMotorConfig::MyDeviceConfig Class Reference

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

Inheritance diagram for testMotorConfig::MyDeviceConfig:
fcf::devmgr::motor::MotorConfig fcf::devmgr::motor::MotorBaseConfig fcf::devmgr::common::DeviceConfig fcf::devmgr::common::IDeviceConfig

Public Member Functions

 MyDeviceConfig (const std::string &filename, const std::string &name)
 
void Init ()
 Read the configuration. More...
 
void GetConfig (protocol::base::VectorVariant &params)
 
void SetMapFile (const std::string &filename)
 
virtual std::string GetMapFile () const
 Get name of the device mapping file. More...
 
- Public Member Functions inherited from fcf::devmgr::motor::MotorConfig
 MotorConfig (const std::string filename, const std::string name)
 MotorConfig constructor. More...
 
 MotorConfig (const std::string name)
 MotorConfig constructor. More...
 
virtual ~MotorConfig ()=default
 MotorConfig destructor. More...
 
virtual void GetConfig (protocol::base::VectorVariant &params) const override
 Obtain the list of configuration parameters. More...
 
virtual void GetConfigList (utils::bat::DbVector &cfg_list, std::string prefix) const override
 Get configuration list. More...
 
int GetNumberOfInitSteps () const noexcept
 Get number of initialisations steps. More...
 
double GetScaleFactor () const override
 
void SetScaleFactor (double scale)
 Set Scale Factor. More...
 
- Public Member Functions inherited from fcf::devmgr::motor::MotorBaseConfig
 MotorBaseConfig (const std::string filename, const std::string name)
 MotorConfig constructor. More...
 
 MotorBaseConfig (const std::string name)
 MotorConfig constructor. More...
 
virtual ~MotorBaseConfig ()=default
 MotorConfig destructor. More...
 
int GetNumberOfNamedPositions () const noexcept
 
double GetVelocity () const
 
std::string GetNamedPosition (const int index) const
 GetNamedPosition. More...
 
double GetNamedPositionValue (const int index) const
 GetNamedPositionValue. More...
 
bool FindNamedPositionValue (const std::string named_pos, double &position) const
 Find value associated to a named position. More...
 
bool FindNamedPositionValue (const double position, std::string &name) const
 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...
 
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...
 
void CheckConfig () const
 Validates the document configuration. More...
 

Public Attributes

std::string m_map_file
 

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...
 
- Protected Attributes inherited from fcf::devmgr::motor::MotorConfig
std::vector< InitActionm_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. More...
 
- 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...
 

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_errorin 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: