ifw  0.0.1-dev
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | List of all members
devmgr::common::IDevice Class Referenceabstract

#include <iDevice.hpp>

Inheritance diagram for devmgr::common::IDevice:
devmgr::common::Device devmgr::common::Device devmgr::common::Device MockIDevice devmgr::lamp::Lamp devmgr::lamp::Lamp devmgr::lamp::Lamp devmgr::motor::Motor devmgr::motor::Motor devmgr::motor::Motor devmgr::sensor::Sensor devmgr::sensor::Sensor devmgr::sensor::Sensor devmgr::shutter::Shutter devmgr::shutter::Shutter devmgr::shutter::Shutter testDeviceFacade::TestFailureDevice testDeviceFacade::TestMyDevice TestMyDevice TestShutter devmgr::lamp::Lamp devmgr::lamp::Lamp devmgr::lamp::Lamp devmgr::motor::Motor devmgr::motor::Motor devmgr::motor::Motor devmgr::sensor::Sensor devmgr::sensor::Sensor devmgr::sensor::Sensor devmgr::shutter::Shutter devmgr::shutter::Shutter devmgr::shutter::Shutter testDeviceFacade::TestFailureDevice testDeviceFacade::TestMyDevice TestMyDevice TestShutter devmgr::lamp::Lamp devmgr::lamp::Lamp devmgr::lamp::Lamp devmgr::motor::Motor devmgr::motor::Motor devmgr::motor::Motor devmgr::sensor::Sensor devmgr::sensor::Sensor devmgr::sensor::Sensor devmgr::shutter::Shutter devmgr::shutter::Shutter devmgr::shutter::Shutter testDeviceFacade::TestFailureDevice testDeviceFacade::TestMyDevice TestMyDevice TestShutter

Public Member Functions

virtual void CreateObjects (std::shared_ptr< devmgr::common::IDeviceConfig > config=nullptr)=0
 Create basic objects needed by the device class. More...
 
virtual void RegisterComm (std::shared_ptr< fcf::common::IComm > comm_if, fcf::common::Dispatcher<> &failure, fcf::common::Dispatcher<> &normal)=0
 Register a communication interface object. More...
 
virtual bool IsNotReady () const =0
 Check if device is Standby/NotReady. More...
 
virtual bool IsReady () const =0
 Check if device is Standby/Ready. More...
 
virtual bool IsOperational () const =0
 Check if device is Operational. More...
 
virtual void CheckHwFailure () const =0
 Check if device is in failure state. More...
 
virtual bool IsDisabling () const =0
 Check if device is disablig. More...
 
virtual void Init ()=0
 Executes a Init command. More...
 
virtual void Enable ()=0
 Executes a Enable command. More...
 
virtual void Disable ()=0
 Executes a Disable command. More...
 
virtual void Stop ()=0
 Executes a Stop command. More...
 
virtual void Reset ()=0
 Executes a Reset command. More...
 
virtual void HwReset (modif::ReqHwReset &hwResetMsg)=0
 Executes a hardware reset command. More...
 
virtual void HwInit (modif::ReqHwInit &hwInitMsg)=0
 Executes a hardware init command. More...
 
virtual void HwEnable (modif::ReqHwEnable &hwEnableMsg)=0
 Executes a hardware enable command. More...
 
virtual void HwDisable (modif::ReqHwDisable &hwDisableMsg)=0
 Executes a hardware disable command. More...
 
virtual void UpdateStatus ()=0
 Update internal status by connecting to the LCS. More...
 
virtual void Setup (const modif::ReqSetup &setupMsg)=0
 Executes a setup. More...
 
virtual bool IsSetupActive (const modif::ReqSetup &setupMsg) const =0
 Check if setup is still active. More...
 
virtual void Status (const modif::ReqStatus &statusMsg, std::string &buffer)=0
 Obtain the status of the device. More...
 
virtual void Status (bool end_acq, const dit::did::Did &dictionary, CCfits::FITS *fits_handle=nullptr)=0
 Obtain the status of the device. More...
 
virtual void Simulate (const modif::ReqSimulate &msg)=0
 Executes a Simulat. More...
 
virtual void StopSim (const modif::ReqStopSim &msg)=0
 Executes a StopSim. More...
 
virtual void Ignore (const modif::ReqIgnore &msg)=0
 Executes a Ignore. More...
 
virtual void StopIgn (const modif::ReqStopIgn &msg)=0
 Executes a StopIgn. More...
 
virtual std::shared_ptr
< DeviceLcsIf
GetLcsIf () const =0
 Get a pointer of device LCS interface. More...
 
virtual std::shared_ptr
< IDeviceConfig
GetConfig () const =0
 Get a pointer of device configuration. More...
 
virtual void StartMonitoring ()=0
 Start device monitoring via OPCUA subscriptions. More...
 
virtual void StopMonitoring ()=0
 Stop device monitoring. More...
 
virtual std::string GetName () const =0
 Get device name. More...
 
virtual void CreateObjects (std::shared_ptr< devmgr::common::IDeviceConfig > config=nullptr)=0
 Create basic objects needed by the device class. More...
 
