ifw-fcf  2.0.0
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | Protected Types | List of all members
fcf::devmgr::shutter::ShutterConfig Class Reference

Shutter Configuration class. More...

#include <shutterConfig.hpp>

Inheritance diagram for fcf::devmgr::shutter::ShutterConfig:
fcf::devmgr::common::DeviceConfig fcf::devmgr::common::IDeviceConfig testShutter::MyDeviceConfig testShutterConfig::MyDeviceConfig testShutterLcsIf::TestShutterConfig

Public Member Functions

 ShutterConfig (const std::string filename, const std::string name)
 MotorConfig constructor. More...
 
virtual ~ShutterConfig ()
 ShutterConfig destructor. More...
 
- Public Member Functions inherited from fcf::devmgr::common::DeviceConfig
 DeviceConfig (const std::string &filename, const std::string &name)
 DeviceConfig constructor. More...
 
virtual ~DeviceConfig ()
 DeviceConfig destructor. More...
 
bool Init ()
 Initialises a device. More...
 
virtual void ReadConfig ()
 Read the configuration. More...
 
virtual void GetConfig (fcf::common::VectorVariant &params)
 Obtain the list of configuration parameters. 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...
 
virtual std::string GetMapFile ()
 Get name of the device mapping file. More...
 

Protected Types

enum  {
  CFG_IGCLOSED = 0, CFG_IGFAULT = 1, CFG_IGOPEN = 2, CFG_LOWCLOSED = 3,
  CFG_LOWFAULT = 4, CFG_LOWOPEN = 5, CFG_LOWSWITCH = 6, CFG_INITSTATE = 7,
  CFG_TIMEOUT = 8, END_ENUM_SHUTTER
}
 

Additional Inherited Members

- 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
 

Detailed Description

Shutter Configuration class.

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

Member Enumeration Documentation

anonymous enum
protected
Enumerator
CFG_IGCLOSED 
CFG_IGFAULT 
CFG_IGOPEN 
CFG_LOWCLOSED 
CFG_LOWFAULT 
CFG_LOWOPEN 
CFG_LOWSWITCH 
CFG_INITSTATE 
CFG_TIMEOUT 
END_ENUM_SHUTTER 

Constructor & Destructor Documentation

fcf::devmgr::shutter::ShutterConfig::ShutterConfig ( const std::string  filename,
const std::string  name 
)

MotorConfig constructor.

Parameters
[in]filenameFilename of the device configuration file.
[in]nameDevice identifier.
fcf::devmgr::shutter::ShutterConfig::~ShutterConfig ( )
virtual

ShutterConfig destructor.


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