ifw-fcf  3.0.0
deviceFacade.hpp
Go to the documentation of this file.
1 
9 #ifndef FCF_DEVMGR_COMMON_DEVICE_FACADE_HPP_
10 #define FCF_DEVMGR_COMMON_DEVICE_FACADE_HPP_
11 
12 // System headers
13 #include <list>
14 
15 // Local headers
16 #include <rad/smAdapter.hpp>
17 #include <rad/topicPub.hpp>
18 #include <rad/anyEvent.hpp>
19 #include <rad/activity.hpp>
20 
21 #include <fcf/common/dispatcher.hpp>
23 #include <fcf/devmgr/common/events.rad.hpp>
24 
25 namespace fcf {
26  namespace devmgr {
27  namespace common {
28 
29  struct DaqInfo {
30  ::metadaqif::DaqState m_state{::metadaqif::DaqState::Undefined};
31  std::string m_msg{""};
32  std::vector<std::string> m_files;
33  double m_timestamp{0};
34 
35  void StartDaq(std::string filename);
36  void StopDaq(std::string filename);
37  void AbortDaq(std::string msg);
38  bool IsActive();
39  bool IsStopped();
40  };
41 
42  class Config;
43  class IDevice;
44 
52  class DeviceFacade {
53  public:
62  DeviceFacade(rad::SMAdapter& sm,
63  IConfig& config,
64  fcf::common::Dispatcher<>& failure,
65  fcf::common::Dispatcher<>& normal);
66 
70  virtual ~DeviceFacade();
71 
76  virtual bool Init(rad::SMAdapter& sm, rad::ThreadActivity* activity);
77 
85  virtual bool Enable(rad::SMAdapter& sm, rad::ThreadActivity* activity);
86 
94  virtual bool Recover(rad::SMAdapter& sm, rad::ThreadActivity* activity);
99  virtual bool Disable();
100 
122  virtual bool Setup(const std::any& payload, rad::ThreadActivity* activity);
127  virtual void Stop();
128 
133  virtual void Reset();
134 
141  virtual void Status(const std::any& payload, std::string& buffer);
142 
143 
148  virtual void Simulate(rad::AnyEvent const& last_event);
149 
154  virtual void StopSim(rad::AnyEvent const& last_event);
155 
160  virtual void Ignore(rad::AnyEvent const& last_event);
161 
166  virtual void StopIgn(rad::AnyEvent const& last_event);
167 
172  virtual void HwReset(rad::AnyEvent const& last_event);
173 
178  virtual void HwInit(rad::AnyEvent const& last_event);
179 
184  virtual void HwEnable(rad::AnyEvent const& last_event);
185 
190  virtual void HwDisable(rad::AnyEvent const& last_event);
191 
196  virtual std::string DevNames();
197 
202  virtual std::string DevInfo();
203 
208  virtual std::string DevConfig(const std::string devname);
209 
220  void StartDaq(std::string daqid);
221 
237  fcf::devmgr::common::DaqInfo StopDaq(std::string daqid);
238 
245  void AbortDaq(std::string daqid);
246 
253  fcf::devmgr::common::DaqInfo GetDaqStatus(std::string daqid) const;
254 
262  void TriggerInternalEvent(rad::SMAdapter& sm, rad::UniqueEvent&& e);
263 
270  void AddDevice(std::shared_ptr<IDevice> device);
271 
275  void ClearDevices();
276 
281  fcf::common::Dispatcher<>& GetFailureCB();
282 
287  fcf::common::Dispatcher<>& GetNormalCB();
288 
293  const int GetNumDevices();
294 
295  private:
296 
297  DeviceFacade(const DeviceFacade&) = delete;
298  DeviceFacade& operator= (const DeviceFacade&) = delete;
299 
308  void InitSync(rad::ThreadActivity* activity,
309  std::chrono::system_clock::time_point start_time,
310  bool& stopped,
311  bool& timeout);
312 
321  void EnableSync(rad::ThreadActivity* activity,
322  std::chrono::system_clock::time_point start_time,
323  bool& stopped,
324  bool& timeout);
325 
331  void DeviceFailureCB();
332 
339  void DeviceNormalCB();
340 
341  void CheckDeviceName(const std::vector<std::string>& devices) const;
342 
343  std::vector<std::shared_ptr<IDevice> > m_devices;
344  std::vector<std::string> m_device_names;
345  boost::asio::io_service m_ios;
346  rad::SMAdapter& m_sm;
347  IConfig& m_config;
348  std::string m_dp_filename;
349  std::map<std::string, fcf::devmgr::common::DaqInfo> m_daq;
354  fcf::common::Dispatcher<> m_failure;
355 
359  fcf::common::Dispatcher<> m_normal;
360  };
361  }
362  }
363 } // namespace devmgr::Common
364 
365 #endif // FCF_DEVMGR_COMMON_DEVICE_FACADE_HPP_
fcf::devmgr::common::DeviceFacade::Init
virtual bool Init(rad::SMAdapter &sm, rad::ThreadActivity *activity)
Init all devices managed by the devmgr.
Definition: deviceFacade.cpp:96
fcf::devmgr::common::DeviceFacade::DevInfo
virtual std::string DevInfo()
Get information of managed devices.
Definition: deviceFacade.cpp:1039
fcf::devmgr::common::DaqInfo::IsActive
bool IsActive()
Definition: deviceFacade.cpp:59
fcf::devmgr::common::DeviceFacade::~DeviceFacade
virtual ~DeviceFacade()
~DeviceFacade
Definition: deviceFacade.cpp:92
fcf::devmgr::common::DeviceFacade::ClearDevices
void ClearDevices()
Empty internal device map.
Definition: deviceFacade.cpp:789
fcf::devmgr::common::DeviceFacade::TriggerInternalEvent
void TriggerInternalEvent(rad::SMAdapter &sm, rad::UniqueEvent &&e)
Trigger an internal event.
Definition: deviceFacade.cpp:777
fcf::devmgr::common::DeviceFacade::StopIgn
virtual void StopIgn(rad::AnyEvent const &last_event)
Stop ignoring devices managed by the server.
Definition: deviceFacade.cpp:572
device.hpp
Device class header file.
fcf::devmgr::common::DeviceFacade::HwReset
virtual void HwReset(rad::AnyEvent const &last_event)
Reset hardware.
Definition: deviceFacade.cpp:587
fcf::devmgr::common::DeviceFacade::Simulate
virtual void Simulate(rad::AnyEvent const &last_event)
Simulate devices managed by the server.
Definition: deviceFacade.cpp:527
fcf::devmgr::common::DeviceFacade::Status
virtual void Status(const std::any &payload, std::string &buffer)
Get status from devices.
Definition: deviceFacade.cpp:512
fcf::devmgr::common::DeviceFacade::StopDaq
fcf::devmgr::common::DaqInfo StopDaq(std::string daqid)
Stop Data Acquisition.
Definition: deviceFacade.cpp:688
fcf::devmgr::common::DeviceFacade::GetDaqStatus
fcf::devmgr::common::DaqInfo GetDaqStatus(std::string daqid) const
Get Daq Status.
Definition: deviceFacade.cpp:765
fcf::devmgr::common::DeviceFacade::AddDevice
void AddDevice(std::shared_ptr< IDevice > device)
Add a device instance to be managed by the facade.
Definition: deviceFacade.cpp:783
fcf::devmgr::common::DeviceFacade::StopSim
virtual void StopSim(rad::AnyEvent const &last_event)
Stop simulating devices managed by the server.
Definition: deviceFacade.cpp:542
fcf::devmgr::common::DaqInfo::m_msg
std::string m_msg
Definition: deviceFacade.hpp:31
fcf::devmgr::common::DaqInfo
Definition: deviceFacade.hpp:29
fcf::devmgr::common::DeviceFacade::GetNormalCB
fcf::common::Dispatcher & GetNormalCB()
Get reference to normal CB.
Definition: deviceFacade.cpp:801
fcf::devmgr::common::DaqInfo::AbortDaq
void AbortDaq(std::string msg)
Definition: deviceFacade.cpp:53
fcf::devmgr::common::DeviceFacade::Setup
virtual bool Setup(const std::any &payload, rad::ThreadActivity *activity)
Executes a setup message.
Definition: deviceFacade.cpp:404
fcf::devmgr::common::DeviceFacade::HwDisable
virtual void HwDisable(rad::AnyEvent const &last_event)
Disable hardware.
Definition: deviceFacade.cpp:629
fcf::devmgr::common::DeviceFacade
Definition: deviceFacade.hpp:52
fcf::devmgr::common::DeviceFacade::Recover
virtual bool Recover(rad::SMAdapter &sm, rad::ThreadActivity *activity)
Recover all devices managed by the devmgr.
Definition: deviceFacade.cpp:272
fcf
Definition: actionMgr.cpp:29
fcf::devmgr::common::DeviceFacade::HwInit
virtual void HwInit(rad::AnyEvent const &last_event)
Init hardware.
Definition: deviceFacade.cpp:601
fcf::devmgr::common::DeviceFacade::AbortDaq
void AbortDaq(std::string daqid)
Abort Data Acquisition.
Definition: deviceFacade.cpp:747
fcf::devmgr::common::DaqInfo::m_timestamp
double m_timestamp
Definition: deviceFacade.hpp:33
fcf::devmgr::common::DaqInfo::StartDaq
void StartDaq(std::string filename)
Definition: deviceFacade.cpp:43
fcf::devmgr::common::DaqInfo::m_files
std::vector< std::string > m_files
Definition: deviceFacade.hpp:32
fcf::devmgr::common::DaqInfo::StopDaq
void StopDaq(std::string filename)
Definition: deviceFacade.cpp:48
fcf::devmgr::common::DeviceFacade::Ignore
virtual void Ignore(rad::AnyEvent const &last_event)
Ignore devices managed by the server.
Definition: deviceFacade.cpp:557
fcf::devmgr::common::DeviceFacade::DeviceFacade
DeviceFacade(rad::SMAdapter &sm, IConfig &config, fcf::common::Dispatcher<> &failure, fcf::common::Dispatcher<> &normal)
Definition: deviceFacade.cpp:73
fcf::devmgr::common::DeviceFacade::DevConfig
virtual std::string DevConfig(const std::string devname)
Get configuration for a given device.
Definition: deviceFacade.cpp:1057
fcf::devmgr::common::DeviceFacade::Reset
virtual void Reset()
Reset devices.
Definition: deviceFacade.cpp:500
fcf::devmgr::common::DaqInfo::IsStopped
bool IsStopped()
Definition: deviceFacade.cpp:66
fcf::devmgr::common::DeviceFacade::Stop
virtual void Stop()
Abort all devices managed by the devmgr.
Definition: deviceFacade.cpp:490
fcf::devmgr::common::DaqInfo::m_state
::metadaqif::DaqState m_state
Definition: deviceFacade.hpp:30
fcf::devmgr::common::DeviceFacade::StartDaq
void StartDaq(std::string daqid)
Start Data Acquisition.
Definition: deviceFacade.cpp:643
fcf::devmgr::common::DeviceFacade::GetFailureCB
fcf::common::Dispatcher & GetFailureCB()
Get reference to failure CB.
Definition: deviceFacade.cpp:796
fcf::devmgr::common::DeviceFacade::Disable
virtual bool Disable()
Disable all devices managed by the devmgr.
Definition: deviceFacade.cpp:376
fcf::devmgr::common::IConfig
Definition: iConfig.hpp:22
fcf::devmgr::common::DeviceFacade::HwEnable
virtual void HwEnable(rad::AnyEvent const &last_event)
Enable hardware.
Definition: deviceFacade.cpp:615
fcf::devmgr::common::DeviceFacade::DevNames
virtual std::string DevNames()
Get list of managed devices.
Definition: deviceFacade.cpp:1029
fcf::devmgr::common::DeviceFacade::GetNumDevices
const int GetNumDevices()
Get the number of devices.
Definition: deviceFacade.cpp:834
fcf::devmgr::common::DeviceFacade::Enable
virtual bool Enable(rad::SMAdapter &sm, rad::ThreadActivity *activity)
Enable all devices managed by the devmgr.
Definition: deviceFacade.cpp:143