#include <deviceFacade.hpp>

Public Member Functions
	DeviceFacade (rad::SMAdapter &sm, Config &config, protocol::base::Dispatcher<> &failure, protocol::base::Dispatcher<> &normal)

virtual	~DeviceFacade ()
	~DeviceFacade

virtual bool	Init (rad::SMAdapter &sm, rad::ThreadActivity *activity)
	Init all devices managed by the devmgr.

virtual bool	Enable (rad::SMAdapter &sm, rad::ThreadActivity *activity)
	Enable all devices managed by the devmgr.

virtual bool	Recover (rad::SMAdapter &sm, rad::ThreadActivity *activity)
	Recover all devices managed by the devmgr.

virtual bool	Disable ()
	Disable all devices managed by the devmgr.

virtual bool	AsyncSetup (const std::any &payload)
	Executes a setup message.

virtual bool	Setup (const std::any &payload, rad::ThreadActivity *activity)
	Executes a setup message.

virtual void	Stop ()
	Abort all devices managed by the devmgr.

virtual void	Reset ()
	Reset devices.

virtual void	Status (const std::any &payload, std::string &buffer)
	Get status from devices.

virtual void	Simulate (rad::AnyEvent const &last_event)
	Simulate devices managed by the server.

virtual void	StopSim (rad::AnyEvent const &last_event)
	Stop simulating devices managed by the server.

virtual void	Ignore (rad::AnyEvent const &last_event)
	Ignore devices managed by the server.

virtual void	StopIgn (rad::AnyEvent const &last_event)
	Stop ignoring devices managed by the server.

virtual void	HwReset (rad::AnyEvent const &last_event)
	Reset hardware.

virtual void	HwInit (rad::AnyEvent const &last_event)
	Init hardware.

virtual void	HwEnable (rad::AnyEvent const &last_event)
	Enable hardware.

virtual void	HwDisable (rad::AnyEvent const &last_event)
	Disable hardware.

virtual std::string	DevNames () const
	Get list of managed devices.

virtual std::string	DevInfo () const
	Get information of managed devices.

virtual std::string	DevConfig (const std::string devname) const
	Get configuration for a given device.

void	StartDaq (std::string daqid)
	Start Data Acquisition.

fcf::devmgr::common::DaqInfo	StopDaq (std::string daqid)
	Stop Data Acquisition.

void	AbortDaq (std::string daqid)
	Abort Data Acquisition.

fcf::devmgr::common::DaqInfo	GetDaqStatus (std::string daqid) const
	Get Daq Status.

void	TriggerInternalEvent (rad::SMAdapter &sm, rad::UniqueEvent &&e)
	Trigger an internal event.

void	AddDevice (std::shared_ptr< IDevice > device)
	Add a device instance to be managed by the facade.

void	ClearDevices ()
	Empty internal device map.

protocol::base::Dispatcher &	GetFailureCB ()
	Get reference to failure CB.

protocol::base::Dispatcher &	GetNormalCB ()
	Get reference to normal CB.

const int	GetNumDevices () const noexcept
	Get the number of devices.

void	CheckDeviceName (const std::vector< std::string > &devices) const
	Check if list of devices are managed by the server.

Detailed Description

This class provide a device facade object to allow the devmgr managing easily all the devices under its control. This class relies on a device abstract class that implement all common features of the devices.

See also: Device

Constructor & Destructor Documentation

◆ DeviceFacade()

fcf::devmgr::common::DeviceFacade::DeviceFacade	(	rad::SMAdapter &	sm,
		Config &	config,
		protocol::base::Dispatcher<> &	failure,
		protocol::base::Dispatcher<> &	normal
	)

Constructor.

Parameters

[in]	sm	Reference to the state machine sigleton.
[in]	config	Config reference object.
[in]	failure	Dispatcher for failure events.
[in]	normal	Dispatcher for normal events.

◆ ~DeviceFacade()

fcf::devmgr::common::DeviceFacade::~DeviceFacade ( )

virtual

~DeviceFacade

Member Function Documentation

◆ AbortDaq()

void fcf::devmgr::common::DeviceFacade::AbortDaq ( std::string daqid )

