artdaq_demo  v2_10_00
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator
NthEvent_transfer.cc
1 #include "artdaq/TransferPlugins/TransferInterface.hh"
2 #include "artdaq/TransferPlugins/MakeTransferPlugin.hh"
3 #include "artdaq-core/Data/Fragment.hh"
4 #include "artdaq-core/Utilities/ExceptionHandler.hh"
5 #include "cetlib/BasicPluginFactory.h"
6 
7 #include "messagefacility/MessageLogger/MessageLogger.h"
8 #include "fhiclcpp/ParameterSet.h"
9 
10 #include <boost/tokenizer.hpp>
11 
12 #include <sys/shm.h>
13 #include <memory>
14 #include <iostream>
15 #include <string>
16 #include <limits>
17 #include <sstream>
18 
22 namespace artdaq
23 {
28  class NthEventTransfer : public TransferInterface
29  {
30  public:
38  NthEventTransfer(fhicl::ParameterSet const& ps, artdaq::TransferInterface::Role role);
39 
46  TransferInterface::CopyStatus
47  copyFragment(artdaq::Fragment& fragment,
48  size_t send_timeout_usec = std::numeric_limits<size_t>::max()) override;
49 
56  TransferInterface::CopyStatus
57  moveFragment(artdaq::Fragment&& fragment,
58  size_t send_timeout_usec = std::numeric_limits<size_t>::max()) override;
59 
66  int receiveFragment(artdaq::Fragment& fragment,
67  size_t receiveTimeout) override
68  {
69  // nth-event discarding is done at the send side. Pass receive calls through to underlying transfer
70  return physical_transfer_->receiveFragment(fragment, receiveTimeout);
71  }
72 
73  int source_rank() const { return physical_transfer_->source_rank(); }
74  int destination_rank() const { return physical_transfer_->destination_rank(); }
75 
76 
77  private:
78 
79  bool pass(const artdaq::Fragment& ) const;
80 
81  std::unique_ptr<TransferInterface> physical_transfer_;
82  size_t nth_;
83  size_t offset_;
84  };
85 
86  NthEventTransfer::NthEventTransfer(fhicl::ParameterSet const& pset, artdaq::TransferInterface::Role role) :
87  TransferInterface(pset, role)
88  , nth_(pset.get<size_t>("nth")),
89  offset_(pset.get<size_t>("offset",0))
90  {
91  if (pset.has_key("source_rank") || pset.has_key("destination_rank")) {
92  throw cet::exception("NthEvent") << "The parameters \"source_rank\" and \"destination_rank\" must be explicitly defined in the body of the physical_transfer_plugin table, and not outside of it";
93  }
94 
95 
96  if (offset_ >= nth_) {
97  throw cet::exception("NthEvent") << "Offset value of " << offset_ <<
98  " must not be larger than the modulus value of " << nth_;
99  }
100 
101  if(nth_ == 0)
102  {
103  mf::LogWarning("NthEventTransfer") << "0 was passed as the nth parameter to NthEventTransfer. Will change to 1 (0 is undefined behavior)";
104  nth_ = 1;
105  }
106  // Instantiate the TransferInterface plugin used to effect transfers
107  physical_transfer_ = MakeTransferPlugin(pset, "physical_transfer_plugin", role);
108  }
109 
110 
111  TransferInterface::CopyStatus
112  NthEventTransfer::copyFragment(artdaq::Fragment& fragment,
113  size_t send_timeout_usec)
114  {
115 
116  if (!pass(fragment))
117  {
118  // Do not transfer but return success. Fragment is discarded
119  return TransferInterface::CopyStatus::kSuccess;
120  }
121 
122  // This is the nth Fragment, transfer
123  return physical_transfer_->copyFragment(fragment, send_timeout_usec);
124  }
125 
126  TransferInterface::CopyStatus
127  NthEventTransfer::moveFragment(artdaq::Fragment&& fragment,
128  size_t send_timeout_usec)
129  {
130  if (!pass(fragment))
131  {
132  // Do not transfer but return success. Fragment is discarded
133  return TransferInterface::CopyStatus::kSuccess;
134  }
135 
136  // This is the nth Fragment, transfer
137  return physical_transfer_->moveFragment(std::move(fragment), send_timeout_usec);
138  }
139 
140  bool
141  NthEventTransfer::pass(const artdaq::Fragment& fragment) const
142  {
143  bool passed = false;
144 
145  if (fragment.type() == artdaq::Fragment::DataFragmentType) {
146  passed = (fragment.sequenceID() + nth_ - offset_) % nth_ == 0 ? true: false;
147  } else {
148  passed = true;
149  }
150 
151  return passed;
152  }
153 }
154 
155 DEFINE_ARTDAQ_TRANSFER(artdaq::NthEventTransfer)
156 
157 // Local Variables:
158 // mode: c++
159 // End:
Demonstration TransferInterface plugin showing how to discard events Intended for use in the transfer...
int receiveFragment(artdaq::Fragment &fragment, size_t receiveTimeout) override
Receive a fragment from the transfer plugin.
NthEventTransfer(fhicl::ParameterSet const &ps, artdaq::TransferInterface::Role role)
NthEventTransfer Constructor.
TransferInterface::CopyStatus copyFragment(artdaq::Fragment &fragment, size_t send_timeout_usec=std::numeric_limits< size_t >::max()) override
Copy a fragment, using the non-reliable channel.
TransferInterface::CopyStatus moveFragment(artdaq::Fragment &&fragment, size_t send_timeout_usec=std::numeric_limits< size_t >::max()) override
Copy a fragment, using the reliable channel. moveFragment assumes ownership of the fragment...