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

#include <deviceLcsIf.hpp>

Inheritance diagram for devmgr::common::DeviceLcsIf:

Public Member Functions
	DeviceLcsIf (std::shared_ptr< IDeviceConfig > config)
	DeviceLcsIf construm_data_ctx.GetConfig().GetServerId() + ".". More...

virtual void	RegisterComm (std::shared_ptr< fcf::common::IComm > commIf, fcf::common::Dispatcher<> &failure, fcf::common::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 void	ReadConfig ()=0
	Read the configuration. More...

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

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

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

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

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

virtual void	Init ()
	Check if controller is in Hardware Failure. 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 ()=0
	Start monitoring of controller attributes. More...

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

virtual void	Listener (fcf::common::VectorVariant &params)=0
	Callback for listening controller events. More...

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

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

std::string	GetMapValue (std::string category, std::string key)
	Get mapping valLampConfigue. More...

fcf::common::Dispatcher < fcf::common::VectorVariant & > &	GetDispatcher ()

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

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

	DeviceLcsIf (std::shared_ptr< IDeviceConfig > config)
	DeviceLcsIf construm_data_ctx.GetConfig().GetServerId() + ".". More...

virtual void	RegisterComm (std::shared_ptr< fcf::common::IComm > commIf, fcf::common::Dispatcher<> &failure, fcf::common::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 void	ReadConfig ()=0
	Read the configuration. More...

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

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

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

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

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

virtual void	Init ()
	Check if controller is in Hardware Failure. 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 ()=0
	Start monitoring of controller attributes. More...

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

virtual void	Listener (fcf::common::VectorVariant &params)=0
	Callback for listening controller events. More...

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

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

std::string	GetMapValue (std::string category, std::string key)
	Get mapping valLampConfigue. More...

fcf::common::Dispatcher < fcf::common::VectorVariant & > &	GetDispatcher ()

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

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

	DeviceLcsIf (std::shared_ptr< IDeviceConfig > config)
	DeviceLcsIf construm_data_ctx.GetConfig().GetServerId() + ".". More...

virtual void	RegisterComm (std::shared_ptr< fcf::common::IComm > commIf, fcf::common::Dispatcher<> &failure, fcf::common::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 void	ReadConfig ()=0
	Read the configuration. More...

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

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

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

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

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

virtual void	Init ()
	Check if controller is in Hardware Failure. 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 ()=0
	Start monitoring of controller attributes. More...

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

virtual void	Listener (fcf::common::VectorVariant &params)=0
	Callback for listening controller events. More...

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

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

std::string	GetMapValue (std::string category, std::string key)
	Get mapping valLampConfigue. More...

fcf::common::Dispatcher < fcf::common::VectorVariant & > &	GetDispatcher ()

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

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

Protected Member Functions
void	LoadConfig ()
	Load the YAML configuration. More...

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

void	LoadConfig ()
	Load the YAML configuration. More...

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

void	LoadConfig ()
	Load the YAML configuration. More...

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

Protected Attributes
YAML::Node	m_config_node
	YAML node for the device mapping file. More...

std::shared_ptr < fcf::common::IComm >	m_comm
	Shared pointer to the communication object. More...

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

fcf::common::Dispatcher < fcf::common::VectorVariant & >	m_dispatcher
	Dispatcher for managing subscription events. More...

fcf::common::Dispatcher	m_failure
	Dispatcher for managing failures in the communication. More...

fcf::common::Dispatcher	m_normal
	Dispatcher for managing recovery of communication failures. More...

short	m_state
	Actual controller state. More...

short	m_substate
	Actual controller substate. More...

bool	m_config_loaded
	Flag indicating whether the configuration was succesfully loaded. More...

bool	m_connected
	Flag indicating whether the LCS is connected. More...

Detailed Description

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

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

The behaviour is specific to each device controller and shall be customized by a concrete device LCS_IF class.

Each RPC call is synchronous but it only starts the action in the controller. The controller will return succesfully 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 out of the scope of this class.

Constructor & Destructor Documentation

devmgr::common::DeviceLcsIf::DeviceLcsIf ( std::shared_ptr< IDeviceConfig > config )

explicit

DeviceLcsIf construm_data_ctx.GetConfig().GetServerId() + ".".

                  + m_config->GetName() + "." + DbControllerPrefix
                  + "." + m_lcs_if->GetMapValue(chd.second.GetCat(),
                                                chd.second.GetMap())ctor.

Parameters

config Shared pointer to the device configuration.

devmgr::common::DeviceLcsIf::DeviceLcsIf ( std::shared_ptr< IDeviceConfig > config )

explicit

DeviceLcsIf construm_data_ctx.GetConfig().GetServerId() + ".".

                  + m_config->GetName() + "." + DbControllerPrefix
                  + "." + m_lcs_if->GetMapValue(chd.second.GetCat(),
                                                chd.second.GetMap())ctor.

Parameters

config Shared pointer to the device configuration.

devmgr::common::DeviceLcsIf::DeviceLcsIf ( std::shared_ptr< IDeviceConfig > config )

explicit

DeviceLcsIf construm_data_ctx.GetConfig().GetServerId() + ".".

                  + m_config->GetName() + "." + DbControllerPrefix
                  + "." + m_lcs_if->GetMapValue(chd.second.GetCat(),
                                                chd.second.GetMap())ctor.

Parameters

config Shared pointer to the device configuration.

Member Function Documentation

void devmgr::common::DeviceLcsIf::Connect ( )

virtual

Connect to the controller or simulator.

Exceptions

an	exception if an error ocurrs.

This method uses the registered communication interface to establish the connection.

virtual void devmgr::common::DeviceLcsIf::Connect ( )

virtual

Connect to the controller or simulator.

Exceptions

an	exception if an error ocurrs.

This method uses the registered communication interface to establish the connection.

virtual void devmgr::common::DeviceLcsIf::Connect ( )

virtual

Connect to the controller or simulator.

Exceptions

an	exception if an error ocurrs.

This method uses the registered communication interface to establish the connection.

virtual void devmgr::common::DeviceLcsIf::Disable ( )

virtual

Executes the Disable RPC.

Exceptions

an	exception if an error ocurrs.

This RPC call shall bring the controller to Standby/Ready state.

Reimplemented in testDeviceFacade::MyDeviceLcsIf, and MyDeviceLcsIf.

void devmgr::common::DeviceLcsIf::Disable ( )

virtual

Executes the Disable RPC.

Exceptions

an	exception if an error ocurrs.

This RPC call shall bring the controller to Standby/Ready state.

Reimplemented in testDeviceFacade::MyDeviceLcsIf, and MyDeviceLcsIf.

virtual void devmgr::common::DeviceLcsIf::Disable ( )

virtual

Executes the Disable RPC.

Exceptions

an	exception if an error ocurrs.

This RPC call shall bring the controller to Standby/Ready state.

Reimplemented in testDeviceFacade::MyDeviceLcsIf, and MyDeviceLcsIf.

void devmgr::common::DeviceLcsIf::Disconnect ( )

virtual

Disconnect from the controller of simulator.

This method tries to disconnect from the controller or simulator. In case of error, the class will consider anyway the connection closed.

virtual void devmgr::common::DeviceLcsIf::Disconnect ( )

virtual

Disconnect from the controller of simulator.

This method tries to disconnect from the controller or simulator. In case of error, the class will consider anyway the connection closed.

virtual void devmgr::common::DeviceLcsIf::Disconnect ( )

virtual

Disconnect from the controller of simulator.

This method tries to disconnect from the controller or simulator. In case of error, the class will consider anyway the connection closed.

void devmgr::common::DeviceLcsIf::Enable ( )

virtual

Executes the Enable RPC.

Exceptions

an	exception if an error ocurrs.

This RPC call shall bring the controller to Operational state.

Reimplemented in testDeviceFacade::MyDeviceLcsIf, and MyDeviceLcsIf.

virtual void devmgr::common::DeviceLcsIf::Enable ( )

virtual

Executes the Enable RPC.

Exceptions

an	exception if an error ocurrs.

This RPC call shall bring the controller to Operational state.

Reimplemented in testDeviceFacade::MyDeviceLcsIf, and MyDeviceLcsIf.

virtual void devmgr::common::DeviceLcsIf::Enable ( )

virtual

Executes the Enable RPC.

Exceptions

an	exception if an error ocurrs.

This RPC call shall bring the controller to Operational state.

Reimplemented in testDeviceFacade::MyDeviceLcsIf, and MyDeviceLcsIf.

fcf::common::Dispatcher<fcf::common::VectorVariant&>& devmgr::common::DeviceLcsIf::GetDispatcher ( )

fcf::common::Dispatcher< fcf::common::VectorVariant & > & devmgr::common::DeviceLcsIf::GetDispatcher ( )

fcf::common::Dispatcher<fcf::common::VectorVariant&>& devmgr::common::DeviceLcsIf::GetDispatcher ( )

virtual std::string devmgr::common::DeviceLcsIf::GetHwError	(	int &	error_code,
		const bool	update = `false`
	)

pure virtual

Get error message.

Returns: error message associated to the error code read from the PLC.

This methods does a read to the PLC to obtain the error code.

Implemented in devmgr::motor::MotorLcsIf, devmgr::motor::MotorLcsIf, devmgr::motor::MotorLcsIf, devmgr::lamp::LampLcsIf, devmgr::lamp::LampLcsIf, devmgr::lamp::LampLcsIf, devmgr::shutter::ShutterLcsIf, devmgr::shutter::ShutterLcsIf, devmgr::shutter::ShutterLcsIf, devmgr::sensor::SensorLcsIf, devmgr::sensor::SensorLcsIf, devmgr::sensor::SensorLcsIf, testDeviceFacade::MyDeviceLcsIf, testDeviceLcsIf::MyDeviceLcsIf, and MyDeviceLcsIf.

virtual std::string devmgr::common::DeviceLcsIf::GetHwError	(	int &	error_code,
		const bool	update = `false`
	)

pure virtual

Get error message.

Returns: error message associated to the error code read from the PLC.

This methods does a read to the PLC to obtain the error code.

Implemented in devmgr::motor::MotorLcsIf, devmgr::motor::MotorLcsIf, devmgr::motor::MotorLcsIf, devmgr::lamp::LampLcsIf, devmgr::lamp::LampLcsIf, devmgr::lamp::LampLcsIf, devmgr::shutter::ShutterLcsIf, devmgr::shutter::ShutterLcsIf, devmgr::shutter::ShutterLcsIf, devmgr::sensor::SensorLcsIf, devmgr::sensor::SensorLcsIf, devmgr::sensor::SensorLcsIf, testDeviceFacade::MyDeviceLcsIf, testDeviceLcsIf::MyDeviceLcsIf, and MyDeviceLcsIf.

virtual std::string devmgr::common::DeviceLcsIf::GetHwError	(	int &	error_code,
		const bool	update = `false`
	)

pure virtual

Get error message.

Returns: error message associated to the error code read from the PLC.

This methods does a read to the PLC to obtain the error code.

Implemented in devmgr::motor::MotorLcsIf, devmgr::motor::MotorLcsIf, devmgr::motor::MotorLcsIf, devmgr::lamp::LampLcsIf, devmgr::lamp::LampLcsIf, devmgr::lamp::LampLcsIf, devmgr::shutter::ShutterLcsIf, devmgr::shutter::ShutterLcsIf, devmgr::shutter::ShutterLcsIf, devmgr::sensor::SensorLcsIf, devmgr::sensor::SensorLcsIf, devmgr::sensor::SensorLcsIf, testDeviceFacade::MyDeviceLcsIf, testDeviceLcsIf::MyDeviceLcsIf, and MyDeviceLcsIf.

std::string devmgr::common::DeviceLcsIf::GetMapValue	(	std::string	category,
		std::string	key
	)

Get mapping valLampConfigue.

Parameters

category	attribute category
key	attribute key

Returns: string contaning the mapping value

This method delivers the attribute name at the controller (mapping). This is obtained from the mapping file and based on the category and key given. This mapping string represents the OPCUA name in the address space of the device.

The mapping file is a generalization of the address space of a particular type of device.

std::string devmgr::common::DeviceLcsIf::GetMapValue	(	std::string	category,
		std::string	key
	)

Get mapping valLampConfigue.

Parameters

category	attribute category
key	attribute key

Returns: string contaning the mapping value

This method delivers the attribute name at the controller (mapping). This is obtained from the mapping file and based on the category and key given. This mapping string represents the OPCUA name in the address space of the device.

The mapping file is a generalization of the address space of a particular type of device.

std::string devmgr::common::DeviceLcsIf::GetMapValue	(	std::string	category,
		std::string	key
	)

Get mapping valLampConfigue.

Parameters

category	attribute category
key	attribute key

Returns: string contaning the mapping value

This method delivers the attribute name at the controller (mapping). This is obtained from the mapping file and based on the category and key given. This mapping string represents the OPCUA name in the address space of the device.

The mapping file is a generalization of the address space of a particular type of device.

virtual std::string devmgr::common::DeviceLcsIf::GetRpcError ( const short error_code ) const

pure virtual

Get associated message from the RPC error code.

Parameters

[in] error_code

Returns: string with the associated error message.

Implemented in devmgr::motor::MotorLcsIf, devmgr::motor::MotorLcsIf, devmgr::motor::MotorLcsIf, devmgr::lamp::LampLcsIf, devmgr::lamp::LampLcsIf, devmgr::lamp::LampLcsIf, devmgr::shutter::ShutterLcsIf, devmgr::shutter::ShutterLcsIf, devmgr::shutter::ShutterLcsIf, devmgr::sensor::SensorLcsIf, devmgr::sensor::SensorLcsIf, devmgr::sensor::SensorLcsIf, testDeviceFacade::MyDeviceLcsIf, MyDeviceLcsIf, and testDeviceLcsIf::MyDeviceLcsIf.

virtual std::string devmgr::common::DeviceLcsIf::GetRpcError ( const short error_code ) const

pure virtual

Get associated message from the RPC error code.

Parameters

[in] error_code

Returns: string with the associated error message.

Implemented in devmgr::motor::MotorLcsIf, devmgr::motor::MotorLcsIf, devmgr::motor::MotorLcsIf, devmgr::lamp::LampLcsIf, devmgr::lamp::LampLcsIf, devmgr::lamp::LampLcsIf, devmgr::shutter::ShutterLcsIf, devmgr::shutter::ShutterLcsIf, devmgr::shutter::ShutterLcsIf, devmgr::sensor::SensorLcsIf, devmgr::sensor::SensorLcsIf, devmgr::sensor::SensorLcsIf, testDeviceFacade::MyDeviceLcsIf, MyDeviceLcsIf, and testDeviceLcsIf::MyDeviceLcsIf.

virtual std::string devmgr::common::DeviceLcsIf::GetRpcError ( const short error_code ) const

pure virtual

Get associated message from the RPC error code.

Parameters

[in] error_code

Returns: string with the associated error message.

Implemented in devmgr::motor::MotorLcsIf, devmgr::motor::MotorLcsIf, devmgr::motor::MotorLcsIf, devmgr::lamp::LampLcsIf, devmgr::lamp::LampLcsIf, devmgr::lamp::LampLcsIf, devmgr::shutter::ShutterLcsIf, devmgr::shutter::ShutterLcsIf, devmgr::shutter::ShutterLcsIf, devmgr::sensor::SensorLcsIf, devmgr::sensor::SensorLcsIf, devmgr::sensor::SensorLcsIf, testDeviceFacade::MyDeviceLcsIf, MyDeviceLcsIf, and testDeviceLcsIf::MyDeviceLcsIf.

void devmgr::common::DeviceLcsIf::GetStates	(	short &	state,
		short &	substate
	)

protected

Get states (state and substate) of the controller.

Parameters

[in,out]	state	state of the controller
[in,out]	substate	substate of the controller

This is a generic method to read the state and substate attributes of the controller. The value of these attributes might be different depending of the device.

void devmgr::common::DeviceLcsIf::GetStates	(	short &	state,
		short &	substate
	)

protected

Get states (state and substate) of the controller.

Parameters

[in,out]	state	state of the controller
[in,out]	substate	substate of the controller

This is a generic method to read the state and substate attributes of the controller. The value of these attributes might be different depending of the device.

void devmgr::common::DeviceLcsIf::GetStates	(	short &	state,
		short &	substate
	)

protected

Get states (state and substate) of the controller.

Parameters

[in,out]	state	state of the controller
[in,out]	substate	substate of the controller

This is a generic method to read the state and substate attributes of the controller. The value of these attributes might be different depending of the device.

virtual void devmgr::common::DeviceLcsIf::Init ( )

virtual

Check if controller is in Hardware Failure.

Parameters

substate Substate value read from PLC.

Returns: true if condition is met, false otherwise.

Sometimes the controller may enter into a failure state triggerd by a hardware error. The controller will enter into a specific state to signal this condition. This method is checking if this condition is met.

This methods relies on the parameter substate to determine the status of the system. Executes the Init RPC

Exceptions

an	exception if an error ocurrs.

Reimplemented in testDeviceFacade::MyDeviceLcsIf, and MyDeviceLcsIf.

void devmgr::common::DeviceLcsIf::Init ( )

virtual

Check if controller is in Hardware Failure.

Parameters

substate Substate value read from PLC.

Returns: true if condition is met, false otherwise.

Sometimes the controller may enter into a failure state triggerd by a hardware error. The controller will enter into a specific state to signal this condition. This method is checking if this condition is met.

This methods relies on the parameter substate to determine the status of the system. Executes the Init RPC

Exceptions

an	exception if an error ocurrs.

Reimplemented in testDeviceFacade::MyDeviceLcsIf, and MyDeviceLcsIf.

virtual void devmgr::common::DeviceLcsIf::Init ( )

virtual

Check if controller is in Hardware Failure.

Parameters

substate Substate value read from PLC.

Returns: true if condition is met, false otherwise.

Sometimes the controller may enter into a failure state triggerd by a hardware error. The controller will enter into a specific state to signal this condition. This method is checking if this condition is met.

This methods relies on the parameter substate to determine the status of the system. Executes the Init RPC

Exceptions

an	exception if an error ocurrs.

Reimplemented in testDeviceFacade::MyDeviceLcsIf, and MyDeviceLcsIf.

bool devmgr::common::DeviceLcsIf::IsConfigLoaded ( ) const

Check if configuration was loaded.

Returns: true when configuration was loaded, false otherwise.

bool devmgr::common::DeviceLcsIf::IsConfigLoaded ( ) const

Check if configuration was loaded.

Returns: true when configuration was loaded, false otherwise.

bool devmgr::common::DeviceLcsIf::IsConfigLoaded ( ) const

Check if configuration was loaded.

Returns: true when configuration was loaded, false otherwise.

bool devmgr::common::DeviceLcsIf::IsConnected ( ) const

Check is the communication was established.

Returns: true when is connected, false otherwise.

bool devmgr::common::DeviceLcsIf::IsConnected ( ) const

Check is the communication was established.

Returns: true when is connected, false otherwise.

bool devmgr::common::DeviceLcsIf::IsConnected ( ) const

Check is the communication was established.

Returns: true when is connected, false otherwise.

bool devmgr::common::DeviceLcsIf::IsDisabling ( )

virtual

Check if controller is in Disabling state.

Returns: true if condit// System headersion is met, false otherwise.

This is method is needed when Enabling a device. Sometimes a device is still disabling from the previous action and device must wait before attempting to enable again.

Reimplemented in devmgr::motor::MotorLcsIf, devmgr::motor::MotorLcsIf, and devmgr::motor::MotorLcsIf.

virtual bool devmgr::common::DeviceLcsIf::IsDisabling ( )

virtual

Check if controller is in Disabling state.

Returns: true if condit// System headersion is met, false otherwise.

This is method is needed when Enabling a device. Sometimes a device is still disabling from the previous action and device must wait before attempting to enable again.

Reimplemented in devmgr::motor::MotorLcsIf, devmgr::motor::MotorLcsIf, and devmgr::motor::MotorLcsIf.

virtual bool devmgr::common::DeviceLcsIf::IsDisabling ( )

virtual

Check if controller is in Disabling state.

Returns: true if condit// System headersion is met, false otherwise.

This is method is needed when Enabling a device. Sometimes a device is still disabling from the previous action and device must wait before attempting to enable again.

Reimplemented in devmgr::motor::MotorLcsIf, devmgr::motor::MotorLcsIf, and devmgr::motor::MotorLcsIf.

virtual bool devmgr::common::DeviceLcsIf::IsHwFailure ( )

pure virtual

Check if controller is in Hardware Failure.

Returns: true if condition is met, false otherwise.

Sometimes the controller may enter into a failure state triggerd by a hardware error. The controller will enter into a specific state to signal this condition. This method is checking if this condition is met.

This method reads the substate attribute from the PLC.

Implemented in devmgr::motor::MotorLcsIf, devmgr::motor::MotorLcsIf, devmgr::motor::MotorLcsIf, devmgr::lamp::LampLcsIf, devmgr::lamp::LampLcsIf, devmgr::lamp::LampLcsIf, devmgr::shutter::ShutterLcsIf, devmgr::shutter::ShutterLcsIf, devmgr::shutter::ShutterLcsIf, devmgr::sensor::SensorLcsIf, devmgr::sensor::SensorLcsIf, devmgr::sensor::SensorLcsIf, testDeviceFacade::MyDeviceLcsIf, MyDeviceLcsIf, and testDeviceLcsIf::MyDeviceLcsIf.

virtual bool devmgr::common::DeviceLcsIf::IsHwFailure ( )

pure virtual

Check if controller is in Hardware Failure.

Returns: true if condition is met, false otherwise.

Sometimes the controller may enter into a failure state triggerd by a hardware error. The controller will enter into a specific state to signal this condition. This method is checking if this condition is met.

This method reads the substate attribute from the PLC.

Implemented in devmgr::motor::MotorLcsIf, devmgr::motor::MotorLcsIf, devmgr::motor::MotorLcsIf, devmgr::lamp::LampLcsIf, devmgr::lamp::LampLcsIf, devmgr::lamp::LampLcsIf, devmgr::shutter::ShutterLcsIf, devmgr::shutter::ShutterLcsIf, devmgr::shutter::ShutterLcsIf, devmgr::sensor::SensorLcsIf, devmgr::sensor::SensorLcsIf, devmgr::sensor::SensorLcsIf, testDeviceFacade::MyDeviceLcsIf, MyDeviceLcsIf, and testDeviceLcsIf::MyDeviceLcsIf.

virtual bool devmgr::common::DeviceLcsIf::IsHwFailure ( )

pure virtual

Check if controller is in Hardware Failure.

Returns: true if condition is met, false otherwise.

Sometimes the controller may enter into a failure state triggerd by a hardware error. The controller will enter into a specific state to signal this condition. This method is checking if this condition is met.

This method reads the substate attribute from the PLC.

Implemented in devmgr::motor::MotorLcsIf, devmgr::motor::MotorLcsIf, devmgr::motor::MotorLcsIf, devmgr::lamp::LampLcsIf, devmgr::lamp::LampLcsIf, devmgr::lamp::LampLcsIf, devmgr::shutter::ShutterLcsIf, devmgr::shutter::ShutterLcsIf, devmgr::shutter::ShutterLcsIf, devmgr::sensor::SensorLcsIf, devmgr::sensor::SensorLcsIf, devmgr::sensor::SensorLcsIf, testDeviceFacade::MyDeviceLcsIf, MyDeviceLcsIf, and testDeviceLcsIf::MyDeviceLcsIf.

bool devmgr::common::DeviceLcsIf::IsNotReady ( )

virtual

Check if controller is in Standby/NotReady state.

Returns: true if condition is met, false otherwise.

Reimplemented in devmgr::motor::MotorLcsIf, devmgr::motor::MotorLcsIf, devmgr::motor::MotorLcsIf, and testDeviceFacade::MyDeviceLcsIf.

virtual bool devmgr::common::DeviceLcsIf::IsNotReady ( )

virtual

Check if controller is in Standby/NotReady state.

Returns: true if condition is met, false otherwise.

Reimplemented in devmgr::motor::MotorLcsIf, devmgr::motor::MotorLcsIf, devmgr::motor::MotorLcsIf, and testDeviceFacade::MyDeviceLcsIf.

virtual bool devmgr::common::DeviceLcsIf::IsNotReady ( )

virtual

Check if controller is in Standby/NotReady state.

Returns: true if condition is met, false otherwise.

Reimplemented in devmgr::motor::MotorLcsIf, devmgr::motor::MotorLcsIf, devmgr::motor::MotorLcsIf, and testDeviceFacade::MyDeviceLcsIf.

virtual bool devmgr::common::DeviceLcsIf::IsOperational ( )

pure virtual

Check if controller is in Operational.

Returns: true if condition is met, false otherwise.

Implemented in devmgr::motor::MotorLcsIf, devmgr::motor::MotorLcsIf, devmgr::motor::MotorLcsIf, devmgr::sensor::SensorLcsIf, devmgr::sensor::SensorLcsIf, devmgr::sensor::SensorLcsIf, testDeviceFacade::MyDeviceLcsIf, devmgr::shutter::ShutterLcsIf, devmgr::shutter::ShutterLcsIf, devmgr::shutter::ShutterLcsIf, devmgr::lamp::LampLcsIf, devmgr::lamp::LampLcsIf, devmgr::lamp::LampLcsIf, MyDeviceLcsIf, and testDeviceLcsIf::MyDeviceLcsIf.

virtual bool devmgr::common::DeviceLcsIf::IsOperational ( )

pure virtual

Check if controller is in Operational.

Returns: true if condition is met, false otherwise.

Implemented in devmgr::motor::MotorLcsIf, devmgr::motor::MotorLcsIf, devmgr::motor::MotorLcsIf, devmgr::sensor::SensorLcsIf, devmgr::sensor::SensorLcsIf, devmgr::sensor::SensorLcsIf, testDeviceFacade::MyDeviceLcsIf, devmgr::shutter::ShutterLcsIf, devmgr::shutter::ShutterLcsIf, devmgr::shutter::ShutterLcsIf, devmgr::lamp::LampLcsIf, devmgr::lamp::LampLcsIf, devmgr::lamp::LampLcsIf, MyDeviceLcsIf, and testDeviceLcsIf::MyDeviceLcsIf.

virtual bool devmgr::common::DeviceLcsIf::IsOperational ( )

pure virtual

Check if controller is in Operational.

Returns: true if condition is met, false otherwise.

Implemented in devmgr::motor::MotorLcsIf, devmgr::motor::MotorLcsIf, devmgr::motor::MotorLcsIf, devmgr::sensor::SensorLcsIf, devmgr::sensor::SensorLcsIf, devmgr::sensor::SensorLcsIf, testDeviceFacade::MyDeviceLcsIf, devmgr::shutter::ShutterLcsIf, devmgr::shutter::ShutterLcsIf, devmgr::shutter::ShutterLcsIf, devmgr::lamp::LampLcsIf, devmgr::lamp::LampLcsIf, devmgr::lamp::LampLcsIf, MyDeviceLcsIf, and testDeviceLcsIf::MyDeviceLcsIf.

virtual bool devmgr::common::DeviceLcsIf::IsReady ( )

pure virtual

Check if controller is in Standby/Ready state.

Returns: true if condition is met, false otherwise.

Implemented in devmgr::motor::MotorLcsIf, devmgr::motor::MotorLcsIf, devmgr::motor::MotorLcsIf, devmgr::sensor::SensorLcsIf, devmgr::sensor::SensorLcsIf, devmgr::sensor::SensorLcsIf, testDeviceFacade::MyDeviceLcsIf, devmgr::shutter::ShutterLcsIf, devmgr::shutter::ShutterLcsIf, devmgr::shutter::ShutterLcsIf, devmgr::lamp::LampLcsIf, devmgr::lamp::LampLcsIf, devmgr::lamp::LampLcsIf, MyDeviceLcsIf, and testDeviceLcsIf::MyDeviceLcsIf.

virtual bool devmgr::common::DeviceLcsIf::IsReady ( )

pure virtual

Check if controller is in Standby/Ready state.

Returns: true if condition is met, false otherwise.

Implemented in devmgr::motor::MotorLcsIf, devmgr::motor::MotorLcsIf, devmgr::motor::MotorLcsIf, devmgr::sensor::SensorLcsIf, devmgr::sensor::SensorLcsIf, devmgr::sensor::SensorLcsIf, testDeviceFacade::MyDeviceLcsIf, devmgr::shutter::ShutterLcsIf, devmgr::shutter::ShutterLcsIf, devmgr::shutter::ShutterLcsIf, devmgr::lamp::LampLcsIf, devmgr::lamp::LampLcsIf, devmgr::lamp::LampLcsIf, MyDeviceLcsIf, and testDeviceLcsIf::MyDeviceLcsIf.

virtual bool devmgr::common::DeviceLcsIf::IsReady ( )

pure virtual

Check if controller is in Standby/Ready state.

Returns: true if condition is met, false otherwise.

Implemented in devmgr::motor::MotorLcsIf, devmgr::motor::MotorLcsIf, devmgr::motor::MotorLcsIf, devmgr::sensor::SensorLcsIf, devmgr::sensor::SensorLcsIf, devmgr::sensor::SensorLcsIf, testDeviceFacade::MyDeviceLcsIf, devmgr::shutter::ShutterLcsIf, devmgr::shutter::ShutterLcsIf, devmgr::shutter::ShutterLcsIf, devmgr::lamp::LampLcsIf, devmgr::lamp::LampLcsIf, devmgr::lamp::LampLcsIf, MyDeviceLcsIf, and testDeviceLcsIf::MyDeviceLcsIf.

virtual void devmgr::common::DeviceLcsIf::Listener ( fcf::common::VectorVariant & params )

pure virtual

Callback for listening controller events.

Parameters

params list of paramaters to be monitored.

Abstract method to be implemented by specific classes.

Implemented in devmgr::motor::MotorLcsIf, devmgr::motor::MotorLcsIf, devmgr::motor::MotorLcsIf, devmgr::lamp::LampLcsIf, devmgr::lamp::LampLcsIf, devmgr::lamp::LampLcsIf, devmgr::shutter::ShutterLcsIf, devmgr::shutter::ShutterLcsIf, devmgr::shutter::ShutterLcsIf, devmgr::sensor::SensorLcsIf, devmgr::sensor::SensorLcsIf, devmgr::sensor::SensorLcsIf, testDeviceFacade::MyDeviceLcsIf, MyDeviceLcsIf, and testDeviceLcsIf::MyDeviceLcsIf.

virtual void devmgr::common::DeviceLcsIf::Listener ( fcf::common::VectorVariant & params )

pure virtual

Callback for listening controller events.

Parameters

params list of paramaters to be monitored.

Abstract method to be implemented by specific classes.

Implemented in devmgr::motor::MotorLcsIf, devmgr::motor::MotorLcsIf, devmgr::motor::MotorLcsIf, devmgr::lamp::LampLcsIf, devmgr::lamp::LampLcsIf, devmgr::lamp::LampLcsIf, devmgr::shutter::ShutterLcsIf, devmgr::shutter::ShutterLcsIf, devmgr::shutter::ShutterLcsIf, devmgr::sensor::SensorLcsIf, devmgr::sensor::SensorLcsIf, devmgr::sensor::SensorLcsIf, testDeviceFacade::MyDeviceLcsIf, MyDeviceLcsIf, and testDeviceLcsIf::MyDeviceLcsIf.

virtual void devmgr::common::DeviceLcsIf::Listener ( fcf::common::VectorVariant & params )

pure virtual

Callback for listening controller events.

Parameters

params list of paramaters to be monitored.

Abstract method to be implemented by specific classes.

Implemented in devmgr::motor::MotorLcsIf, devmgr::motor::MotorLcsIf, devmgr::motor::MotorLcsIf, devmgr::lamp::LampLcsIf, devmgr::lamp::LampLcsIf, devmgr::lamp::LampLcsIf, devmgr::shutter::ShutterLcsIf, devmgr::shutter::ShutterLcsIf, devmgr::shutter::ShutterLcsIf, devmgr::sensor::SensorLcsIf, devmgr::sensor::SensorLcsIf, devmgr::sensor::SensorLcsIf, testDeviceFacade::MyDeviceLcsIf, MyDeviceLcsIf, and testDeviceLcsIf::MyDeviceLcsIf.

void devmgr::common::DeviceLcsIf::LoadConfig ( )

protected

Load the YAML configuration.

Exceptions

rad::Exception in case of error

void devmgr::common::DeviceLcsIf::LoadConfig ( )

protected

Load the YAML configuration.

Exceptions

rad::Exception in case of error

void devmgr::common::DeviceLcsIf::LoadConfig ( )

protected

Load the YAML configuration.

Exceptions

rad::Exception in case of error

virtual void devmgr::common::DeviceLcsIf::ReadConfig ( )

pure virtual

Read the configuration.

Exceptions

an	exception if an error ocurrs.

This is an abstract method that need to be implemented by concrete device classes.

Implemented in devmgr::motor::MotorLcsIf, devmgr::motor::MotorLcsIf, devmgr::motor::MotorLcsIf, devmgr::sensor::SensorLcsIf, devmgr::sensor::SensorLcsIf, devmgr::sensor::SensorLcsIf, devmgr::lamp::LampLcsIf, devmgr::lamp::LampLcsIf, devmgr::lamp::LampLcsIf, testDeviceFacade::MyDeviceLcsIf, devmgr::shutter::ShutterLcsIf, devmgr::shutter::ShutterLcsIf, devmgr::shutter::ShutterLcsIf, MyDeviceLcsIf, and testDeviceLcsIf::MyDeviceLcsIf.

virtual void devmgr::common::DeviceLcsIf::ReadConfig ( )

pure virtual

Read the configuration.

Exceptions

an	exception if an error ocurrs.

This is an abstract method that need to be implemented by concrete device classes.

Implemented in devmgr::motor::MotorLcsIf, devmgr::motor::MotorLcsIf, devmgr::motor::MotorLcsIf, devmgr::sensor::SensorLcsIf, devmgr::sensor::SensorLcsIf, devmgr::sensor::SensorLcsIf, devmgr::lamp::LampLcsIf, devmgr::lamp::LampLcsIf, devmgr::lamp::LampLcsIf, testDeviceFacade::MyDeviceLcsIf, devmgr::shutter::ShutterLcsIf, devmgr::shutter::ShutterLcsIf, devmgr::shutter::ShutterLcsIf, MyDeviceLcsIf, and testDeviceLcsIf::MyDeviceLcsIf.

virtual void devmgr::common::DeviceLcsIf::ReadConfig ( )

pure virtual

Read the configuration.

Exceptions

an	exception if an error ocurrs.

This is an abstract method that need to be implemented by concrete device classes.

Implemented in devmgr::motor::MotorLcsIf, devmgr::motor::MotorLcsIf, devmgr::motor::MotorLcsIf, devmgr::sensor::SensorLcsIf, devmgr::sensor::SensorLcsIf, devmgr::sensor::SensorLcsIf, devmgr::lamp::LampLcsIf, devmgr::lamp::LampLcsIf, devmgr::lamp::LampLcsIf, testDeviceFacade::MyDeviceLcsIf, devmgr::shutter::ShutterLcsIf, devmgr::shutter::ShutterLcsIf, devmgr::shutter::ShutterLcsIf, MyDeviceLcsIf, and testDeviceLcsIf::MyDeviceLcsIf.

virtual void devmgr::common::DeviceLcsIf::RegisterComm	(	std::shared_ptr< fcf::common::IComm >	commIf,
		fcf::common::Dispatcher<> &	failure,
		fcf::common::Dispatcher<> &	normal
	)

virtual

Register a communication interface.

Parameters

commIf	shared pointer to the communication interface
failure	dispatcher for failure events
normal	dispatcher for recovering failure events

The communication object have to be created before using this class and registered using this method.

The constructor create a callback for the internal dispatcher and loads the configuration.

void devmgr::common::DeviceLcsIf::RegisterComm	(	std::shared_ptr< fcf::common::IComm >	commIf,
		fcf::common::Dispatcher<> &	failure,
		fcf::common::Dispatcher<> &	normal
	)

virtual

Register a communication interface.

Parameters

commIf	shared pointer to the communication interface
failure	dispatcher for failure events
normal	dispatcher for recovering failure events

The communication object have to be created before using this class and registered using this method.

The constructor create a callback for the internal dispatcher and loads the configuration.

virtual void devmgr::common::DeviceLcsIf::RegisterComm	(	std::shared_ptr< fcf::common::IComm >	commIf,
		fcf::common::Dispatcher<> &	failure,
		fcf::common::Dispatcher<> &	normal
	)

virtual

Register a communication interface.

Parameters

commIf	shared pointer to the communication interface
failure	dispatcher for failure events
normal	dispatcher for recovering failure events

The communication object have to be created before using this class and registered using this method.

The constructor create a callback for the internal dispatcher and loads the configuration.

virtual void devmgr::common::DeviceLcsIf::Reset ( )

virtual

Executes the Reset RPC.

Exceptions

an	exception if an error ocurrs.

This RPC call shall bring the controller to Standby/NotReady state.

void devmgr::common::DeviceLcsIf::Reset ( )

virtual

Executes the Reset RPC.

Exceptions

an	exception if an error ocurrs.

This RPC call shall bring the controller to Standby/NotReady state.

virtual void devmgr::common::DeviceLcsIf::Reset ( )

virtual

Executes the Reset RPC.

Exceptions

an	exception if an error ocurrs.

This RPC call shall bring the controller to Standby/NotReady state.

virtual void devmgr::common::DeviceLcsIf::StartMonitoring ( )

pure virtual

Start monitoring of controller attributes.

Exceptions

an	exception if an error ocurrs.

Abstract method to be implemented by specific classes.

Implemented in devmgr::motor::MotorLcsIf, devmgr::motor::MotorLcsIf, devmgr::motor::MotorLcsIf, devmgr::lamp::LampLcsIf, devmgr::lamp::LampLcsIf, devmgr::lamp::LampLcsIf, devmgr::shutter::ShutterLcsIf, devmgr::shutter::ShutterLcsIf, devmgr::shutter::ShutterLcsIf, devmgr::sensor::SensorLcsIf, devmgr::sensor::SensorLcsIf, devmgr::sensor::SensorLcsIf, testDeviceFacade::MyDeviceLcsIf, MyDeviceLcsIf, and testDeviceLcsIf::MyDeviceLcsIf.

virtual void devmgr::common::DeviceLcsIf::StartMonitoring ( )

pure virtual

Start monitoring of controller attributes.

Exceptions

an	exception if an error ocurrs.

Abstract method to be implemented by specific classes.

Implemented in devmgr::motor::MotorLcsIf, devmgr::motor::MotorLcsIf, devmgr::motor::MotorLcsIf, devmgr::lamp::LampLcsIf, devmgr::lamp::LampLcsIf, devmgr::lamp::LampLcsIf, devmgr::shutter::ShutterLcsIf, devmgr::shutter::ShutterLcsIf, devmgr::shutter::ShutterLcsIf, devmgr::sensor::SensorLcsIf, devmgr::sensor::SensorLcsIf, devmgr::sensor::SensorLcsIf, testDeviceFacade::MyDeviceLcsIf, MyDeviceLcsIf, and testDeviceLcsIf::MyDeviceLcsIf.

virtual void devmgr::common::DeviceLcsIf::StartMonitoring ( )

pure virtual

Start monitoring of controller attributes.

Exceptions

an	exception if an error ocurrs.

Abstract method to be implemented by specific classes.

Implemented in devmgr::motor::MotorLcsIf, devmgr::motor::MotorLcsIf, devmgr::motor::MotorLcsIf, devmgr::lamp::LampLcsIf, devmgr::lamp::LampLcsIf, devmgr::lamp::LampLcsIf, devmgr::shutter::ShutterLcsIf, devmgr::shutter::ShutterLcsIf, devmgr::shutter::ShutterLcsIf, devmgr::sensor::SensorLcsIf, devmgr::sensor::SensorLcsIf, devmgr::sensor::SensorLcsIf, testDeviceFacade::MyDeviceLcsIf, MyDeviceLcsIf, and testDeviceLcsIf::MyDeviceLcsIf.

void devmgr::common::DeviceLcsIf::Stop ( )

virtual

Executes the Stop RPC.

Exceptions

an	exception if an error ocurrs.

This RPC call stop any ongoing action of the controller.

The specific behaviour will depend on the controller.

virtual void devmgr::common::DeviceLcsIf::Stop ( )

virtual

Executes the Stop RPC.

Exceptions

an	exception if an error ocurrs.

This RPC call stop any ongoing action of the controller.

The specific behaviour will depend on the controller.

virtual void devmgr::common::DeviceLcsIf::Stop ( )

virtual

Executes the Stop RPC.

Exceptions

an	exception if an error ocurrs.

This RPC call stop any ongoing action of the controller.

The specific behaviour will depend on the controller.

virtual void devmgr::common::DeviceLcsIf::StopMonitoring ( )

pure virtual

Stop monitoring of controller attributes.

Exceptions

an	exception if an error ocurrs.

Abstract method to be implemented by specific classes.

Implemented in devmgr::motor::MotorLcsIf, devmgr::motor::MotorLcsIf, devmgr::motor::MotorLcsIf, devmgr::lamp::LampLcsIf, devmgr::lamp::LampLcsIf, devmgr::lamp::LampLcsIf, devmgr::shutter::ShutterLcsIf, devmgr::shutter::ShutterLcsIf, devmgr::shutter::ShutterLcsIf, devmgr::sensor::SensorLcsIf, devmgr::sensor::SensorLcsIf, devmgr::sensor::SensorLcsIf, testDeviceFacade::MyDeviceLcsIf, MyDeviceLcsIf, and testDeviceLcsIf::MyDeviceLcsIf.

virtual void devmgr::common::DeviceLcsIf::StopMonitoring ( )

pure virtual

Stop monitoring of controller attributes.

Exceptions

an	exception if an error ocurrs.

Abstract method to be implemented by specific classes.

Implemented in devmgr::motor::MotorLcsIf, devmgr::motor::MotorLcsIf, devmgr::motor::MotorLcsIf, devmgr::lamp::LampLcsIf, devmgr::lamp::LampLcsIf, devmgr::lamp::LampLcsIf, devmgr::shutter::ShutterLcsIf, devmgr::shutter::ShutterLcsIf, devmgr::shutter::ShutterLcsIf, devmgr::sensor::SensorLcsIf, devmgr::sensor::SensorLcsIf, devmgr::sensor::SensorLcsIf, testDeviceFacade::MyDeviceLcsIf, MyDeviceLcsIf, and testDeviceLcsIf::MyDeviceLcsIf.

virtual void devmgr::common::DeviceLcsIf::StopMonitoring ( )

pure virtual

Stop monitoring of controller attributes.

Exceptions

an	exception if an error ocurrs.

Abstract method to be implemented by specific classes.

Implemented in devmgr::motor::MotorLcsIf, devmgr::motor::MotorLcsIf, devmgr::motor::MotorLcsIf, devmgr::lamp::LampLcsIf, devmgr::lamp::LampLcsIf, devmgr::lamp::LampLcsIf, devmgr::shutter::ShutterLcsIf, devmgr::shutter::ShutterLcsIf, devmgr::shutter::ShutterLcsIf, devmgr::sensor::SensorLcsIf, devmgr::sensor::SensorLcsIf, devmgr::sensor::SensorLcsIf, testDeviceFacade::MyDeviceLcsIf, MyDeviceLcsIf, and testDeviceLcsIf::MyDeviceLcsIf.

Member Data Documentation

std::shared_ptr< fcf::common::IComm > devmgr::common::DeviceLcsIf::m_comm

protected

Shared pointer to the communication object.

std::shared_ptr< IDeviceConfig > devmgr::common::DeviceLcsIf::m_config

protected

Shared pointer to the device config object.

bool devmgr::common::DeviceLcsIf::m_config_loaded

protected

Flag indicating whether the configuration was succesfully loaded.

YAML::Node devmgr::common::DeviceLcsIf::m_config_node

protected

YAML node for the device mapping file.

bool devmgr::common::DeviceLcsIf::m_connected

protected

Flag indicating whether the LCS is connected.

fcf::common::Dispatcher< fcf::common::VectorVariant & > devmgr::common::DeviceLcsIf::m_dispatcher

protected

Dispatcher for managing subscription events.

fcf::common::Dispatcher devmgr::common::DeviceLcsIf::m_failure

protected

Dispatcher for managing failures in the communication.

fcf::common::Dispatcher devmgr::common::DeviceLcsIf::m_normal

protected

Dispatcher for managing recovery of communication failures.

short devmgr::common::DeviceLcsIf::m_state

protected

Actual controller state.

short devmgr::common::DeviceLcsIf::m_substate

protected

Actual controller substate.

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

fcf/devmgr/common/src/include/devmgr/common/deviceLcsIf.hpp
INTROOT/include/devmgr/common/deviceLcsIf.hpp
INTROOT/sources/fcf/devmgr/common/src/include/devmgr/common/deviceLcsIf.hpp
fcf/devmgr/common/src/deviceLcsIf.cpp
INTROOT/sources/fcf/devmgr/common/src/deviceLcsIf.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation