testDeviceFacade::MyDeviceLcsIf Class Reference

Inheritance diagram for testDeviceFacade::MyDeviceLcsIf:

Public Member Functions
	MyDeviceLcsIf (std::shared_ptr< devmgr::common::IDeviceConfig > config)
void	Init ()
	Check if controller is in Hardware Failure. More...
void	Enable ()
	Executes the Enable RPC. More...
void	Disable ()
	Executes the Disable RPC. More...
void	ReadConfig ()
	Read the configuration. More...
bool	IsReady ()
	Check if controller is in Standby/Ready state. More...
bool	IsNotReady ()
	Check if controller is in Standby/NotReady state. More...
bool	IsOperational ()
	Check if controller is in Operational. More...
bool	IsFailure ()
bool	IsHwFailure ()
	Check if controller is in Hardware Failure. More...
std::string	GetHwError (int &error_code, const bool update=false)
	Get error message. More...
void	StartMonitoring ()
	Start monitoring of controller attributes. More...
void	StopMonitoring ()
	Stop monitoring of controller attributes. More...
void	Listener (fcf::common::VectorVariant &params)
	Callback for listening controller events. More...
std::string	GetRpcError (short error_code) const
	Get associated message from the RPC error code. More...
std::string	GetError ()
Public Member Functions inherited from devmgr::common::DeviceLcsIf
	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 bool	IsDisabling ()
	Check if controller is in Disabling state. More...
virtual void	Stop ()
	Executes the Stop RPC. More...
virtual void	Reset ()
	Executes the Reset RPC. 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 bool	IsDisabling ()
	Check if controller is in Disabling state. More...
virtual void	Stop ()
	Executes the Stop RPC. More...
virtual void	Reset ()
	Executes the Reset RPC. 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 bool	IsDisabling ()
	Check if controller is in Disabling state. More...
virtual void	Stop ()
	Executes the Stop RPC. More...
virtual void	Reset ()
	Executes the Reset RPC. 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...

Public Attributes
bool	m_ready
bool	m_not_ready
bool	m_operational
bool	m_is_disabling

Additional Inherited Members
Protected Member Functions inherited from devmgr::common::DeviceLcsIf
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 inherited from devmgr::common::DeviceLcsIf
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...

Constructor & Destructor Documentation

testDeviceFacade::MyDeviceLcsIf::MyDeviceLcsIf ( std::shared_ptr< devmgr::common::IDeviceConfig >  config )

inline

Member Function Documentation

void testDeviceFacade::MyDeviceLcsIf::Disable ( )

inlinevirtual

Executes the Disable RPC.

Exceptions

an	exception if an error ocurrs.

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

Reimplemented from devmgr::common::DeviceLcsIf.

void testDeviceFacade::MyDeviceLcsIf::Enable ( )

inlinevirtual

Executes the Enable RPC.

Exceptions

an	exception if an error ocurrs.

This RPC call shall bring the controller to Operational state.

Reimplemented from devmgr::common::DeviceLcsIf.

std::string testDeviceFacade::MyDeviceLcsIf::GetError ( )

inline

std::string testDeviceFacade::MyDeviceLcsIf::GetHwError ( int &  error_code, const bool  update = false  )

inlinevirtual

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.

Implements devmgr::common::DeviceLcsIf.

std::string testDeviceFacade::MyDeviceLcsIf::GetRpcError ( short  error_code ) const

inlinevirtual

Get associated message from the RPC error code.

Parameters

[in]

error_code

Returns

string with the associated error message.

Implements devmgr::common::DeviceLcsIf.

void testDeviceFacade::MyDeviceLcsIf::Init ( )

inlinevirtual

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 from devmgr::common::DeviceLcsIf.

bool testDeviceFacade::MyDeviceLcsIf::IsFailure ( )

inline

bool testDeviceFacade::MyDeviceLcsIf::IsHwFailure ( )

inlinevirtual

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.

Implements devmgr::common::DeviceLcsIf.

bool testDeviceFacade::MyDeviceLcsIf::IsNotReady ( )

inlinevirtual

Check if controller is in Standby/NotReady state.

Returns

true if condition is met, false otherwise.

Reimplemented from devmgr::common::DeviceLcsIf.

bool testDeviceFacade::MyDeviceLcsIf::IsOperational ( )

inlinevirtual

Check if controller is in Operational.

Returns

true if condition is met, false otherwise.

Implements devmgr::common::DeviceLcsIf.

bool testDeviceFacade::MyDeviceLcsIf::IsReady ( )

inlinevirtual

Check if controller is in Standby/Ready state.

Returns

true if condition is met, false otherwise.

Implements devmgr::common::DeviceLcsIf.

void testDeviceFacade::MyDeviceLcsIf::Listener ( fcf::common::VectorVariant &  params )

inlinevirtual

Callback for listening controller events.

Parameters

params

list of paramaters to be monitored.

Abstract method to be implemented by specific classes.

Implements devmgr::common::DeviceLcsIf.

void testDeviceFacade::MyDeviceLcsIf::ReadConfig ( )

inlinevirtual

Read the configuration.

Exceptions

an	exception if an error ocurrs.

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

Implements devmgr::common::DeviceLcsIf.

void testDeviceFacade::MyDeviceLcsIf::StartMonitoring ( )

inlinevirtual

Start monitoring of controller attributes.

Exceptions

an	exception if an error ocurrs.

Abstract method to be implemented by specific classes.

Implements devmgr::common::DeviceLcsIf.

void testDeviceFacade::MyDeviceLcsIf::StopMonitoring ( )

inlinevirtual

Stop monitoring of controller attributes.

Exceptions

an	exception if an error ocurrs.

Abstract method to be implemented by specific classes.

Implements devmgr::common::DeviceLcsIf.

Member Data Documentation

bool testDeviceFacade::MyDeviceLcsIf::m_is_disabling

bool testDeviceFacade::MyDeviceLcsIf::m_not_ready

bool testDeviceFacade::MyDeviceLcsIf::m_operational

bool testDeviceFacade::MyDeviceLcsIf::m_ready

---

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

• fcf/devmgr/common/test/testDeviceFacade.cpp