Inheritance diagram for TestShutter:

Public Member Functions
	TestShutter (const std::string filename, const std::string name, fcf::devmgr::common::DataContext &data_ctx)

void	CreateObjects (std::shared_ptr< fcf::devmgr::common::IDeviceConfig > config=nullptr)

void	RegisterComm (std::shared_ptr< fcf::common::IComm > comm_if, fcf::common::Dispatcher<> &failure, fcf::common::Dispatcher<> &normal)
	Register a communication interface object. More...

void	UpdateStatus ()
	Update internal status by connecting to the LCS. More...

void	Setup (const std::any &payload)
	Executes a setup. More...

bool	IsSetupActive (const std::any &payload) const
	Check if setup is still active. More...

void	Status (const std::any &payload, std::string &buffer)
	Obtain the status of the device. More...

void	Status (bool end_acq, const dit::did::Did &dictionary, std::shared_ptr< CCfits::FITS > &fits_handle)
	Obtain the status of the device. More...

void	Reset ()
	Executes a Reset command. More...

std::shared_ptr < fcf::devmgr::common::DeviceLcsIf >	GetLcsIf () const
	Get a pointer of device LCS interface. More...

std::shared_ptr < fcf::devmgr::common::IDeviceConfig >	GetConfig () const
	Get a pointer of device configuration. More...

bool	IsMsgForMe (const std::string &id) const

Public Member Functions inherited from fcf::devmgr::common::Device
	Device (const std::string filename, const std::string name, DataContext &data_ctx)
	Device abstract class constructor. More...

virtual	~Device ()
	Default destructor. More...

virtual bool	IsNotReady () const override
	Check if device is Standby/NotReady. More...

virtual bool	IsReady () const override
	Check if device is Standby/Ready. More...

virtual bool	IsOperational () const override
	Check if device is Operational. More...

virtual void	CheckHwFailure () const override
	Check if device is in failure state. More...

virtual bool	IsDisabling () const override
	Check if device is disablig. More...

virtual void	Init () override
	Executes a Init command. More...

virtual void	Enable () override
	Executes a Enable command. More...

virtual void	Disable () override
	Executes a Disable command. More...

virtual void	Stop () override
	Executes a Stop command. More...

void	Status (DeviceControllerData *data, std::string &buffer)

virtual void	Status (const std::string prefix, const dit::did::Did &dictionary, std::shared_ptr< CCfits::FITS > &fits_handle)
	Obtain the status of the device. More...

virtual void	Simulate (rad::AnyEvent const &last_event) override
	Executes a Simulat. More...

virtual void	StopSim (rad::AnyEvent const &last_event) override
	Executes a StopSim. More...

virtual void	Ignore (rad::AnyEvent const &last_event) override
	Executes a Ignore. More...

virtual void	StopIgn (rad::AnyEvent const &last_event) override
	Executes a StopIgn. More...

virtual void	HwReset (rad::AnyEvent const &last_event) override
	Executes a hardware reset command. More...

virtual void	HwInit (rad::AnyEvent const &last_event) override
	Executes a hardware init command. More...

virtual void	HwEnable (rad::AnyEvent const &last_event) override
	Executes a hardware enable command. More...

virtual void	HwDisable (rad::AnyEvent const &last_event) override
	Executes a hardware disable command. More...

virtual void	StartMonitoring () override
	Start device monitoring via OPCUA subscriptions. More...

virtual void	StopMonitoring () override
	Stop device monitoring. More...

virtual std::string	GetName () const override
	Get device id. More...

Public Member Functions inherited from fcf::devmgr::common::IDevice
virtual void	CreateObjects (std::shared_ptr< fcf::devmgr::common::IDeviceConfig > config=nullptr)=0
	Create basic objects needed by the device class. More...

Additional Inherited Members
Protected Member Functions inherited from fcf::devmgr::common::Device
bool	IsMsgForMe (const std::string &id) const
	Check if received message id is addressed to me. More...

void	UpdateDb (std::vector< std::string > attr_vector)
	Update device database. More...

void	SetIgnore (bool flag)
	SetIgnore. More...

void	SetSimulation (bool flag)
	SetSimulation. More...

void	GetPrefix (const std::vector< std::string > prefix_list, std::string &prefix)
	Get prefix for writing attributes to the DB. More...