Abort Data Acquisition.

See also: StartDaq

◆ AddDevice()

void fcf::devmgr::common::DeviceFacade::AddDevice ( std::shared_ptr< IDevice > device )

Add a device instance to be managed by the facade.

Parameters

[in] device Smart pointer to the device.

◆ AsyncSetup()

bool fcf::devmgr::common::DeviceFacade::AsyncSetup ( const std::any & payload )

virtual

Executes a setup message.

Parameters

[in] payload message containing the setup payload

Returns: true if the execution was succesful, false otherwise.

This method takes care of forwarding the setup message to all devices registered in the facade.

The device facade class handles devices sequentially. In case of an error, the setup will finish immediately. The device facade does not know the internals of each device, it just forward the message blindly to all devices. Each device class is responsible of handling the parameters and actions defined in the setup message, as well as determining when the action is finished.

◆ CheckDeviceName()

void fcf::devmgr::common::DeviceFacade::CheckDeviceName ( const std::vector< std::string > & devices ) const

Check if list of devices are managed by the server.

◆ ClearDevices()

void fcf::devmgr::common::DeviceFacade::ClearDevices ( )

Empty internal device map.

◆ DevConfig()

std::string fcf::devmgr::common::DeviceFacade::DevConfig ( const std::string devname ) const

virtual

Get configuration for a given device.

Returns

◆ DevInfo()

std::string fcf::devmgr::common::DeviceFacade::DevInfo ( ) const

virtual

Get information of managed devices.

Returns

◆ DevNames()

std::string fcf::devmgr::common::DeviceFacade::DevNames ( ) const

virtual

Get list of managed devices.

Returns

◆ Disable()

bool fcf::devmgr::common::DeviceFacade::Disable ( )

virtual

Disable all devices managed by the devmgr.

Returns

◆ Enable()

bool fcf::devmgr::common::DeviceFacade::Enable	(	rad::SMAdapter &	sm,
		rad::ThreadActivity *	activity
	)

virtual

Enable all devices managed by the devmgr.

Parameters

[in]	sm	Reference to the SM sigleton.
[in]	activity	Pointer to the current activity.

Returns

◆ GetDaqStatus()

fcf::devmgr::common::DaqInfo fcf::devmgr::common::DeviceFacade::GetDaqStatus ( std::string daqid ) const

Get Daq Status.

See also: StartDaq

◆ GetFailureCB()

protocol::base::Dispatcher & fcf::devmgr::common::DeviceFacade::GetFailureCB ( )

Get reference to failure CB.

Returns

◆ GetNormalCB()

protocol::base::Dispatcher & fcf::devmgr::common::DeviceFacade::GetNormalCB ( )

Get reference to normal CB.

Returns

◆ GetNumDevices()

const int fcf::devmgr::common::DeviceFacade::GetNumDevices ( ) const

noexcept

Get the number of devices.

Returns: Return the number of devices registered in the facade.

◆ HwDisable()

void fcf::devmgr::common::DeviceFacade::HwDisable ( rad::AnyEvent const & last_event )

virtual

Disable hardware.

Returns

◆ HwEnable()

void fcf::devmgr::common::DeviceFacade::HwEnable ( rad::AnyEvent const & last_event )

virtual

Enable hardware.

Returns

◆ HwInit()

void fcf::devmgr::common::DeviceFacade::HwInit ( rad::AnyEvent const & last_event )

virtual

Init hardware.

Returns

◆ HwReset()

void fcf::devmgr::common::DeviceFacade::HwReset ( rad::AnyEvent const & last_event )

virtual

Reset hardware.

Returns

◆ Ignore()

void fcf::devmgr::common::DeviceFacade::Ignore ( rad::AnyEvent const & last_event )

virtual

Ignore devices managed by the server.

◆ Init()

bool fcf::devmgr::common::DeviceFacade::Init	(	rad::SMAdapter &	sm,
		rad::ThreadActivity *	activity
	)

virtual

Init all devices managed by the devmgr.

Returns

◆ Recover()

bool fcf::devmgr::common::DeviceFacade::Recover	(	rad::SMAdapter &	sm,
		rad::ThreadActivity *	activity
	)

virtual

Recover all devices managed by the devmgr.

Parameters

[in]	sm	Reference to the SM sigleton.
[in]	activity	Pointer to the current activity.

Returns

◆ Reset()

void fcf::devmgr::common::DeviceFacade::Reset ( )

virtual

Reset devices.

Returns

◆ Setup()

bool fcf::devmgr::common::DeviceFacade::Setup	(	const std::any &	payload,
		rad::ThreadActivity *	activity
	)

virtual

Executes a setup message.

Parameters

[in]	payload	message containing the setup payload
[in]	activity	pointer to the thread

Returns: true if the execution was succesful, false otherwise.

This method takes care of forwarding the setup message to all devices registered in the facade. Once the setup is successfully executed, the method waits until the action is finished or an error occurs.

The device facade class handles devices sequentially. In case of an error, the setup will finish immediately. The device facade does not know the internals of each device, it just forward the message blindly to all devices. Each device class is responsible of handling the parameters and actions defined in the setup message, as well as determining when the action is finished.

The setup will be stopped whenever the thread (activity) will be stopped.

◆ Simulate()

void fcf::devmgr::common::DeviceFacade::Simulate ( rad::AnyEvent const & last_event )

virtual

Simulate devices managed by the server.

◆ StartDaq()

void fcf::devmgr::common::DeviceFacade::StartDaq ( std::string daqid )

Start Data Acquisition.

Returns

This method collect data from devices at the beginning of the acquisition. It also register the data for defining the name of data product that will be generated at the end of the acquisition

See also: StopAcq

◆ Status()

void fcf::devmgr::common::DeviceFacade::Status	(	const std::any &	payload,
		std::string &	buffer
	)

virtual

Get status from devices.

Parameters

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

◆ Stop()

void fcf::devmgr::common::DeviceFacade::Stop ( )

virtual

Abort all devices managed by the devmgr.

Returns

◆ StopDaq()

fcf::devmgr::common::DaqInfo fcf::devmgr::common::DeviceFacade::StopDaq ( std::string daqid )

Stop Data Acquisition.

This method collect data from devices at the end of the acquisition and it creates the data product FITS file including the meta-data for all devices currently managed by the server.

The filename follows the following convention:

<prefix>_<dp_id>_<fcs_id>.fits

The information for the filename is defined by the StartDaq method.

See also: StartDaq

◆ StopIgn()

void fcf::devmgr::common::DeviceFacade::StopIgn ( rad::AnyEvent const & last_event )

virtual

Stop ignoring devices managed by the server.

◆ StopSim()

void fcf::devmgr::common::DeviceFacade::StopSim ( rad::AnyEvent const & last_event )

virtual

Stop simulating devices managed by the server.

◆ TriggerInternalEvent()

void fcf::devmgr::common::DeviceFacade::TriggerInternalEvent	(	rad::SMAdapter &	sm,
		rad::UniqueEvent &&	e
	)

Trigger an internal event.

Parameters

[in]	sm	Reference to the SM sigleton.
[in]	e	Event to be triggered.

Returns

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

devmgr/common/src/include/fcf/devmgr/common/deviceFacade.hpp
devmgr/common/src/deviceFacade.cpp

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ DeviceFacade()

◆ ~DeviceFacade()

Member Function Documentation

◆ AbortDaq()

◆ AddDevice()

◆ AsyncSetup()

◆ CheckDeviceName()

◆ ClearDevices()

◆ DevConfig()

◆ DevInfo()

◆ DevNames()

◆ Disable()

◆ Enable()

◆ GetDaqStatus()

◆ GetFailureCB()

◆ GetNormalCB()

◆ GetNumDevices()

◆ HwDisable()

◆ HwEnable()

◆ HwInit()

◆ HwReset()

◆ Ignore()

◆ Init()

◆ Recover()

◆ Reset()

◆ Setup()

◆ Simulate()

◆ StartDaq()

◆ Status()

◆ Stop()

◆ StopDaq()

◆ StopIgn()

◆ StopSim()

◆ TriggerInternalEvent()