virtual void RegisterComm (std::shared_ptr< fcf::common::IComm > comm_if, fcf::common::Dispatcher<> &failure, fcf::common::Dispatcher<> &normal)=0
 Register a communication interface object. More...
 
virtual bool IsNotReady () const =0
 Check if device is Standby/NotReady. More...
 
virtual bool IsReady () const =0
 Check if device is Standby/Ready. More...
 
virtual bool IsOperational () const =0
 Check if device is Operational. More...
 
virtual void CheckHwFailure () const =0
 Check if device is in failure state. More...
 
virtual bool IsDisabling () const =0
 Check if device is disablig. More...
 
virtual void Init ()=0
 Executes a Init command. More...
 
virtual void Enable ()=0
 Executes a Enable command. More...
 
virtual void Disable ()=0
 Executes a Disable command. More...
 
virtual void Stop ()=0
 Executes a Stop command. More...
 
virtual void Reset ()=0
 Executes a Reset command. More...
 
virtual void HwReset (modif::ReqHwReset &hwResetMsg)=0
 Executes a hardware reset command. More...
 
virtual void HwInit (modif::ReqHwInit &hwInitMsg)=0
 Executes a hardware init command. More...
 
virtual void HwEnable (modif::ReqHwEnable &hwEnableMsg)=0
 Executes a hardware enable command. More...
 
virtual void HwDisable (modif::ReqHwDisable &hwDisableMsg)=0
 Executes a hardware disable command. More...
 
virtual void UpdateStatus ()=0
 Update internal status by connecting to the LCS. More...
 
virtual void Setup (const modif::ReqSetup &setupMsg)=0
 Executes a setup. More...
 
virtual bool IsSetupActive (const modif::ReqSetup &setupMsg) const =0
 Check if setup is still active. More...
 
virtual void Status (const modif::ReqStatus &statusMsg, std::string &buffer)=0
 Obtain the status of the device. More...
 
virtual void Status (bool end_acq, const dit::did::Did &dictionary, CCfits::FITS *fits_handle=nullptr)=0
 Obtain the status of the device. More...
 
virtual void Simulate (const modif::ReqSimulate &msg)=0
 Executes a Simulat. More...
 
virtual void StopSim (const modif::ReqStopSim &msg)=0
 Executes a StopSim. More...
 
virtual void Ignore (const modif::ReqIgnore &msg)=0
 Executes a Ignore. More...
 
virtual void StopIgn (const modif::ReqStopIgn &msg)=0
 Executes a StopIgn. More...
 
virtual std::shared_ptr
< DeviceLcsIf
GetLcsIf () const =0
 Get a pointer of device LCS interface. More...
 
virtual std::shared_ptr
< IDeviceConfig
GetConfig () const =0
 Get a pointer of device configuration. More...
 
virtual void StartMonitoring ()=0
 Start device monitoring via OPCUA subscriptions. More...
 
virtual void StopMonitoring ()=0
 Stop device monitoring. More...
 
virtual std::string GetName () const =0
 Get device name. More...
 
virtual void CreateObjects (std::shared_ptr< devmgr::common::IDeviceConfig > config=nullptr)=0
 Create basic objects needed by the device class. More...
 
virtual void RegisterComm (std::shared_ptr< fcf::common::IComm > comm_if, fcf::common::Dispatcher<> &failure, fcf::common::Dispatcher<> &normal)=0
 Register a communication interface object. More...
 
virtual bool IsNotReady () const =0
 Check if device is Standby/NotReady. More...
 
virtual bool IsReady () const =0
 Check if device is Standby/Ready. More...
 
virtual bool IsOperational () const =0
 Check if device is Operational. More...
 
virtual void CheckHwFailure () const =0
 Check if device is in failure state. More...
 
virtual bool IsDisabling () const =0
 Check if device is disablig. More...
 
virtual void Init ()=0
 Executes a Init command. More...
 
virtual void Enable ()=0
 Executes a Enable command. More...
 
virtual void Disable ()=0
 Executes a Disable command. More...
 
virtual void Stop ()=0
 Executes a Stop command. More...
 
virtual void Reset ()=0
 Executes a Reset command. More...
 
virtual void HwReset (modif::ReqHwReset &hwResetMsg)=0
 Executes a hardware reset command. More...
 
virtual void HwInit (modif::ReqHwInit &hwInitMsg)=0
 Executes a hardware init command. More...
 
virtual void HwEnable (modif::ReqHwEnable &hwEnableMsg)=0
 Executes a hardware enable command. More...
 
virtual void HwDisable (modif::ReqHwDisable &hwDisableMsg)=0
 Executes a hardware disable command. More...
 
virtual void UpdateStatus ()=0
 Update internal status by connecting to the LCS. More...
 
virtual void Setup (const modif::ReqSetup &setupMsg)=0
 Executes a setup. More...
 
virtual bool IsSetupActive (const modif::ReqSetup &setupMsg) const =0
 Check if setup is still active. More...
 
virtual void Status (const modif::ReqStatus &statusMsg, std::string &buffer)=0
 Obtain the status of the device. More...
 
virtual void Status (bool end_acq, const dit::did::Did &dictionary, CCfits::FITS *fits_handle=nullptr)=0
 Obtain the status of the device. More...
 
virtual void Simulate (const modif::ReqSimulate &msg)=0
 Executes a Simulat. More...
 
virtual void StopSim (const modif::ReqStopSim &msg)=0
 Executes a StopSim. More...
 
virtual void Ignore (const modif::ReqIgnore &msg)=0
 Executes a Ignore. More...
 
virtual void StopIgn (const modif::ReqStopIgn &msg)=0
 Executes a StopIgn. More...
 
virtual std::shared_ptr
< DeviceLcsIf
GetLcsIf () const =0
 Get a pointer of device LCS interface. More...
 
virtual std::shared_ptr
< IDeviceConfig
GetConfig () const =0
 Get a pointer of device configuration. More...
 
virtual void StartMonitoring ()=0
 Start device monitoring via OPCUA subscriptions. More...
 
virtual void StopMonitoring ()=0
 Stop device monitoring. More...
 
virtual std::string GetName () const =0
 Get device name. More...
 

Detailed Description

Device abstract class. This class represents the basic implementation of a device class. Most of the device share common properties and behavioural aspects. This class is implementing the common behaviour and defining the basic properties, as well as declaring the abstracts methods that need to be implemented by derived classes.

Member Function Documentation

virtual void devmgr::common::IDevice::CheckHwFailure ( ) const
pure virtual

Check if device is in failure state.

Exceptions
anexception if an error ocurrs.

Implemented in TestMyDevice, devmgr::common::Device, devmgr::common::Device, and devmgr::common::Device.

virtual void devmgr::common::IDevice::CheckHwFailure ( ) const
pure virtual

Check if device is in failure state.

Exceptions
anexception if an error ocurrs.

Implemented in TestMyDevice, devmgr::common::Device, devmgr::common::Device, and devmgr::common::Device.

virtual void devmgr::common::IDevice::CheckHwFailure ( ) const
pure virtual

Check if device is in failure state.

Exceptions
anexception if an error ocurrs.

Implemented in TestMyDevice, devmgr::common::Device, devmgr::common::Device, and devmgr::common::Device.

virtual void devmgr::common::IDevice::CreateObjects ( std::shared_ptr< devmgr::common::IDeviceConfig config = nullptr)
pure virtual

Create basic objects needed by the device class.

Parameters
configShared pointer to configuration object
virtual void devmgr::common::IDevice::CreateObjects ( std::shared_ptr< devmgr::common::IDeviceConfig config = nullptr)
pure virtual

Create basic objects needed by the device class.

Parameters
configShared pointer to configuration object
virtual void devmgr::common::IDevice::CreateObjects ( std::shared_ptr< devmgr::common::IDeviceConfig config = nullptr)
pure virtual

Create basic objects needed by the device class.

Parameters
configShared pointer to configuration object
virtual void devmgr::common::IDevice::Disable ( )
pure virtual

Executes a Disable command.

Exceptions
anexception if an error ocurrs.

Implemented in testDeviceFacade::TestFailureDevice, testDeviceFacade::TestMyDevice, devmgr::common::Device, devmgr::common::Device, and devmgr::common::Device.

virtual void devmgr::common::IDevice::Disable ( )
pure virtual

Executes a Disable command.

Exceptions
anexception if an error ocurrs.

Implemented in testDeviceFacade::TestFailureDevice, testDeviceFacade::TestMyDevice, devmgr::common::Device, devmgr::common::Device, and devmgr::common::Device.

virtual void devmgr::common::IDevice::Disable ( )
pure virtual

Executes a Disable command.

Exceptions
anexception if an error ocurrs.

Implemented in testDeviceFacade::TestFailureDevice, testDeviceFacade::TestMyDevice, devmgr::common::Device, devmgr::common::Device, and devmgr::common::Device.

virtual void devmgr::common::IDevice::Enable ( )
pure virtual

Executes a Enable command.

Exceptions
anexception if an error ocurrs.

Implemented in testDeviceFacade::TestFailureDevice, testDeviceFacade::TestMyDevice, devmgr::common::Device, devmgr::common::Device, and devmgr::common::Device.

virtual void devmgr::common::IDevice::Enable ( )
pure virtual

Executes a Enable command.

Exceptions
anexception if an error ocurrs.

Implemented in testDeviceFacade::TestFailureDevice, testDeviceFacade::TestMyDevice, devmgr::common::Device, devmgr::common::Device, and devmgr::common::Device.

virtual void devmgr::common::IDevice::Enable ( )
pure virtual

Executes a Enable command.

Exceptions
anexception if an error ocurrs.

Implemented in testDeviceFacade::TestFailureDevice, testDeviceFacade::TestMyDevice, devmgr::common::Device, devmgr::common::Device, and devmgr::common::Device.

virtual std::shared_ptr<IDeviceConfig> devmgr::common::IDevice::GetConfig ( ) const
pure virtual
virtual std::shared_ptr<IDeviceConfig> devmgr::common::IDevice::GetConfig ( ) const
pure virtual
virtual std::shared_ptr<IDeviceConfig> devmgr::common::IDevice::GetConfig ( ) const
pure virtual
virtual std::shared_ptr<DeviceLcsIf> devmgr::common::IDevice::GetLcsIf ( ) const
pure virtual
virtual std::shared_ptr<DeviceLcsIf> devmgr::common::IDevice::GetLcsIf ( ) const
pure virtual
virtual std::shared_ptr<DeviceLcsIf> devmgr::common::IDevice::GetLcsIf ( ) const
pure virtual
virtual std::string devmgr::common::IDevice::GetName ( ) const
pure virtual
virtual std::string devmgr::common::IDevice::GetName ( ) const
pure virtual
virtual std::string devmgr::common::IDevice::GetName ( ) const
pure virtual
virtual void devmgr::common::IDevice::HwDisable ( modif::ReqHwDisable hwDisableMsg)
pure virtual

Executes a hardware disable command.

Parameters
[in]hwDisableMsgpayload of the hw disable message
Exceptions
anexception if an error ocurrs.

Implemented in devmgr::common::Device, devmgr::common::Device, and devmgr::common::Device.

virtual void devmgr::common::IDevice::HwDisable ( modif::ReqHwDisable hwDisableMsg)
pure virtual

Executes a hardware disable command.

Parameters
[in]hwDisableMsgpayload of the hw disable message
Exceptions
anexception if an error ocurrs.

Implemented in devmgr::common::Device, devmgr::common::Device, and devmgr::common::Device.

virtual void devmgr::common::IDevice::HwDisable ( modif::ReqHwDisable hwDisableMsg)
pure virtual

Executes a hardware disable command.

Parameters
[in]hwDisableMsgpayload of the hw disable message
Exceptions
anexception if an error ocurrs.

Implemented in devmgr::common::Device, devmgr::common::Device, and devmgr::common::Device.

virtual void devmgr::common::IDevice::HwEnable ( modif::ReqHwEnable hwEnableMsg)
pure virtual

Executes a hardware enable command.

Parameters
[in]hwEnableMsgpayload of the hw enable message
Exceptions
anexception if an error ocurrs.

Implemented in devmgr::common::Device, devmgr::common::Device, and devmgr::common::Device.

virtual void devmgr::common::IDevice::HwEnable ( modif::ReqHwEnable hwEnableMsg)
pure virtual

Executes a hardware enable command.

Parameters
[in]hwEnableMsgpayload of the hw enable message
Exceptions
anexception if an error ocurrs.

Implemented in devmgr::common::Device, devmgr::common::Device, and devmgr::common::Device.

virtual void devmgr::common::IDevice::HwEnable ( modif::ReqHwEnable hwEnableMsg)
pure virtual

Executes a hardware enable command.

Parameters
[in]hwEnableMsgpayload of the hw enable message
Exceptions
anexception if an error ocurrs.

Implemented in devmgr::common::Device, devmgr::common::Device, and devmgr::common::Device.

virtual void devmgr::common::IDevice::HwInit ( modif::ReqHwInit hwInitMsg)
pure virtual

Executes a hardware init command.

Parameters
[in]hwInitMsgpayload of the hw init message
Exceptions
anexception if an error ocurrs.

Implemented in devmgr::common::Device, devmgr::common::Device, and devmgr::common::Device.

virtual void devmgr::common::IDevice::HwInit ( modif::ReqHwInit hwInitMsg)
pure virtual

Executes a hardware init command.

Parameters
[in]hwInitMsgpayload of the hw init message
Exceptions
anexception if an error ocurrs.

Implemented in devmgr::common::Device, devmgr::common::Device, and devmgr::common::Device.

virtual void devmgr::common::IDevice::HwInit ( modif::ReqHwInit hwInitMsg)
pure virtual

Executes a hardware init command.

Parameters
[in]hwInitMsgpayload of the hw init message
Exceptions
anexception if an error ocurrs.

Implemented in devmgr::common::Device, devmgr::common::Device, and devmgr::common::Device.

virtual void devmgr::common::IDevice::HwReset ( modif::ReqHwReset hwResetMsg)
pure virtual

Executes a hardware reset command.

Parameters
[in]hwResetMsgpayload of the hw reset message
Exceptions
anexception if an error ocurrs.

Implemented in devmgr::common::Device, devmgr::common::Device, and devmgr::common::Device.

virtual void devmgr::common::IDevice::HwReset ( modif::ReqHwReset hwResetMsg)
pure virtual

Executes a hardware reset command.

Parameters
[in]hwResetMsgpayload of the hw reset message
Exceptions
anexception if an error ocurrs.

Implemented in devmgr::common::Device, devmgr::common::Device, and devmgr::common::Device.

virtual void devmgr::common::IDevice::HwReset ( modif::ReqHwReset hwResetMsg)
pure virtual

Executes a hardware reset command.

