ifw::fcf::devmgr Namespace Reference

actuatorLcsIf class header file. More...

Namespaces
namespace	actuator
	actuator class header file.
namespace	adc
	Adc class source file.
namespace	common
	ActionMgr class source file.
namespace	drot
	Drot class source file.
namespace	iodev
	IODev class header file.
namespace	lamp
	Lamp class header file.
namespace	matrk
	MAtrk class header file.
namespace	maxis
	MAxis class header file.
namespace	modulator
	Modulator class source file.
namespace	motor
	Motor class source file.
namespace	piezo
	Piezo class header file.
namespace	psu8600
	Psu8600 class header file.
namespace	shutter
	Shutter class source file.
namespace	smaract
	Motor class source file.

Functions
virtual bool	IsReady () const
	Check if controller is in Standby/Ready state.
virtual bool	IsOperational () const
	Check if controller is in Operational.
virtual std::string	GetRpcError (const short error_code) const

Variables
const std::unordered_map< short, std::string >	HW_ERRORS
class {
}	capitalize ()}}LcsIf(std {{cookiecutter.device_name|capitalize()}}LcsIf() = default
	{{cookiecutter.device_name|capitalize()}} Local Control System (LCS) Interface (IF) class
const std::unordered_map< short, std::string >	RPC_ERRORS

Detailed Description

actuatorLcsIf class header file.

Copyright

ESO - European Southern Observatory

Function Documentation

GetRpcError()

virtual std::string ifw::fcf::devmgr::GetRpcError ( const short error_code ) const

virtual

Parameters

error_code

Error code

Returns

Associated error text to the passed error code.

IsOperational()

virtual bool ifw::fcf::devmgr::IsOperational ( ) const

virtual

Check if controller is in Operational.

Returns

true if condition is met, false otherwise.

IsReady()

virtual bool ifw::fcf::devmgr::IsReady ( ) const

virtual

Check if controller is in Standby/Ready state.

Returns

true if condition is met, false otherwise.

Variable Documentation

[class]

class { ... } virtual ifw::fcf::devmgr::capitalize()}}LcsIf(std

{{cookiecutter.device_name|capitalize()}} Local Control System (LCS) Interface (IF) class

This class manages the {{cookiecutter.device_name|capitalize()}} 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.

{{cookiecutter.device_name}}LcsIf 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.

{{cookiecutter.device_name|capitalize()}} destructor

HW_ERRORS

const std::unordered_map<short, std::string> ifw::fcf::devmgr::HW_ERRORS

Initial value:

= {
      {HW_ERR_HW_NOT_OP,       "{{cookiecutter.device_name|capitalize()}} no in operational state"},
      {HW_ERR_WRONG_CMD,       "{{cookiecutter.device_name|capitalize()}} unknown command"},
      {HW_ERR_INCONSISTENT,    "{{cookiecutter.device_name|capitalize()}} inconsistent hardware signals"},
      {HW_ERR_INIT_FAILURE,    "{{cookiecutter.device_name|capitalize()}} init failure"},
      {HW_ERR_ENABLE_FAILURE,  "{{cookiecutter.device_name|capitalize()}} enable failure"},
      {HW_ERR_DISABLE_FAILURE, "{{cookiecutter.device_name|capitalize()}} disable failure"},
    }

RPC_ERRORS

const std::unordered_map<short, std::string> ifw::fcf::devmgr::RPC_ERRORS

Initial value:

= {
    {RPC_ERR_NOT_OP,               "Cannot disable {{cookiecutter.device_name|capitalize()}}. Not in OP state"},
    {RPC_ERR_NOT_OP_READY,    "Cannot enable {{cookiecutter.device_name|capitalize()}}. Not in NOT_OP_READY."},
    {RPC_ERR_NOT_OP_NOTREADY, "Cannot init {{cookiecutter.device_name|capitalize()}}. Not in NOT_OP_NOTREADY or FAILURE."}
  }