mu2e_artdaq_core  v1_02_11
 All Classes Functions
DTCFragmentWriter.hh
1 #ifndef mu2e_artdaq_core_Overlays_DTCFragmentWriter_hh
2 #define mu2e_artdaq_core_Overlays_DTCFragmentWriter_hh
3 
5 // DTCFragmentWriter
6 //
7 // Class derived from DTCFragment which allows writes to the data (for
8 // simulation purposes). Note that for this reason it contains
9 // non-const members which hide the const members in its parent class,
10 // DTCFragment, including its reference to the artdaq::Fragment
11 // object, artdaq_Fragment_, as well as its functions pointing to the
12 // beginning and end of ADC values in the fragment, dataBegin() and
13 // dataEnd()
14 //
16 
17 #include "artdaq-core/Data/Fragment.hh"
18 #include "mu2e-artdaq-core/Overlays/DTCFragment.hh"
19 
20 #include <iostream>
21 
22 namespace mu2e {
23 class DTCFragmentWriter;
24 }
25 
27  public:
28  DTCFragmentWriter(artdaq::Fragment &f);
29 
30  // These functions form overload sets with const functions from
31  // mu2e::DTCFragment
32 
33  packet_t *dataBegin();
34  packet_t *dataEnd();
35 
36  // We'll need to hide the const version of header in DTCFragment in
37  // order to be able to perform writes
38 
39  Header *header_() {
40  assert(artdaq_Fragment_.dataSize() >= words_to_frag_words_(Header::size_words));
41  return reinterpret_cast<Header *>(&*artdaq_Fragment_.dataBegin());
42  }
43 
44  void set_hdr_timestamp(Header::timestamp_t timestamp) { header_()->timestamp = timestamp; }
45 
46  void resize(size_t nPackets);
47 
48  size_t size() { return artdaq_Fragment_.size(); }
49 
50  private:
51  size_t calc_event_size_words_(size_t nPackets);
52 
53  static size_t packets_to_words_(size_t nPackets);
54  static size_t words_to_frag_words_(size_t nWords);
55 
56  // Note that this non-const reference hides the const reference in the base class
57  artdaq::Fragment &artdaq_Fragment_;
58 };
59 
60 // The constructor will expect the artdaq::Fragment object it's been
61 // passed to contain the artdaq::Fragment header + the
62 // DTCFragment::Metadata object, otherwise it throws
63 
64 mu2e::DTCFragmentWriter::DTCFragmentWriter(artdaq::Fragment &f) : DTCFragment(f), artdaq_Fragment_(f) {
65  // If this assert doesn't hold, then can't call
66  // "words_to_frag_words_" below, translating between the
67  // DTCFragment's standard data type size and the
68  // artdaq::Fragment's data type size, on the Metadata object
69 
70  assert(sizeof(Metadata::data_t) == sizeof(Header::data_t));
71 
72  if (artdaq_Fragment_.size() !=
73  artdaq::detail::RawFragmentHeader::num_words() + words_to_frag_words_(Metadata::size_words)) {
74  std::cerr << "artdaq_Fragment size: " << artdaq_Fragment_.size() << std::endl;
75  std::cerr << "Expected size: "
76  << artdaq::detail::RawFragmentHeader::num_words() + words_to_frag_words_(Metadata::size_words)
77  << std::endl;
78 
79  throw cet::exception(
80  "DTCFragmentWriter: Raw artdaq::Fragment object size suggests it does not consist of its own header + the "
81  "DTCFragment::Metadata object");
82  }
83 
84  // Allocate space for the header
85  artdaq_Fragment_.resize(words_to_frag_words_(Header::size_words));
86 }
87 
88 inline mu2e::packet_t *mu2e::DTCFragmentWriter::dataBegin() {
89  assert(artdaq_Fragment_.dataSize() > words_to_frag_words_(Header::size_words));
90  return reinterpret_cast<packet_t *>(header_() + 1);
91 }
92 
93 inline mu2e::packet_t *mu2e::DTCFragmentWriter::dataEnd() { return dataBegin() + hdr_packet_count(); }
94 
95 inline void mu2e::DTCFragmentWriter::resize(size_t nPackets) {
96  auto es(calc_event_size_words_(nPackets));
97  artdaq_Fragment_.resize(words_to_frag_words_(es));
98  header_()->event_size = nPackets;
99 }
100 
101 inline size_t mu2e::DTCFragmentWriter::calc_event_size_words_(size_t nPackets) {
102  return packets_to_words_(nPackets) + hdr_size_words();
103 }
104 
105 inline size_t mu2e::DTCFragmentWriter::packets_to_words_(size_t nPackets) { return nPackets * words_per_packet_(); }
106 
107 inline size_t mu2e::DTCFragmentWriter::words_to_frag_words_(size_t nWords) {
108  size_t mod = nWords % words_per_frag_word_();
109  return mod ? nWords / words_per_frag_word_() + 1 : nWords / words_per_frag_word_();
110 }
111 
112 #endif /* mu2e_artdaq_core_Overlays_DTCFragmentWriter_hh */