testShutter::MyShutter Class Reference

Dummy Test shutter class used for testing purposes. More...

Inheritance diagram for testShutter::MyShutter:

Public Member Functions
	MyShutter (const std::string &filename, const std::string &name, ifw::fcf::devmgr::common::DataContext &data_ctx)
void	CreateObjects (std::shared_ptr< ifw::fcf::devmgr::common::IDeviceConfig > config)
Public Member Functions inherited from ifw::fcf::devmgr::shutter::Shutter
	Shutter (const std::string filename, const std::string name, ifw::fcf::devmgr::common::DataContext &data_ctx)
	Shutter constructor.
virtual	~Shutter ()=default
	Default destructor.
void	CreateObjects (std::shared_ptr< ifw::fcf::devmgr::common::IDeviceConfig > config=nullptr) override
	Create object instances.
virtual void	UpdateStatus ()
	Update the status of the shutter device in the OLDB.
virtual void	Setup (const std::any &payload) override
	Executes a setup of the shutter device.
virtual bool	IsSetupActive (const std::any &payload) const override
	Check if last setup message is still active.
virtual void	Status (const std::any &payload, std::string &buffer) override
	Obtain the status of the device.
virtual void	Status (bool end_acq, const ifw::core::dit::did::Did &dictionary, std::shared_ptr< CCfits::FITS > &fits_handle) override
	Obtain the status of the device.
Public Member Functions inherited from ifw::fcf::devmgr::common::Device
	Device (const std::string filename, const std::string name, DataContext &data_ctx)
	Device abstract class constructor.
virtual	~Device ()
	Default destructor.
virtual bool	IsNotReady () const override
	Check if device is Standby/NotReady.
virtual bool	IsReady () const override
	Check if device is Standby/Ready.
virtual bool	IsOperational () const override
	Check if device is Operational.
virtual void	CheckHwFailure () const override
	Check if device is in failure state.
virtual bool	IsDisabling () const override
	Check if device is disablig.
virtual void	Init () override
	Executes a Init command.
virtual void	Enable () override
	Executes a Enable command.
virtual void	Disable () override
	Executes a Disable command.
virtual void	Stop () override
	Executes a Stop command.
virtual void	Reset () override
	Executes a Reset command.
void	GetStatusBuffer (const std::string &stat_prefix, const DeviceControllerData *const data, std::string &buffer)
void	GetStatusHeader (const std::string &prefix, const ifw::core::dit::did::Did &dictionary, std::shared_ptr< CCfits::FITS > &fits_handle)
	Obtain the status of the device.
virtual void	Simulate (rad::AnyEvent const &last_event) override
	Executes a Simulat.
virtual void	StopSim (rad::AnyEvent const &last_event) override
	Executes a StopSim.
virtual void	Ignore (rad::AnyEvent const &last_event) override
	Executes a Ignore.
virtual void	StopIgn (rad::AnyEvent const &last_event) override
	Executes a StopIgn.
virtual void	HwReset (rad::AnyEvent const &last_event) override
	Executes a hardware reset command.
virtual void	HwInit (rad::AnyEvent const &last_event) override
	Executes a hardware init command.
virtual void	HwEnable (rad::AnyEvent const &last_event) override
	Executes a hardware enable command.
virtual void	HwDisable (rad::AnyEvent const &last_event) override
	Executes a hardware disable command.
virtual void	StartMonitoring () override
	Start device monitoring via OPCUA subscriptions.
virtual void	StopMonitoring () override
	Stop device monitoring.
virtual std::string	GetName () const noexcept override
	Get device id.
virtual std::string	GetLogName () const noexcept
	Get device id for logging purposes.
virtual std::shared_ptr< ifw::fcf::devmgr::common::DeviceLcsIf >	GetLcsIf () const noexcept
virtual std::shared_ptr< ifw::fcf::devmgr::common::IDeviceConfig >	GetConfig () const noexcept
	Get a pointer of device configuration.
void	RegisterComm (std::shared_ptr< ifw::core::protocol::base::IComm > comm_if, ifw::core::protocol::base::Dispatcher<> &failure, ifw::core::protocol::base::Dispatcher<> &normal)
	Register a communication interface object.
Public Member Functions inherited from ifw::fcf::devmgr::common::IDevice
virtual void	CreateObjects (std::shared_ptr< ifw::fcf::devmgr::common::IDeviceConfig > config=nullptr)=0
	Create basic objects needed by the device class.

Additional Inherited Members
Protected Member Functions inherited from ifw::fcf::devmgr::common::Device
bool	IsMsgForMe (const std::string &id) const noexcept
	Check if received message id is addressed to me.
std::string	GetFileName () const noexcept
DataContext &	GetDataCtx () const noexcept
void	UpdateDb (ifw::core::utils::bat::DbVector &vec)
	Update device database.
void	SetIgnore (bool flag)
	SetIgnore.
void	SetSimulation (bool flag)
	SetSimulation.
void	GetPrefix (const std::vector< std::string > prefix_list, std::string &prefix) const
	Get prefix for writing attributes to the DB.
std::string	GetCfgPrefix (const std::vector< std::string > prefix_list) const
std::string	GetStatPrefix (const std::vector< std::string > prefix_list) const
bool	CheckNameParam (const std::any &payload)
	Determine whether paramater is included (device name).
void	GetStatusList (ifw::core::utils::bat::DbVector &cfg_list, const DeviceControllerData &status)
virtual void	WriteConfig ()
	Write configuration into OLDB.
Protected Attributes inherited from ifw::fcf::devmgr::common::Device
std::string	m_filename
	device configuration filename.
std::string	m_name
	device ID.
DataContext &	m_data_ctx
	reference to the data context object.
ifw::core::protocol::base::Dispatcher	m_failure
	Dispatcher for managing failures.
ifw::core::protocol::base::Dispatcher	m_normal
	Dispatcher for managing positive events.
std::shared_ptr< DeviceConfig >	m_config
	Pointer to configuration object.
std::shared_ptr< DeviceLcsIf >	m_lcs_if
	Local Control System Interface.

Detailed Description

Dummy Test shutter class used for testing purposes.

Constructor & Destructor Documentation

MyShutter()

testShutter::MyShutter::MyShutter ( const std::string & filename, const std::string & name, ifw::fcf::devmgr::common::DataContext & data_ctx )

inline

Member Function Documentation

CreateObjects()

void testShutter::MyShutter::CreateObjects ( std::shared_ptr< ifw::fcf::devmgr::common::IDeviceConfig > config )

inline

---

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

• devmgr/devices/test/testShutter.cpp