bool	CheckNameParam (const std::any &payload)
	Determine whether paramater is included (device name). More...

Protected Attributes inherited from fcf::devmgr::common::Device
std::string	m_filename
	device configuration filename. More...

std::string	m_name
	device ID. More...

DataContext &	m_data_ctx
	reference to the data context object. More...

fcf::common::Dispatcher	m_failure
	Dispatcher for managing failures. More...

fcf::common::Dispatcher	m_normal
	Dispatcher for managing positive events. More...

std::shared_ptr< DeviceConfig >	m_config
	Pointer to configuration object. More...

std::shared_ptr< DeviceLcsIf >	m_lcs_if
	Local Control System Interface. More...

Constructor & Destructor Documentation

TestShutter::TestShutter	(	const std::string	filename,
		const std::string	name,
		fcf::devmgr::common::DataContext &	data_ctx
	)

inline

Member Function Documentation

void TestShutter::CreateObjects ( std::shared_ptr< fcf::devmgr::common::IDeviceConfig > config = nullptr )

inline

std::shared_ptr<fcf::devmgr::common::IDeviceConfig> TestShutter::GetConfig ( ) const

inlinevirtual

Get a pointer of device configuration.

Returns: shared pointer of internal configuration object

Implements fcf::devmgr::common::IDevice.

std::shared_ptr<fcf::devmgr::common::DeviceLcsIf> TestShutter::GetLcsIf ( ) const

inlinevirtual

Get a pointer of device LCS interface.

Returns: shared pointer of internal LCSIf object

Implements fcf::devmgr::common::IDevice.

bool TestShutter::IsMsgForMe ( const std::string & id ) const

inline

bool TestShutter::IsSetupActive ( const std::any & payload ) const

inlinevirtual

Check if setup is still active.

Parameters

[in] payload Setup message object

This method validate if condition requested by the setup message has been achieved.

Implements fcf::devmgr::common::IDevice.

void TestShutter::RegisterComm	(	std::shared_ptr< fcf::common::IComm >	comm_if,
		fcf::common::Dispatcher<> &	failure,
		fcf::common::Dispatcher<> &	normal
	)

inlinevirtual

Register a communication interface object.

Parameters

[in]	comm_if	shared pointer to the communication interface object
[in]	failure	dispatcher object for failure events
[in]	normal	dispatcher object for recovery of failure events.

This method register a particular communication interface to the device. Most of the devices will use OPCUA but there might be several implementations so with this method one can register an interface that has been created previously and registered in the communication factory.

See Also: iComm; commFactory; commMaker

Implements fcf::devmgr::common::IDevice.

void TestShutter::Reset ( )

inlinevirtual

Executes a Reset command.

Exceptions

an	exception if an error ocurrs.

Reimplemented from fcf::devmgr::common::Device.

void TestShutter::Setup ( const std::any & payload )

inlinevirtual

Executes a setup.

Parameters

[in] payload contains the payload of the setup message.

Exceptions

an	exception if an error ocurrs.

Implements fcf::devmgr::common::IDevice.

void TestShutter::Status	(	const std::any &	payload,
		std::string &	buffer
	)

inlinevirtual

Obtain the status of the device.

Parameters

payload	Status message object
buffer	Buffer where the status will be written

Implements fcf::devmgr::common::IDevice.

void TestShutter::Status	(	bool	end_acq,
		const dit::did::Did &	dictionary,
		std::shared_ptr< CCfits::FITS > &	fits_handle
	)

inlinevirtual

Obtain the status of the device.

Parameters

end_acq	Flag to indicate is the end of the acquisition
dictionary	Reference to the dictionary object
fits_handle	Pointer to the CCFITS object

This method will obtain the data from each device and add the corresponding meta-data to the CCfits object. If the end_acq is not true it will just register the start of the acquisition.

Implements fcf::devmgr::common::IDevice.

void TestShutter::UpdateStatus ( )

inlinevirtual

Update internal status by connecting to the LCS.

Implements fcf::devmgr::common::IDevice.

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

devmgr/common/test/testDevice.cpp

Public Member Functions

Additional Inherited Members

Constructor & Destructor Documentation

Member Function Documentation