Parameters
[in]hwResetMsgpayload of the hw reset message
Exceptions
anexception if an error ocurrs.

Implemented in devmgr::common::Device, devmgr::common::Device, and devmgr::common::Device.

virtual void devmgr::common::IDevice::Ignore ( const modif::ReqIgnore msg)
pure virtual

Executes a Ignore.

Parameters
[in]msgcontains the payload of the Ignore message.
Exceptions
anexception if an error ocurrs.

Implemented in devmgr::common::Device, devmgr::common::Device, and devmgr::common::Device.

virtual void devmgr::common::IDevice::Ignore ( const modif::ReqIgnore msg)
pure virtual

Executes a Ignore.

Parameters
[in]msgcontains the payload of the Ignore message.
Exceptions
anexception if an error ocurrs.

Implemented in devmgr::common::Device, devmgr::common::Device, and devmgr::common::Device.

virtual void devmgr::common::IDevice::Ignore ( const modif::ReqIgnore msg)
pure virtual

Executes a Ignore.

Parameters
[in]msgcontains the payload of the Ignore message.
Exceptions
anexception if an error ocurrs.

Implemented in devmgr::common::Device, devmgr::common::Device, and devmgr::common::Device.

virtual void devmgr::common::IDevice::Init ( )
pure virtual

Executes a Init command.

Exceptions
anexception if an error ocurrs.

Implemented in testDeviceFacade::TestFailureDevice, testDeviceFacade::TestMyDevice, devmgr::common::Device, devmgr::common::Device, and devmgr::common::Device.

virtual void devmgr::common::IDevice::Init ( )
pure virtual

Executes a Init command.

Exceptions
anexception if an error ocurrs.

Implemented in testDeviceFacade::TestFailureDevice, testDeviceFacade::TestMyDevice, devmgr::common::Device, devmgr::common::Device, and devmgr::common::Device.

virtual void devmgr::common::IDevice::Init ( )
pure virtual

Executes a Init command.

Exceptions
anexception if an error ocurrs.

Implemented in testDeviceFacade::TestFailureDevice, testDeviceFacade::TestMyDevice, devmgr::common::Device, devmgr::common::Device, and devmgr::common::Device.

virtual bool devmgr::common::IDevice::IsDisabling ( ) const
pure virtual

Check if device is disablig.

Returns
true if device is disabling, false otherwise

Implemented in testDeviceFacade::TestMyDevice, TestMyDevice, devmgr::common::Device, devmgr::common::Device, devmgr::common::Device, devmgr::sensor::Sensor, devmgr::sensor::Sensor, and devmgr::sensor::Sensor.

virtual bool devmgr::common::IDevice::IsDisabling ( ) const
pure virtual

Check if device is disablig.

Returns
true if device is disabling, false otherwise

Implemented in testDeviceFacade::TestMyDevice, TestMyDevice, devmgr::common::Device, devmgr::common::Device, devmgr::common::Device, devmgr::sensor::Sensor, devmgr::sensor::Sensor, and devmgr::sensor::Sensor.

virtual bool devmgr::common::IDevice::IsDisabling ( ) const
pure virtual

Check if device is disablig.

Returns
true if device is disabling, false otherwise

Implemented in testDeviceFacade::TestMyDevice, TestMyDevice, devmgr::common::Device, devmgr::common::Device, devmgr::common::Device, devmgr::sensor::Sensor, devmgr::sensor::Sensor, and devmgr::sensor::Sensor.

virtual bool devmgr::common::IDevice::IsNotReady ( ) const
pure virtual
virtual bool devmgr::common::IDevice::IsNotReady ( ) const
pure virtual
virtual bool devmgr::common::IDevice::IsNotReady ( ) const
pure virtual
virtual bool devmgr::common::IDevice::IsOperational ( ) const
pure virtual

Check if device is Operational.

Returns
true is device is Operational, false otherwise

Implemented in devmgr::common::Device, devmgr::common::Device, and devmgr::common::Device.

virtual bool devmgr::common::IDevice::IsOperational ( ) const
pure virtual

Check if device is Operational.

Returns
true is device is Operational, false otherwise

Implemented in devmgr::common::Device, devmgr::common::Device, and devmgr::common::Device.

virtual bool devmgr::common::IDevice::IsOperational ( ) const
pure virtual

Check if device is Operational.

Returns
true is device is Operational, false otherwise

Implemented in devmgr::common::Device, devmgr::common::Device, and devmgr::common::Device.

virtual bool devmgr::common::IDevice::IsReady ( ) const
pure virtual

Check if device is Standby/Ready.

Returns
true is device is Standby/Ready, false otherwise

Implemented in testDeviceFacade::TestFailureDevice, testDeviceFacade::TestMyDevice, TestMyDevice, devmgr::common::Device, devmgr::common::Device, and devmgr::common::Device.

virtual bool devmgr::common::IDevice::IsReady ( ) const
pure virtual

Check if device is Standby/Ready.

Returns
true is device is Standby/Ready, false otherwise

Implemented in testDeviceFacade::TestFailureDevice, testDeviceFacade::TestMyDevice, TestMyDevice, devmgr::common::Device, devmgr::common::Device, and devmgr::common::Device.

virtual bool devmgr::common::IDevice::IsReady ( ) const
pure virtual

Check if device is Standby/Ready.

Returns
true is device is Standby/Ready, false otherwise

Implemented in testDeviceFacade::TestFailureDevice, testDeviceFacade::TestMyDevice, TestMyDevice, devmgr::common::Device, devmgr::common::Device, and devmgr::common::Device.

virtual bool devmgr::common::IDevice::IsSetupActive ( const modif::ReqSetup setupMsg) const
pure virtual
virtual bool devmgr::common::IDevice::IsSetupActive ( const modif::ReqSetup setupMsg) const
pure virtual
virtual bool devmgr::common::IDevice::IsSetupActive ( const modif::ReqSetup setupMsg) const
pure virtual
virtual void devmgr::common::IDevice::RegisterComm ( std::shared_ptr< fcf::common::IComm >  comm_if,
fcf::common::Dispatcher<> &  failure,
fcf::common::Dispatcher<> &  normal 
)
pure virtual

Register a communication interface object.

Parameters
[in]comm_ifshared pointer to the communication interface object
[in]failuredispatcher object for failure events
[in]normaldispatcher object for recovery of failure events.

This method register a particular communication interface to the device. Most of the devices will use OPCUA but there might be several implementations so with this method one can register an interface that has been created previously and registered in the communication factory.

See Also
iComm
commFactory
commMaker

Implemented in testDeviceFacade::TestFailureDevice, testDeviceFacade::TestMyDevice, TestMyDevice, devmgr::motor::Motor, devmgr::motor::Motor, devmgr::motor::Motor, devmgr::lamp::Lamp, devmgr::shutter::Shutter, devmgr::lamp::Lamp, devmgr::shutter::Shutter, devmgr::lamp::Lamp, devmgr::shutter::Shutter, devmgr::sensor::Sensor, devmgr::sensor::Sensor, devmgr::sensor::Sensor, devmgr::common::Device, devmgr::common::Device, devmgr::common::Device, and TestShutter.

virtual void devmgr::common::IDevice::RegisterComm ( std::shared_ptr< fcf::common::IComm >  comm_if,
fcf::common::Dispatcher<> &  failure,
fcf::common::Dispatcher<> &  normal 
)
pure virtual

Register a communication interface object.

Parameters
[in]comm_ifshared pointer to the communication interface object
[in]failuredispatcher object for failure events
[in]normaldispatcher object for recovery of failure events.

This method register a particular communication interface to the device. Most of the devices will use OPCUA but there might be several implementations so with this method one can register an interface that has been created previously and registered in the communication factory.

See Also
iComm
commFactory
commMaker

Implemented in testDeviceFacade::TestFailureDevice, testDeviceFacade::TestMyDevice, TestMyDevice, devmgr::motor::Motor, devmgr::motor::Motor, devmgr::motor::Motor, devmgr::lamp::Lamp, devmgr::shutter::Shutter, devmgr::lamp::Lamp, devmgr::shutter::Shutter, devmgr::lamp::Lamp, devmgr::shutter::Shutter, devmgr::sensor::Sensor, devmgr::sensor::Sensor, devmgr::sensor::Sensor, devmgr::common::Device, devmgr::common::Device, devmgr::common::Device, and TestShutter.

virtual void devmgr::common::IDevice::RegisterComm ( std::shared_ptr< fcf::common::IComm >  comm_if,
fcf::common::Dispatcher<> &  failure,
fcf::common::Dispatcher<> &  normal 
)
pure virtual

Register a communication interface object.

Parameters
[in]comm_ifshared pointer to the communication interface object
[in]failuredispatcher object for failure events
[in]normaldispatcher object for recovery of failure events.

This method register a particular communication interface to the device. Most of the devices will use OPCUA but there might be several implementations so with this method one can register an interface that has been created previously and registered in the communication factory.

See Also
iComm
commFactory
commMaker

Implemented in testDeviceFacade::TestFailureDevice, testDeviceFacade::TestMyDevice, TestMyDevice, devmgr::motor::Motor, devmgr::motor::Motor, devmgr::motor::Motor, devmgr::lamp::Lamp, devmgr::shutter::Shutter, devmgr::lamp::Lamp, devmgr::shutter::Shutter, devmgr::lamp::Lamp, devmgr::shutter::Shutter, devmgr::sensor::Sensor, devmgr::sensor::Sensor, devmgr::sensor::Sensor, devmgr::common::Device, devmgr::common::Device, devmgr::common::Device, and TestShutter.

virtual void devmgr::common::IDevice::Reset ( )
pure virtual

Executes a Reset command.

Exceptions
anexception if an error ocurrs.

Implemented in testDeviceFacade::TestFailureDevice, testDeviceFacade::TestMyDevice, TestMyDevice, devmgr::common::Device, devmgr::common::Device, devmgr::common::Device, and TestShutter.

