Applying FairMQDevice boiler plate code and program options.

Simlify the EventSampler device by using the FairMQ boiler plate code
and program options.

Author: matthiasrichter

Utilities/aliceHLTwrapper/include/aliceHLTwrapper/EventSampler.h

@@ -5,8 +5,8 @@
 //****************************************************************************
 //* This file is free software: you can redistribute it and/or modify        *
 //* it under the terms of the GNU General Public License as published by     *
-//* the Free Software Foundation, either version 3 of the License, or	     *
-//* (at your option) any later version.					     *
+//* the Free Software Foundation, either version 3 of the License, or        *
+//* (at your option) any later version.                                      *
 //*                                                                          *
 //* Primary Authors: Matthias Richter <richterm@scieq.net>                   *
 //*                                                                          *
@@ -21,6 +21,9 @@
 
 #include <FairMQDevice.h>
 #include <vector>
+#include <boost/program_options.hpp>
+
+namespace bpo = boost::program_options;
 
 namespace ALICE {
 namespace HLT {
@@ -38,27 +41,36 @@ class EventSampler : public FairMQDevice {
   /// destructor
   ~EventSampler() override;
 
+  /// get description of options
+  static bpo::options_description GetOptionsDescription();
+
+  enum /*class*/ OptionKeyIds /*: int*/ {
+    OptionKeyEventPeriod = 0,
+    OptionKeyInitialDelay,
+    OptionKeyPollTimeout,
+    OptionKeyDryRun,
+    OptionKeyLatencyLog,
+    OptionKeyLast
+  };
+
+  constexpr static const char* OptionKeys[] = {
+    "eventperiod",
+    "initialdelay",
+    "polltimeout",
+    "dry-run",
+    "latency-log",
+    nullptr
+  };
+
   /////////////////////////////////////////////////////////////////
   // the FairMQDevice interface
 
   /// inherited from FairMQDevice
-  void Init() override;
+  void InitTask() override;
   /// inherited from FairMQDevice
   void Run() override;
   /// inherited from FairMQDevice
   void Pause() override;
-  /// inherited from FairMQDevice
-  /// handle device specific properties and forward to FairMQDevice::SetProperty
-  void SetProperty(const int key, const std::string& value) override;
-  /// inherited from FairMQDevice
-  /// handle device specific properties and forward to FairMQDevice::GetProperty
-  std::string GetProperty(const int key, const std::string& default_ = "") override;
-  /// inherited from FairMQDevice
-  /// handle device specific properties and forward to FairMQDevice::SetProperty
-  void SetProperty(const int key, const int value) override;
-  /// inherited from FairMQDevice
-  /// handle device specific properties and forward to FairMQDevice::GetProperty
-  int GetProperty(const int key, const int default_ = 0) override;
 
   /// sampler loop started in a separate thread
   void samplerLoop();
@@ -81,7 +93,7 @@ class EventSampler : public FairMQDevice {
   int mPollingTimeout;       // period of polling on input sockets in ms
   int mSkipProcessing;       // skip component processing
   int mVerbosity;            // verbosity level
-  std::string mOutputFile;   // output file for logging of latency
+  std::string mLatencyLogFileName;   // output file for logging of latency
 };
 
 } // namespace hlt

Utilities/aliceHLTwrapper/src/EventSampler.cxx

@@ -1,8 +1,8 @@
 //****************************************************************************
 //* This file is free software: you can redistribute it and/or modify        *
 //* it under the terms of the GNU General Public License as published by     *
-//* the Free Software Foundation, either version 3 of the License, or	     *
-//* (at your option) any later version.					     *
+//* the Free Software Foundation, either version 3 of the License, or        *
+//* (at your option) any later version.                                      *
 //*                                                                          *
 //* Primary Authors: Matthias Richter <richterm@scieq.net>                   *
 //*                                                                          *
@@ -19,6 +19,7 @@
 #include <FairMQLogger.h>
 #include <FairMQPoller.h>
 #include "aliceHLTwrapper/AliHLTDataTypes.h"
+#include <options/FairMQProgOptions.h>
 
 #include <boost/thread.hpp>
 #include <boost/bind.hpp>
@@ -44,22 +45,55 @@ const std::chrono::time_point<system_clock, PeriodDay> dayref=std::chrono::time_
 using namespace ALICE::HLT;
 
 EventSampler::EventSampler(int verbosity)
-  : mEventPeriod(1000)
-  , mInitialDelay(1000)
+  : mEventPeriod(-1)
+  , mInitialDelay(-1)
   , mNEvents(-1)
-  , mPollingTimeout(10)
+  , mPollingTimeout(-1)
   , mSkipProcessing(0)
   , mVerbosity(verbosity)
-  , mOutputFile()
+  , mLatencyLogFileName()
 {
 }
 
 EventSampler::~EventSampler()
 = default;
 
-void EventSampler::Init()
+constexpr const char* EventSampler::OptionKeys[];
+
+bpo::options_description EventSampler::GetOptionsDescription()
+{
+  // assemble the options for the device class and component
+  bpo::options_description od("EventSampler options");
+  od.add_options()
+    (OptionKeys[OptionKeyEventPeriod],
+     bpo::value<int>()->default_value(1000),
+     "event period in us")
+    (OptionKeys[OptionKeyInitialDelay],
+     bpo::value<int>()->default_value(1000),
+     "initial delay before the first event in ms")
+    (OptionKeys[OptionKeyPollTimeout],
+     bpo::value<int>()->default_value(10),
+     "timeout for the input socket poller in ms")
+    ((std::string(OptionKeys[OptionKeyLatencyLog]) + ",l").c_str(),
+     bpo::value<std::string>()->default_value(""),
+     "output file name for logging of latency")
+    ((std::string(OptionKeys[OptionKeyDryRun]) + ",n").c_str(),
+     bpo::value<bool>()->zero_tokens()->default_value(false),
+     "skip component processing");
+  return od;
+}
+
+void EventSampler::InitTask()
 {
   /// inherited from FairMQDevice
+  const auto * config = GetConfig();
+  if (config) {
+    mEventPeriod = config->GetValue<int>(OptionKeys[OptionKeyEventPeriod]);
+    mInitialDelay =  config->GetValue<int>(OptionKeys[OptionKeyInitialDelay]);
+    mPollingTimeout = config->GetValue<int>(OptionKeys[OptionKeyPollTimeout]);
+    mSkipProcessing = config->GetValue<bool>(OptionKeys[OptionKeyDryRun]);
+    mLatencyLogFileName = config->GetValue<std::string>(OptionKeys[OptionKeyLatencyLog]);
+  }
   mNEvents=0;
 }
 
@@ -86,7 +120,7 @@ void EventSampler::Run()
   vector<int> inputMessageCntPerSocket(numInputs, 0);
   int nReadCycles=0;
 
-  std::ofstream latencyLog(mOutputFile);
+  std::ofstream latencyLog(mLatencyLogFileName);
 
   while (CheckCurrentState(RUNNING)) {
 
@@ -168,63 +202,6 @@ void EventSampler::Pause()
   FairMQDevice::Pause();
 }
 
-void EventSampler::SetProperty(const int key, const string& value)
-{
-  /// inherited from FairMQDevice
-  /// handle device specific properties and forward to FairMQDevice::SetProperty
-  switch (key) {
-  case OutputFile:
-    mOutputFile = value;
-    return;
-  }
-  return FairMQDevice::SetProperty(key, value);
-}
-
-string EventSampler::GetProperty(const int key, const string& default_)
-{
-  /// inherited from FairMQDevice
-  /// handle device specific properties and forward to FairMQDevice::GetProperty
-  return FairMQDevice::GetProperty(key, default_);
-}
-
-void EventSampler::SetProperty(const int key, const int value)
-{
-  /// inherited from FairMQDevice
-  /// handle device specific properties and forward to FairMQDevice::SetProperty
-  switch (key) {
-  case EventPeriod:
-    mEventPeriod = value;
-    return;
-  case InitialDelay:
-    mInitialDelay = value;
-    return;
-  case PollingTimeout:
-    mPollingTimeout = value;
-    return;
-  case SkipProcessing:
-    mSkipProcessing = value;
-    return;
-  }
-  return FairMQDevice::SetProperty(key, value);
-}
-
-int EventSampler::GetProperty(const int key, const int default_)
-{
-  /// inherited from FairMQDevice
-  /// handle device specific properties and forward to FairMQDevice::GetProperty
-  switch (key) {
-  case EventPeriod:
-    return mEventPeriod;
-  case InitialDelay:
-    return mInitialDelay;
-  case PollingTimeout:
-    return mPollingTimeout;
-  case SkipProcessing:
-    return mSkipProcessing;
-  }
-  return FairMQDevice::GetProperty(key, default_);
-}
-
 void EventSampler::samplerLoop()
 {
   /// sampler loop