Shutter Local Control System (LCS) Interface (IF) class. More...

#include <shutterLcsIf.hpp>

Inheritance diagram for fcf::devmgr::shutter::ShutterLcsIf:

Public Member Functions
	ShutterLcsIf (std::shared_ptr< fcf::devmgr::common::IDeviceConfig > config, fcf::devmgr::common::DataContext &data_ctx)
	ShutterLcsIf constructor. More...

virtual	~ShutterLcsIf ()=default
	Default destructor. More...

virtual void	InitObject ()
	Initialize object. More...

virtual bool	IsReady () const
	Check if controller is in Standby/Ready state. More...

virtual bool	IsOperational () const
	Check if controller is in Operational. More...

void	Open ()
	Executes the Open RPC. More...

void	Close ()
	Executes the Close RPC. More...

bool	IsOpening () const
	Check if controller is opening the shutter. More...

bool	IsClosing () const
	Check if controller is closing the shutter. More...

bool	IsOpen () const
	Check if shutter is open. More...

bool	IsClose () const
	Check if shutter is close. More...

virtual std::string	GetRpcError (const short error) const

Public Member Functions inherited from fcf::devmgr::common::DeviceLcsIf
	DeviceLcsIf (std::shared_ptr< IDeviceConfig > config, DataContext &data_ctx)
	DeviceLcsIf constructor. More...

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

virtual void	Connect ()
	Connect to the controller or simulator. More...

virtual void	Disconnect ()
	Disconnect from the controller of simulator. More...

virtual bool	IsNotReady () const
	Check if controller is in Standby/NotReady state. More...

virtual bool	IsDisabling () const
	Check if controller is in Disabling state. More...

virtual bool	IsHwFailure () const
	Check if controller is in Hardware Failure. More...

virtual void	Init ()
	Executes the Init RPC. More...

virtual void	Enable ()
	Executes the Enable RPC. More...

virtual void	Disable ()
	Executes the Disable RPC. More...

virtual void	Stop ()
	Executes the Stop RPC. More...

virtual void	Reset ()
	Executes the Reset RPC. More...

virtual void	StartMonitoring ()
	Start monitoring of controller attributes. More...

virtual void	StopMonitoring ()
	Stop monitoring of controller attributes. More...

virtual void	ReadStatus (DeviceControllerData &status)
	ReadStatus. More...

virtual void	Listener (protocol::base::VectorVariant &params)
	Callback for listening controller events. More...

virtual std::string	GetHwError (int &error_code, const bool update=false)
	Get error message. More...

std::string	GetMapValue (const std::string &category, const std::string &key) const
	Get mapping value. More...

protocol::base::Dispatcher< protocol::base::VectorVariant & > &	GetDispatcher ()

bool	IsConfigLoaded () const
	Check if configuration was loaded. More...

bool	IsConnected () const
	Check is the communication was established. More...

virtual std::shared_ptr< IDeviceConfig >	GetDeviceConfig () const
	Get a pointer of device configuration. More...

const elt::configng::CiiConfigInstanceNamespace &	GetCfgInstance () const

virtual void	GetStates (int &state, int &substate)
	Get states (state and substate) of the controller. More...

Additional Inherited Members
Public Types inherited from fcf::devmgr::common::DeviceLcsIf
enum	{ STAT_LOCAL = 1 , STAT_ERROR = 2 , STAT_HW_STATUS = 3 , STAT_STATE = 4 , STAT_SUBSTATE = 5 }

Protected Member Functions inherited from fcf::devmgr::common::DeviceLcsIf
void	LoadConfig ()
	Load the YAML configuration. More...

void	ExecuteRpc (const std::string &obj, const std::string &proc, protocol::base::VectorVariant &attr_list)

int	ReadErrorCode ()

void	StoreUaNames (const std::vector< std::pair< std::string, unsigned int >> &ualist)
	StoreUaNames. More...

void	StoreAttribute (const std::string key, const protocol::base::Variant &value, int attribute)
	Store the updated into the DB. More...

Protected Attributes inherited from fcf::devmgr::common::DeviceLcsIf
std::unique_ptr< elt::configng::CiiConfigDocument >	m_config_doc
	Config document for mapping file. More...

std::shared_ptr< protocol::base::IComm >	m_comm
	Shared pointer to the communication object. More...

std::shared_ptr< IDeviceConfig >	m_config
	Shared pointer to the device config object. More...

protocol::base::Dispatcher< protocol::base::VectorVariant & >	m_dispatcher
	Dispatcher for managing subscription events. More...

protocol::base::Dispatcher	m_failure
	Dispatcher for managing failures in the communication. More...

