TimingController.hpp

Go to the documentation of this file.

 
#ifndef TIMINGLIBS_INCLUDE_TIMINGLIBS_TIMINGCONTROLLER_HPP_
#define TIMINGLIBS_INCLUDE_TIMINGLIBS_TIMINGCONTROLLER_HPP_
 
#include "timinglibs/TimingIssues.hpp"
#include "timinglibs/timingcmd/Structs.hpp"
 
#include "timinglibs/dal/TimingController.hpp"
#include "timinglibs/dal/TimingControllerConf.hpp"
 
#include "appfwk/DAQModule.hpp"
#include "ers/Issue.hpp"
#include "iomanager/Receiver.hpp"
#include "iomanager/Sender.hpp"
#include "logging/Logging.hpp" // NOTE: if ISSUES ARE DECLARED BEFORE include logging/Logging.hpp, TLOG_DEBUG<<issue wont work.
#include "utilities/WorkerThread.hpp"
 
#include "appfwk/ConfigurationManager.hpp"
#include "confmodel/Connection.hpp"
 
#include <memory>
#include <string>
#include <vector>
 
namespace dunedaq {
ERS_DECLARE_ISSUE(timinglibs,             
                  TimingEndpointNotReady, 
                  endpoint << " timing endpoint did not become ready in time. State 0x" << std::hex
                           << state,                   
                  ((std::string)endpoint)((uint)state) 
)
namespace timinglibs {
 
template<typename T>
struct MobileAtomic
{
  std::atomic<T> atomic;
 
  MobileAtomic()
    : atomic(T())
  {
  }
 
  explicit MobileAtomic(T const& v)
    : atomic(v)
  {
  }
  explicit MobileAtomic(std::atomic<T> const& a)
    : atomic(a.load())
  {
  }
 
  virtual ~MobileAtomic() = default;
 
  MobileAtomic(MobileAtomic const& other)
    : atomic(other.atomic.load())
  {
  }
 
  MobileAtomic& operator=(MobileAtomic const& other)
  {
    atomic.store(other.atomic.load());
    return *this;
  }
 
  MobileAtomic(MobileAtomic&&) = default;
  MobileAtomic& operator=(MobileAtomic&&) = default;
};
 
typedef MobileAtomic<uint64_t> AtomicUInt64; // NOLINT(build/unsigned)

class TimingController : public dunedaq::appfwk::DAQModule
{
public:
  explicit TimingController(const std::string& name, uint number_hw_commands);
 
  TimingController(const TimingController&) = delete;            
  TimingController& operator=(const TimingController&) = delete; 
  TimingController(TimingController&&) = delete;                 
  TimingController& operator=(TimingController&&) = delete;      
 
  void init(std::shared_ptr<appfwk::ConfigurationManager> mcfg) override;
 
protected:
  // DAQModule commands
  virtual void do_configure(const CommandData_t&);
  virtual void do_start(const CommandData_t&) {}
  virtual void do_stop(const CommandData_t&) {}
  virtual void do_scrap(const CommandData_t&);
 
  template<class T, class... Vs>
  void configure_hardware_or_recover_state(const nlohmann::json& data,
                                           std::string timing_entity_description,
                                           const Vs&... args);
 
  // Configuration
  std::string m_hw_command_out_connection;
  std::chrono::milliseconds m_hw_cmd_out_timeout;
  using sink_t = dunedaq::iomanager::SenderConcept<timingcmd::TimingHwCmd>;
  std::shared_ptr<sink_t> m_hw_command_sender;
  std::string m_timing_device;
  std::string m_timing_session_name;
  using source_t = dunedaq::iomanager::ReceiverConcept<nlohmann::json>;
  std::shared_ptr<source_t> m_device_info_receiver;
 
  virtual void send_hw_cmd(timingcmd::TimingHwCmd&& hw_cmd);
  virtual void send_configure_hardware_commands(const CommandData_t& data) = 0;
 
  // opmon
  uint m_number_hw_commands;
  std::vector<AtomicUInt64> m_sent_hw_command_counters;
 
  // Interpert device opmon info
  virtual void process_device_info(nlohmann::json /*message*/) = 0;
  std::chrono::milliseconds m_device_ready_timeout;
  std::atomic<bool> m_device_ready;
  std::atomic<uint> m_device_infos_received_count;
  std::atomic<bool> m_hardware_state_recovery_enabled;
 
  // common commands
  timingcmd::TimingHwCmd construct_hw_cmd(const std::string& cmd_id);
  timingcmd::TimingHwCmd construct_hw_cmd(const std::string& cmd_id, const nlohmann::json& payload);
  virtual void do_io_reset(const CommandData_t& data);
  virtual void do_print_status(const CommandData_t& data);
  const dal::TimingControllerConf* m_params;
};
} // namespace timinglibs
} // namespace dunedaq
 
#include "detail/TimingController.hxx"
 
#endif // TIMINGLIBS_INCLUDE_TIMINGLIBS_TIMINGCONTROLLER_HPP_
 
// Local Variables:
// c-basic-offset: 2
// End: