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

#include <lampLcsIf.hpp>

Inheritance diagram for fcf::devmgr::lamp::LampLcsIf< TOPIC_TYPE >:

Public Member Functions
	LampLcsIf (std::shared_ptr< fcf::devmgr::common::IDeviceConfig > config, fcf::devmgr::common::DataContext &data_ctx, bool initialise=true)
	LampLcsIf constructor. More...

virtual	~LampLcsIf ()
	Default destructor. More...

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

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

void	SwitchOn (double intensity, unsigned int time)
	Executes the SwitchOn RPC. More...

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

bool	IsTurningOn ()
	Check if controller is switching the lamp on. More...

bool	IsTurningOff ()
	Check if controller is switching the lamp off. More...

bool	IsOn ()
	Check if lamp is on. More...

bool	IsOff ()
	Check if lamp is off. More...

virtual void	ReadStatus (LampControllerData &status, bool force_read=true)
	Read status from the controller. More...

void	Listener (fcf::common::VectorVariant &params)
	Callback to manageUpdateStatus(); changes on the monitored items. More...

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

virtual void	RegisterComm (std::shared_ptr< fcf::common::IComm > comm_if, 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 (const std::vector< std::string > &stat_map_vector, const std::vector< std::string > &rpc_map_vector)
	Read the configuration. More...

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

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

virtual bool	IsHwFailure ()
	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 std::string	GetHwError (int &error_code, const bool update=false)
	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...

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

Protected Attributes
std::unique_ptr< rad::cii::Publisher< TOPIC_TYPE > >	m_publisher

double	m_intensity {}
	Actual intensity. More...

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

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

elt::mal::Mal::Properties	m_mal_properties

std::string	m_pub_endpoint

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

void	ExecuteRpc (const std::string &obj, const std::string &proc, fcf::common::VectorVariant &attr_list)

int	ReadErrorCode ()

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

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

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

Detailed Description

template<typename TOPIC_TYPE = fcfif::LampTopicUnion>
class fcf::devmgr::lamp::LampLcsIf< TOPIC_TYPE >

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

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

◆ LampLcsIf()

template<typename TOPIC_TYPE = fcfif::LampTopicUnion>

fcf::devmgr::lamp::LampLcsIf< TOPIC_TYPE >::LampLcsIf	(	std::shared_ptr< fcf::devmgr::common::IDeviceConfig >	config,
		fcf::devmgr::common::DataContext &	data_ctx,
		bool	initialise = `true`
	)

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

◆ ~LampLcsIf()

template<typename TOPIC_TYPE = fcfif::LampTopicUnion>

virtual fcf::devmgr::lamp::LampLcsIf< TOPIC_TYPE >::~LampLcsIf ( )

inlinevirtual

Default destructor.

Member Function Documentation

◆ GetRpcError()

template<typename TOPIC_TYPE = fcfif::LampTopicUnion>

virtual std::string fcf::devmgr::lamp::LampLcsIf< TOPIC_TYPE >::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.

◆ IsOff()

template<typename TOPIC_TYPE = fcfif::LampTopicUnion>

bool fcf::devmgr::lamp::LampLcsIf< TOPIC_TYPE >::IsOff ( )

Check if lamp is off.

◆ IsOn()

template<typename TOPIC_TYPE = fcfif::LampTopicUnion>

bool fcf::devmgr::lamp::LampLcsIf< TOPIC_TYPE >::IsOn ( )

Check if lamp is on.

◆ IsOperational()

template<typename TOPIC_TYPE = fcfif::LampTopicUnion>

virtual bool fcf::devmgr::lamp::LampLcsIf< TOPIC_TYPE >::IsOperational ( )

virtual

Check if controller is in Operational.

Returns: true if condition is met, false otherwise.

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

◆ IsReady()

template<typename TOPIC_TYPE = fcfif::LampTopicUnion>

virtual bool fcf::devmgr::lamp::LampLcsIf< TOPIC_TYPE >::IsReady ( )

virtual

Check if controller is in Standby/Ready state.

Returns: true if condition is met, false otherwise.

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

◆ IsTurningOff()

template<typename TOPIC_TYPE = fcfif::LampTopicUnion>

bool fcf::devmgr::lamp::LampLcsIf< TOPIC_TYPE >::IsTurningOff ( )

Check if controller is switching the lamp off.

Returns: true if condition is met, false otherwise.

◆ IsTurningOn()

template<typename TOPIC_TYPE = fcfif::LampTopicUnion>

bool fcf::devmgr::lamp::LampLcsIf< TOPIC_TYPE >::IsTurningOn ( )

Check if controller is switching the lamp on.

Returns: true if condition is met, false otherwise.

◆ Listener()

template<typename TOPIC_TYPE = fcfif::LampTopicUnion>

void fcf::devmgr::lamp::LampLcsIf< TOPIC_TYPE >::Listener ( fcf::common::VectorVariant & params )

virtual

Callback to manageUpdateStatus(); 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.

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

◆ ReadStatus()

template<typename TOPIC_TYPE = fcfif::LampTopicUnion>

virtual void fcf::devmgr::lamp::LampLcsIf< TOPIC_TYPE >::ReadStatus	(	LampControllerData &	status,
		bool	force_read = `true`
	)

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.

◆ SwitchOff()

template<typename TOPIC_TYPE = fcfif::LampTopicUnion>

void fcf::devmgr::lamp::LampLcsIf< TOPIC_TYPE >::SwitchOff ( )

Executes the SwitchOff RPC.

Exceptions

an	exception if an error ocurrs.

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

◆ SwitchOn()

template<typename TOPIC_TYPE = fcfif::LampTopicUnion>

void fcf::devmgr::lamp::LampLcsIf< TOPIC_TYPE >::SwitchOn	(	double	intensity,
		unsigned int	time
	)

Executes the SwitchOn RPC.

Exceptions

an	exception if an error ocurrs.

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

Member Data Documentation

◆ m_intensity

template<typename TOPIC_TYPE = fcfif::LampTopicUnion>

double fcf::devmgr::lamp::LampLcsIf< TOPIC_TYPE >::m_intensity {}

protected

Actual intensity.

◆ m_publisher

template<typename TOPIC_TYPE = fcfif::LampTopicUnion>

std::unique_ptr<rad::cii::Publisher<TOPIC_TYPE> > fcf::devmgr::lamp::LampLcsIf< TOPIC_TYPE >::m_publisher

protected

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

devmgr/devices/src/include/fcf/devmgr/devices/lampLcsIf.hpp

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

template<typename TOPIC_TYPE = fcfif::LampTopicUnion> class fcf::devmgr::lamp::LampLcsIf< TOPIC_TYPE >

Constructor & Destructor Documentation

◆ LampLcsIf()

◆ ~LampLcsIf()

Member Function Documentation

◆ GetRpcError()

◆ IsOff()

◆ IsOn()

◆ IsOperational()

◆ IsReady()

◆ IsTurningOff()

◆ IsTurningOn()

◆ Listener()

◆ ReadStatus()

◆ SwitchOff()

◆ SwitchOn()

Member Data Documentation

◆ m_intensity

◆ m_publisher

template<typename TOPIC_TYPE = fcfif::LampTopicUnion>
class fcf::devmgr::lamp::LampLcsIf< TOPIC_TYPE >