protocol::base::Dispatcher	m_normal
	Dispatcher for managing recovery of communication failures. More...

int	m_state {}
	Actual controller state. More...

int	m_substate {}
	Actual controller substate. More...

bool	m_local {false}
	Actual local flag. More...

bool	m_error_code {false}
	Actual error code. More...

bool	m_config_loaded {false}
	Flag indicating whether the configuration was successfully loaded. More...

bool	m_connected {false}
	Flag indicating whether the LCS is connected. More...

fcf::devmgr::common::DataContext &	m_data_ctx

std::string	m_lcs_prefix
	Store the prefix for storing keys in the database. More...

std::unordered_map< std::string, short >	m_ua_status_map

std::vector< std::string >	m_ua_monitor_vector

std::unordered_map< short, std::string >	m_hw_errors

Detailed Description

Shutter Local Control System (LCS) Interface (IF) class.

This class manages the shutter connection to the LCS encapsulating all basic communication with the controller or the simulator.

Each RPC call is synchronous but it only starts the action in the controller. The controller will return successfully if the action can be started, not that the action was completed.

The completion of the action must be monitored by reading the status of the controller but this is out of the scope of this class.

Constructor & Destructor Documentation

◆ ShutterLcsIf()

fcf::devmgr::shutter::ShutterLcsIf::ShutterLcsIf	(	std::shared_ptr< fcf::devmgr::common::IDeviceConfig >	config,
		fcf::devmgr::common::DataContext &	data_ctx
	)

ShutterLcsIf constructor.

Parameters

[in,out]	config	Shared pointer to the device configuration.
[in,out]	data_ctx	Reference to the data context object.
[in]	initialise	Flag to control the initialization. This flag is used when using child classes.
[in]	with_publisher	Flag to be used in unit tests to avoid crash of CII.

◆ ~ShutterLcsIf()

virtual fcf::devmgr::shutter::ShutterLcsIf::~ShutterLcsIf ( )

virtualdefault

Default destructor.

Member Function Documentation

◆ Close()

void fcf::devmgr::shutter::ShutterLcsIf::Close ( )

Executes the Close RPC.

Exceptions

an	exception if an error ocurrs.

This RPC call shall bring the controller to Operational/Close state.

◆ GetRpcError()

std::string fcf::devmgr::shutter::ShutterLcsIf::GetRpcError ( const short error ) const

virtual

Parameters

error Error code

Returns: Associated error text to the passed error code.

Implements fcf::devmgr::common::DeviceLcsIf.

◆ InitObject()

void fcf::devmgr::shutter::ShutterLcsIf::InitObject ( )

virtual

Initialize object.

Exceptions

an	exception if an error ocurrs.

This method carries out basic object initialization. It is done in a separate method to allow overriden this functionality in children classes.

Reimplemented from fcf::devmgr::common::DeviceLcsIf.

◆ IsClose()

bool fcf::devmgr::shutter::ShutterLcsIf::IsClose ( ) const

Check if shutter is close.

◆ IsClosing()

bool fcf::devmgr::shutter::ShutterLcsIf::IsClosing ( ) const

Check if controller is closing the shutter.

Returns: true if condition is met, false otherwise.

◆ IsOpen()

bool fcf::devmgr::shutter::ShutterLcsIf::IsOpen ( ) const

Check if shutter is open.

◆ IsOpening()

bool fcf::devmgr::shutter::ShutterLcsIf::IsOpening ( ) const

Check if controller is opening the shutter.

Returns: true if condition is met, false otherwise.

◆ IsOperational()

bool fcf::devmgr::shutter::ShutterLcsIf::IsOperational ( ) const

virtual

Check if controller is in Operational.

Returns: true if condition is met, false otherwise.

Reimplemented from fcf::devmgr::common::DeviceLcsIf.

◆ IsReady()

bool fcf::devmgr::shutter::ShutterLcsIf::IsReady ( ) const

virtual

Check if controller is in Standby/Ready state.

Returns: true if condition is met, false otherwise.

Reimplemented from fcf::devmgr::common::DeviceLcsIf.

◆ Open()

void fcf::devmgr::shutter::ShutterLcsIf::Open ( )

Executes the Open RPC.

Exceptions

an	exception if an error ocurrs.

This RPC call shall bring the controller to Operational/Open state.

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

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

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ShutterLcsIf()

◆ ~ShutterLcsIf()

Member Function Documentation

◆ Close()

◆ GetRpcError()

◆ InitObject()

◆ IsClose()

◆ IsClosing()

◆ IsOpen()

◆ IsOpening()

◆ IsOperational()

◆ IsReady()

◆ Open()