virtual void devmgr::common::IDevice::Reset ( )
pure virtual

Executes a Reset command.

Exceptions
anexception if an error ocurrs.

Implemented in testDeviceFacade::TestFailureDevice, testDeviceFacade::TestMyDevice, TestMyDevice, devmgr::common::Device, devmgr::common::Device, devmgr::common::Device, and TestShutter.

virtual void devmgr::common::IDevice::Reset ( )
pure virtual

Executes a Reset command.

Exceptions
anexception if an error ocurrs.

Implemented in testDeviceFacade::TestFailureDevice, testDeviceFacade::TestMyDevice, TestMyDevice, devmgr::common::Device, devmgr::common::Device, devmgr::common::Device, and TestShutter.

virtual void devmgr::common::IDevice::Setup ( const modif::ReqSetup setupMsg)
pure virtual
virtual void devmgr::common::IDevice::Setup ( const modif::ReqSetup setupMsg)
pure virtual
virtual void devmgr::common::IDevice::Setup ( const modif::ReqSetup setupMsg)
pure virtual
virtual void devmgr::common::IDevice::Simulate ( const modif::ReqSimulate msg)
pure virtual

Executes a Simulat.

Parameters
[in]msgcontains the payload of the Simulat message.
Exceptions
anexception if an error ocurrs.

Implemented in devmgr::common::Device, devmgr::common::Device, and devmgr::common::Device.

virtual void devmgr::common::IDevice::Simulate ( const modif::ReqSimulate msg)
pure virtual

Executes a Simulat.

Parameters
[in]msgcontains the payload of the Simulat message.
Exceptions
anexception if an error ocurrs.

Implemented in devmgr::common::Device, devmgr::common::Device, and devmgr::common::Device.

virtual void devmgr::common::IDevice::Simulate ( const modif::ReqSimulate msg)
pure virtual

Executes a Simulat.

Parameters
[in]msgcontains the payload of the Simulat message.
Exceptions
anexception if an error ocurrs.

Implemented in devmgr::common::Device, devmgr::common::Device, and devmgr::common::Device.

virtual void devmgr::common::IDevice::StartMonitoring ( )
pure virtual

Start device monitoring via OPCUA subscriptions.

Implemented in devmgr::common::Device, devmgr::common::Device, and devmgr::common::Device.

virtual void devmgr::common::IDevice::StartMonitoring ( )
pure virtual

Start device monitoring via OPCUA subscriptions.

Implemented in devmgr::common::Device, devmgr::common::Device, and devmgr::common::Device.

virtual void devmgr::common::IDevice::StartMonitoring ( )
pure virtual

Start device monitoring via OPCUA subscriptions.

Implemented in devmgr::common::Device, devmgr::common::Device, and devmgr::common::Device.

virtual void devmgr::common::IDevice::Status ( const modif::ReqStatus statusMsg,
std::string &  buffer 
)
pure virtual
virtual void devmgr::common::IDevice::Status ( const modif::ReqStatus statusMsg,
std::string &  buffer 
)
pure virtual
virtual void devmgr::common::IDevice::Status ( const modif::ReqStatus statusMsg,
std::string &  buffer 
)
pure virtual
virtual void devmgr::common::IDevice::Status ( bool  end_acq,
const dit::did::Did dictionary,
CCfits::FITS *  fits_handle = nullptr 
)
pure virtual

Obtain the status of the device.

Parameters
end_acqFlag to indicate is the end of the acquisition
dictionaryReference to the dictionary object
fits_handlePointer to the CCFITS object

This method will obtain the data from each device and add the corresponding meta-data to the CCfits object. If the end_acq is not true it will just register the start of the acquisition.

Implemented in testDeviceFacade::TestFailureDevice, devmgr::common::Device, devmgr::common::Device, devmgr::common::Device, testDeviceFacade::TestMyDevice, TestMyDevice, devmgr::motor::Motor, devmgr::motor::Motor, devmgr::motor::Motor, devmgr::shutter::Shutter, devmgr::shutter::Shutter, devmgr::shutter::Shutter, devmgr::sensor::Sensor, devmgr::sensor::Sensor, devmgr::sensor::Sensor, devmgr::lamp::Lamp, devmgr::lamp::Lamp, devmgr::lamp::Lamp, and TestShutter.

virtual void devmgr::common::IDevice::Status ( bool  end_acq,
const dit::did::Did dictionary,
CCfits::FITS *  fits_handle = nullptr 
)
pure virtual

Obtain the status of the device.

Parameters
end_acqFlag to indicate is the end of the acquisition
dictionaryReference to the dictionary object
fits_handlePointer to the CCFITS object

This method will obtain the data from each device and add the corresponding meta-data to the CCfits object. If the end_acq is not true it will just register the start of the acquisition.

