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

#include <piezoLcsIf.hpp>

Inheritance diagram for fcf::devmgr::piezo::PiezoLcsIf:

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

virtual	~PiezoLcsIf ()=default
	Default destructor.

virtual void	InitObject ()
	Initialize object.

bool	IsInAuto () const
	Executes the Auto RPC.

bool	IsInPos () const
	Check if piezo is in POS state.

void	Auto ()

void	Home ()
	Executes the Home RPC.

void	Pos ()
	Executes the Pos RPC.

void	MoveBits (short bit1, short bit2, short bit3)
	Executes the MoveBits RPC.

void	MoveUser (double pos1, double pos2, double pos3)
	Executes the MoveUser RPC.

virtual void	ReadStatus (PiezoControllerData &status)
	Read status from the controller.

void	Listener (protocol::base::VectorVariant &params)
	Callback to manage changes on the monitored items.

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

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

virtual void	InitObject ()
	Initialize object.

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

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

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

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

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

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

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

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

virtual void	Init ()
	Executes the Init RPC.

virtual void	Enable ()
	Executes the Enable RPC.

virtual void	Disable ()
	Executes the Disable RPC.

virtual void	Stop ()
	Executes the Stop RPC.

virtual void	Reset ()
	Executes the Reset RPC.

virtual void	StartMonitoring ()
	Start monitoring of controller attributes.

virtual void	StopMonitoring ()
	Stop monitoring of controller attributes.

virtual void	ReadStatus (DeviceControllerData &status)
	ReadStatus.

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

virtual std::string	GetRpcError (const short error_code) const =0
	Get associated message from the RPC error code.

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

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

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

bool	IsConfigLoaded () const
	Check if configuration was loaded.

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

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

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

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

Protected Attributes
std::vector< int >	m_pos_bit {0,0,0}

std::vector< double >	m_pos_user {0.0, 0.0, 0.0}

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

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

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

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

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

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

int	m_state {}
	Actual controller state.

int	m_substate {}
	Actual controller substate.

bool	m_local {false}
	Actual local flag.

bool	m_error_code {false}
	Actual error code.

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

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

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

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

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

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.

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.

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

Detailed Description

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

This class manages the Piezo 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

◆ PiezoLcsIf()

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

piezoLcsIf 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.

◆ ~PiezoLcsIf()

virtual fcf::devmgr::piezo::PiezoLcsIf::~PiezoLcsIf ( )

virtualdefault

Default destructor.

Member Function Documentation

◆ Auto()

void fcf::devmgr::piezo::PiezoLcsIf::Auto ( )

◆ GetRpcError()

std::string fcf::devmgr::piezo::PiezoLcsIf::GetRpcError ( const short error_code ) const

virtual

Parameters

error_code Error code

Returns: Associated error text to the passed error code.

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

◆ Home()

void fcf::devmgr::piezo::PiezoLcsIf::Home ( )

Executes the Home RPC.

Exceptions

an	exception if an error ocurrs.

This RPC call shall bring the controller to HOME position.

◆ InitObject()

void fcf::devmgr::piezo::PiezoLcsIf::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.

◆ IsInAuto()

bool fcf::devmgr::piezo::PiezoLcsIf::IsInAuto ( ) const

Executes the Auto RPC.

Exceptions

an	exception if an error ocurrs.

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

Check if piezo is in AUTO state

◆ IsInPos()

bool fcf::devmgr::piezo::PiezoLcsIf::IsInPos ( ) const

Check if piezo is in POS state.

◆ Listener()

void fcf::devmgr::piezo::PiezoLcsIf::Listener ( protocol::base::VectorVariant & params )

virtual

Callback to manage changes on the monitored items.

Parameters

[in] params Vector containing the list of atributes that have changed

This method implement the actions associated to the events originated from the monitoring of attributes.

This method is storing in the database the values that have changed. It also publish the events for the clients via zeroMQ.

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

◆ MoveBits()

void fcf::devmgr::piezo::PiezoLcsIf::MoveBits	(	short	bit1,
		short	bit2,
		short	bit3
	)

Executes the MoveBits RPC.

Parameters

bit1	Bit parameter for axis 1.
bit2	Bit parameter for axis 2.
bit3	Bit parameter for axis 3.

Exceptions

an	exception if an error ocurrs.

This RPC call make the piezo moving in bits.

◆ MoveUser()

void fcf::devmgr::piezo::PiezoLcsIf::MoveUser	(	double	pos1,
		double	pos2,
		double	pos3
	)

Executes the MoveUser RPC.

Parameters

pos1	User position parameter for axis 1.
pos2	User position parameter for axis 2.
pos3	User position parameter for axis 3.

Exceptions

an	exception if an error ocurrs.

This RPC call make the piezo moving in user units.

◆ Pos()

void fcf::devmgr::piezo::PiezoLcsIf::Pos ( )

Executes the Pos RPC.

Exceptions

an	exception if an error ocurrs.

◆ ReadStatus()

void fcf::devmgr::piezo::PiezoLcsIf::ReadStatus ( PiezoControllerData & status )

virtual

Read status from the controller.

Parameters

status structure containing the status of the controller.

Warning: : The unpacking of the data shall follow the proper order or there is the risk of having an exception related to the boost conversion to variant.

Member Data Documentation

◆ m_pos_bit

std::vector<int> fcf::devmgr::piezo::PiezoLcsIf::m_pos_bit {0,0,0}

protected

◆ m_pos_user

std::vector<double> fcf::devmgr::piezo::PiezoLcsIf::m_pos_user {0.0, 0.0, 0.0}

protected

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

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

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ PiezoLcsIf()

◆ ~PiezoLcsIf()

Member Function Documentation

◆ Auto()

◆ GetRpcError()

◆ Home()

◆ InitObject()

◆ IsInAuto()

◆ IsInPos()

◆ Listener()

◆ MoveBits()

◆ MoveUser()

◆ Pos()

◆ ReadStatus()

Member Data Documentation

◆ m_pos_bit

◆ m_pos_user