#include <maxis.hpp>

Inheritance diagram for fcf::devmgr::maxis::MAxis:

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

virtual	~MAxis ()=default
	Default destructor.

void	CreateObjects (std::shared_ptr< fcf::devmgr::common::IDeviceConfig > config=nullptr) override
	Create object instances.

virtual void	Setup (const std::any &payload) override
	Executes a setup of the adc device.

virtual bool	IsSetupActive (const std::any &payload) const override
	Check if last setup message is still active.

void	SetTargetNamedPosition (const std::string named_position)

const std::string	GetTargetNamedPosition ()

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

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

virtual void	UpdateStatus () override
	Update the status of the MAxis device in the OLDB.

void	GetStatusList (utils::bat::DbVector &cfg_status, const MAxisControllerData &status_data)

void	HandleAction (const std::shared_ptr< fcfif::MAxisDevice > &maxis)

void	HandleMotAction (const std::shared_ptr< fcfif::MAxisDevice > &maxis)

void	HandleTrackAction (const std::shared_ptr< fcfif::MAxisDevice > &maxis)

virtual void	HandleCustomAction (const std::shared_ptr< fcfif::MAxisDevice > &maxis)

virtual void	GetCustomStatusBuffer (const std::string &stat_prefix, std::string &device_status)

virtual void	GetCustomStatusHeader (const std::string &prefix, bool end_acq, const core::dit::did::Did &dictionary, std::shared_ptr< CCfits::FITS > &fits_handle)

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.

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 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< fcf::devmgr::common::DeviceLcsIf >	GetLcsIf () const noexcept

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

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

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.

virtual void	RegisterComm (std::shared_ptr< protocol::base::IComm > comm_if, protocol::base::Dispatcher<> &failure, protocol::base::Dispatcher<> &normal)=0
	Register a communication interface object.

virtual bool	IsNotReady () const =0
	Check if device is Standby/NotReady.

virtual bool	IsReady () const =0
	Check if device is Standby/Ready.

virtual bool	IsOperational () const =0
	Check if device is Operational.

virtual void	CheckHwFailure () const =0
	Check if device is in failure state.

virtual bool	IsDisabling () const =0
	Check if device is disablig.

virtual void	Init ()=0
	Executes a Init command.

virtual void	Enable ()=0
	Executes a Enable command.

virtual void	Disable ()=0
	Executes a Disable command.

virtual void	Stop ()=0
	Executes a Stop command.

virtual void	Reset ()=0
	Executes a Reset command.

virtual void	UpdateStatus ()=0
	Update internal status by connecting to the LCS.

virtual void	Setup (const std::any &payload)=0
	Executes a setup.

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

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

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

virtual void	Simulate (rad::AnyEvent const &last_event)=0
	Executes a Simulat.

virtual void	StopSim (rad::AnyEvent const &last_event)=0
	Executes a StopSim.

virtual void	Ignore (rad::AnyEvent const &last_event)=0
	Executes a Ignore.

virtual void	StopIgn (rad::AnyEvent const &last_event)=0
	Executes a StopIgn.

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

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

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

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

virtual std::shared_ptr< DeviceLcsIf >	GetLcsIf () const noexcept=0
	Get a pointer of device LCS interface.

virtual std::shared_ptr< IDeviceConfig >	GetConfig () const =0
	Get a pointer of device configuration.

virtual void	StartMonitoring ()=0
	Start device monitoring via OPCUA subscriptions.

virtual void	StopMonitoring ()=0
	Stop device monitoring.

virtual void	WriteConfig ()=0
	Write configuration into OLDB.

virtual std::string	GetName () const noexcept=0
	Get device name.

Protected Attributes
MAxisControllerData	m_controller_status
	< object containing the status of the controller

std::string	m_target_named_pos

Protected Attributes inherited from 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.

protocol::base::Dispatcher	m_failure
	Dispatcher for managing failures.

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.

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

void	UpdateDb (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 (utils::bat::DbVector &cfg_list, const DeviceControllerData &status)

virtual void	WriteConfig ()
	Write configuration into OLDB.

Detailed Description

The MAxis class.

This class handles the behaviour of a generic MAxis device.

The MAxis class have two auxiliary objects. One for managing the device configuration and the other one for managing the connection to the device controller running in the Local Control System (LCS). These two objects are created by a dedicated method. These objects inherits basic behaviours from their parent classes.

See also: MAxisConfig; MAxisLcsIf; Device; DeviceConfig; DeviceLcsIf

Constructor & Destructor Documentation

◆ MAxis()

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

MAxis constructor.

Parameters

[in]	filename	filename of MAxis configuration file
[in]	name	MAxis identifier
[in]	data_ctx	reference to data context object

◆ ~MAxis()

virtual fcf::devmgr::maxis::MAxis::~MAxis ( )

virtualdefault

Default destructor.

Member Function Documentation

◆ CreateObjects()

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

override

Create object instances.

Parameters

config Shared pointer to a device config object

This method creates the instances of the device configuration and LCS interface objects that are needed by the device. If can override the type of the configuration by passing a parameter otherwise it will use the default adcConfig.

◆ GetCustomStatusBuffer()

void fcf::devmgr::maxis::MAxis::GetCustomStatusBuffer	(	const std::string &	stat_prefix,
		std::string &	device_status
	)

virtual

◆ GetCustomStatusHeader()

void fcf::devmgr::maxis::MAxis::GetCustomStatusHeader	(	const std::string &	prefix,
		bool	end_acq,
		const core::dit::did::Did &	dictionary,
		std::shared_ptr< CCfits::FITS > &	fits_handle
	)

virtual

◆ GetStatusList()

void fcf::devmgr::maxis::MAxis::GetStatusList	(	utils::bat::DbVector &	cfg_status,
		const MAxisControllerData &	status_data
	)

◆ GetTargetNamedPosition()

const std::string fcf::devmgr::maxis::MAxis::GetTargetNamedPosition ( )

◆ HandleAction()

void fcf::devmgr::maxis::MAxis::HandleAction ( const std::shared_ptr< fcfif::MAxisDevice > & maxis )

◆ HandleCustomAction()

void fcf::devmgr::maxis::MAxis::HandleCustomAction ( const std::shared_ptr< fcfif::MAxisDevice > & maxis )

virtual

◆ HandleMotAction()

void fcf::devmgr::maxis::MAxis::HandleMotAction ( const std::shared_ptr< fcfif::MAxisDevice > & maxis )

◆ HandleTrackAction()

void fcf::devmgr::maxis::MAxis::HandleTrackAction ( const std::shared_ptr< fcfif::MAxisDevice > & maxis )

◆ IsSetupActive()

bool fcf::devmgr::maxis::MAxis::IsSetupActive ( const std::any & payload ) const

overridevirtual

Check if last setup message is still active.

Parameters

[in] payload setup message associated with the action

Returns: true is action is still ongoing, false otherwise.

In case an error with the hardware while waiting for the setup to finish, the method will catch the exception and rethrow a new one with more context information.

Exceptions

std::runtime_error

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

◆ SetTargetNamedPosition()

void fcf::devmgr::maxis::MAxis::SetTargetNamedPosition ( const std::string named_position )

◆ Setup()

void fcf::devmgr::maxis::MAxis::Setup ( const std::any & payload )

overridevirtual

Executes a setup of the adc device.

Parameters

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

Returns: true if command is successfully executed, false otherwise.

Exceptions

an	exception if an error ocurrs.

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

◆ Status() [1/2]

void fcf::devmgr::maxis::MAxis::Status	(	bool	end_acq,
		const core::dit::did::Did &	dictionary,
		std::shared_ptr< CCfits::FITS > &	fits_handle
	)

overridevirtual

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.

◆ Status() [2/2]

void fcf::devmgr::maxis::MAxis::Status	(	const std::any &	payload,
		std::string &	buffer
	)

overridevirtual

Obtain the status of the device.

Parameters

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

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

◆ UpdateStatus()

void fcf::devmgr::maxis::MAxis::UpdateStatus ( )

overridevirtual

Update the status of the MAxis device in the OLDB.

This method reads the status from the controller and updates the database accordingly.

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

Member Data Documentation

◆ m_controller_status

MAxisControllerData fcf::devmgr::maxis::MAxis::m_controller_status

protected

< object containing the status of the controller

◆ m_target_named_pos

std::string fcf::devmgr::maxis::MAxis::m_target_named_pos

protected

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

devmgr/devices/src/include/fcf/devmgr/devices/maxis.hpp
devmgr/devices/src/maxis.cpp

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ MAxis()

◆ ~MAxis()

Member Function Documentation

◆ CreateObjects()

◆ GetCustomStatusBuffer()

◆ GetCustomStatusHeader()

◆ GetStatusList()

◆ GetTargetNamedPosition()

◆ HandleAction()

◆ HandleCustomAction()

◆ HandleMotAction()

◆ HandleTrackAction()

◆ IsSetupActive()

◆ SetTargetNamedPosition()

◆ Setup()

◆ Status() [1/2]

◆ Status() [2/2]

◆ UpdateStatus()

Member Data Documentation

◆ m_controller_status

◆ m_target_named_pos