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

#include <lampLcsIf.hpp>

Inheritance diagram for fcf::devmgr::lamp::LampLcsIf:

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

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

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

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

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

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

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

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

virtual void	Listener (protocol::base::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::actuator::ActuatorLcsIf
	ActuatorLcsIf (std::shared_ptr< fcf::devmgr::common::IDeviceConfig > config, fcf::devmgr::common::DataContext &data_ctx)
	actuatorLcsIf constructor. More...

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

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

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

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

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

bool	IsSwitchingOn () const noexcept
	Check if controller is switching the switch on. More...

bool	IsSwitchingOff () const noexcept
	Check if controller is switching the switch off. More...

bool	IsOn () const noexcept
	Check if switch is on. More...

bool	IsOff () const noexcept
	Check if switch is off. More...

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

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

Protected Attributes
double	m_intensity {}
	Actual intensity. More...

int	m_time_left {0}

int	m_analog_feedback {0}

bool	m_on_analog {false}

bool	m_on_digital {false}

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

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

Detailed Description

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()

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

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.
[in]	with_publisher	Flag to be used in unit tests to avoid crash of CII.

◆ ~LampLcsIf()

virtual fcf::devmgr::lamp::LampLcsIf::~LampLcsIf ( )

inlinevirtual

Default destructor.

Member Function Documentation

◆ GetRpcError()

std::string fcf::devmgr::lamp::LampLcsIf::GetRpcError ( const short error_code ) const

virtual

Parameters

error_code Error code

Returns: Associated error text to the passed error code.

Reimplemented from fcf::devmgr::actuator::ActuatorLcsIf.

◆ InitObject()

void fcf::devmgr::lamp::LampLcsIf::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::actuator::ActuatorLcsIf.

◆ IsNotReady()

bool fcf::devmgr::lamp::LampLcsIf::IsNotReady ( ) const

virtualnoexcept

Check if controller is in Standby/NotReady state.

Returns: true if condition is met, false otherwise.

Reimplemented from fcf::devmgr::actuator::ActuatorLcsIf.

◆ IsTurningOff()

bool fcf::devmgr::lamp::LampLcsIf::IsTurningOff ( ) const

noexcept

Check if controller is switching the lamp off.

Returns: true if condition is met, false otherwise.

◆ IsTurningOn()

bool fcf::devmgr::lamp::LampLcsIf::IsTurningOn ( ) const

noexcept

Check if controller is switching the lamp on.

Returns: true if condition is met, false otherwise.

◆ Listener()

void fcf::devmgr::lamp::LampLcsIf::Listener ( protocol::base::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.

Reimplemented from fcf::devmgr::actuator::ActuatorLcsIf.

◆ ReadStatus()

void fcf::devmgr::lamp::LampLcsIf::ReadStatus ( LampControllerData & 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.

◆ SwitchOn()

void fcf::devmgr::lamp::LampLcsIf::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_analog_feedback

int fcf::devmgr::lamp::LampLcsIf::m_analog_feedback {0}

protected

◆ m_intensity

double fcf::devmgr::lamp::LampLcsIf::m_intensity {}

protected

Actual intensity.

◆ m_on_analog

bool fcf::devmgr::lamp::LampLcsIf::m_on_analog {false}

protected

◆ m_on_digital

bool fcf::devmgr::lamp::LampLcsIf::m_on_digital {false}

protected

◆ m_time_left

int fcf::devmgr::lamp::LampLcsIf::m_time_left {0}

protected

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

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

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ LampLcsIf()

◆ ~LampLcsIf()

Member Function Documentation

◆ GetRpcError()

◆ InitObject()

◆ IsNotReady()

◆ IsTurningOff()

◆ IsTurningOn()

◆ Listener()

◆ ReadStatus()

◆ SwitchOn()

Member Data Documentation

◆ m_analog_feedback

◆ m_intensity

◆ m_on_analog

◆ m_on_digital

◆ m_time_left