Implemented in testDeviceFacade::TestFailureDevice, devmgr::common::Device, devmgr::common::Device, devmgr::common::Device, testDeviceFacade::TestMyDevice, TestMyDevice, devmgr::motor::Motor, devmgr::motor::Motor, devmgr::motor::Motor, devmgr::shutter::Shutter, devmgr::shutter::Shutter, devmgr::shutter::Shutter, devmgr::sensor::Sensor, devmgr::sensor::Sensor, devmgr::sensor::Sensor, devmgr::lamp::Lamp, devmgr::lamp::Lamp, devmgr::lamp::Lamp, and TestShutter.

virtual void devmgr::common::IDevice::Status ( bool  end_acq,
const dit::did::Did dictionary,
CCfits::FITS *  fits_handle = nullptr 
)
pure virtual

Obtain the status of the device.

Parameters
end_acqFlag to indicate is the end of the acquisition
dictionaryReference to the dictionary object
fits_handlePointer to the CCFITS object

This method will obtain the data from each device and add the corresponding meta-data to the CCfits object. If the end_acq is not true it will just register the start of the acquisition.

Implemented in testDeviceFacade::TestFailureDevice, devmgr::common::Device, devmgr::common::Device, devmgr::common::Device, testDeviceFacade::TestMyDevice, TestMyDevice, devmgr::motor::Motor, devmgr::motor::Motor, devmgr::motor::Motor, devmgr::shutter::Shutter, devmgr::shutter::Shutter, devmgr::shutter::Shutter, devmgr::sensor::Sensor, devmgr::sensor::Sensor, devmgr::sensor::Sensor, devmgr::lamp::Lamp, devmgr::lamp::Lamp, devmgr::lamp::Lamp, and TestShutter.

virtual void devmgr::common::IDevice::Stop ( )
pure virtual

Executes a Stop command.

Exceptions
anexception if an error ocurrs.

Implemented in devmgr::common::Device, devmgr::common::Device, and devmgr::common::Device.

virtual void devmgr::common::IDevice::Stop ( )
pure virtual

Executes a Stop command.

Exceptions
anexception if an error ocurrs.

Implemented in devmgr::common::Device, devmgr::common::Device, and devmgr::common::Device.

virtual void devmgr::common::IDevice::Stop ( )
pure virtual

Executes a Stop command.

Exceptions
anexception if an error ocurrs.

Implemented in devmgr::common::Device, devmgr::common::Device, and devmgr::common::Device.

virtual void devmgr::common::IDevice::StopIgn ( const modif::ReqStopIgn msg)
pure virtual

Executes a StopIgn.

Parameters
[in]msgcontains the payload of the StopIgn message.
Exceptions
anexception if an error ocurrs.

Implemented in devmgr::common::Device, devmgr::common::Device, and devmgr::common::Device.

virtual void devmgr::common::IDevice::StopIgn ( const modif::ReqStopIgn msg)
pure virtual

Executes a StopIgn.

Parameters
[in]msgcontains the payload of the StopIgn message.
Exceptions
anexception if an error ocurrs.

Implemented in devmgr::common::Device, devmgr::common::Device, and devmgr::common::Device.

virtual void devmgr::common::IDevice::StopIgn ( const modif::ReqStopIgn msg)
pure virtual

Executes a StopIgn.

Parameters
[in]msgcontains the payload of the StopIgn message.
Exceptions
anexception if an error ocurrs.

Implemented in devmgr::common::Device, devmgr::common::Device, and devmgr::common::Device.

virtual void devmgr::common::IDevice::StopMonitoring ( )
pure virtual

Stop device monitoring.

Implemented in devmgr::common::Device, devmgr::common::Device, and devmgr::common::Device.

virtual void devmgr::common::IDevice::StopMonitoring ( )
pure virtual

Stop device monitoring.

Implemented in devmgr::common::Device, devmgr::common::Device, and devmgr::common::Device.

virtual void devmgr::common::IDevice::StopMonitoring ( )
pure virtual

Stop device monitoring.

Implemented in devmgr::common::Device, devmgr::common::Device, and devmgr::common::Device.

virtual void devmgr::common::IDevice::StopSim ( const modif::ReqStopSim msg)
pure virtual

Executes a StopSim.

Parameters
[in]msgcontains the payload of the StopSim message.
Exceptions
anexception if an error ocurrs.

Implemented in devmgr::common::Device, devmgr::common::Device, and devmgr::common::Device.

virtual void devmgr::common::IDevice::StopSim ( const modif::ReqStopSim msg)
pure virtual

Executes a StopSim.

Parameters
[in]msgcontains the payload of the StopSim message.
Exceptions
anexception if an error ocurrs.

Implemented in devmgr::common::Device, devmgr::common::Device, and devmgr::common::Device.

virtual void devmgr::common::IDevice::StopSim ( const modif::ReqStopSim msg)
pure virtual

Executes a StopSim.

Parameters
[in]msgcontains the payload of the StopSim message.
Exceptions
anexception if an error ocurrs.

Implemented in devmgr::common::Device, devmgr::common::Device, and devmgr::common::Device.

virtual void devmgr::common::IDevice::UpdateStatus ( )
pure virtual
virtual void devmgr::common::IDevice::UpdateStatus ( )
pure virtual
virtual void devmgr::common::IDevice::UpdateStatus ( )
pure virtual

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