mu2e_artdaq_core  v1_02_11
 All Classes Functions
DetectorFragmentWriter.hh
1 #ifndef mu2e_artdaq_Overlays_DetectorFragmentWriter_hh
2 #define mu2e_artdaq_Overlays_DetectorFragmentWriter_hh
3 
5 // DetectorFragmentWriter
6 //
7 // Class derived from DetectorFragment 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 // DetectorFragment, 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/DetectorFragment.hh"
19 
20 #include <iostream>
21 
22 namespace mu2e {
23 class DetectorFragmentWriter;
24 }
25 
27  public:
28  DetectorFragmentWriter(artdaq::Fragment &f);
29 
30  virtual ~DetectorFragmentWriter(){};
31 
32  // These functions form overload sets with const functions from
33  // mu2e::DetectorFragment
34 
35  adc_t *dataBegin();
36  adc_t *dataEnd();
37 
38  // We'll need to hide the const version of header in DetectorFragment in
39  // order to be able to perform writes
40 
41  Header *header_() {
42  assert(artdaq_Fragment_.dataSize() >= words_to_frag_words_(Header::size_words));
43  return reinterpret_cast<Header *>(&*artdaq_Fragment_.dataBegin());
44  }
45 
46  void set_hdr_run_number(Header::run_number_t run_number) { header_()->run_number = run_number; }
47 
48  void resize(size_t nAdcs);
49 
50  virtual void printAll(){};
51 
52  void generateOffsetTable(const std::vector<size_t> dataBlockVec);
53 
54  private:
55  size_t calc_event_size_words_(size_t nAdcs);
56 
57  static size_t adcs_to_words_(size_t nAdcs);
58  static size_t words_to_frag_words_(size_t nWords);
59 
60  // Note that this non-const reference hides the const reference in the base class
61  artdaq::Fragment &artdaq_Fragment_;
62 };
63 
64 // The constructor will expect the artdaq::Fragment object it's been
65 // passed to contain the artdaq::Fragment header + the
66 // DetectorFragment::Metadata object, otherwise it throws
67 
68 mu2e::DetectorFragmentWriter::DetectorFragmentWriter(artdaq::Fragment &f) : DetectorFragment(f), artdaq_Fragment_(f) {
69  // If this assert doesn't hold, then can't call
70  // "words_to_frag_words_" below, translating between the
71  // DetectorFragment's standard data type size and the
72  // artdaq::Fragment's data type size, on the Metadata object
73 
74  assert(sizeof(Metadata::data_t) == sizeof(Header::data_t));
75 
76  if (artdaq_Fragment_.size() !=
77  artdaq::detail::RawFragmentHeader::num_words() + words_to_frag_words_(Metadata::size_words)) {
78  std::cerr << "artdaq_Fragment size: " << artdaq_Fragment_.size() << std::endl;
79  std::cerr << "Expected size: "
80  << artdaq::detail::RawFragmentHeader::num_words() + words_to_frag_words_(Metadata::size_words)
81  << std::endl;
82 
83  throw cet::exception(
84  "DetectorFragmentWriter: Raw artdaq::Fragment object size suggests it does not consist of its own header + the "
85  "DetectorFragment::Metadata object");
86  }
87 
88  // Allocate space for the header
89  artdaq_Fragment_.resize(words_to_frag_words_(Header::size_words));
90 }
91 
92 inline mu2e::DetectorFragment::adc_t *mu2e::DetectorFragmentWriter::dataBegin() {
93  assert(artdaq_Fragment_.dataSize() > words_to_frag_words_(Header::size_words));
94  // return reinterpret_cast<adc_t *>(header_() + 1);
95  return (reinterpret_cast<adc_t *>(header_() + 1)) + current_offset_;
96 }
97 
98 inline mu2e::DetectorFragment::adc_t *mu2e::DetectorFragmentWriter::dataEnd() {
99  return dataBegin() + total_adc_values_in_data_block();
100  // return dataBegin() + total_adc_values();
101 }
102 
103 inline void mu2e::DetectorFragmentWriter::resize(size_t nAdcs) {
104  auto es(calc_event_size_words_(nAdcs));
105  artdaq_Fragment_.resize(words_to_frag_words_(es));
106  header_()->event_size = es;
107 }
108 
109 inline size_t mu2e::DetectorFragmentWriter::calc_event_size_words_(size_t nAdcs) {
110  return adcs_to_words_(nAdcs) + hdr_size_words();
111 }
112 
113 inline size_t mu2e::DetectorFragmentWriter::adcs_to_words_(size_t nAdcs) {
114  auto mod(nAdcs % adcs_per_word_());
115  return (mod == 0) ? nAdcs / adcs_per_word_() : nAdcs / adcs_per_word_() + 1;
116 }
117 
118 inline size_t mu2e::DetectorFragmentWriter::words_to_frag_words_(size_t nWords) {
119  size_t mod = nWords % words_per_frag_word_();
120  return mod ? nWords / words_per_frag_word_() + 1 : nWords / words_per_frag_word_();
121 }
122 
123 inline void mu2e::DetectorFragmentWriter::generateOffsetTable(const std::vector<size_t> dataBlockVec) {
124  initializeOffset();
125 
126  // The first entry in the adc_t array after the DetectorFragment::Header
127  // is the number of offsets
128 
129  *(dataBegin()) = (adc_t)dataBlockVec.size();
130  for (size_t cur_index = 0, cur_offset = dataBlockVec.size() + 1; cur_index < dataBlockVec.size(); cur_index++) {
131  // The first offset is always the position of the end of the offset list (dataBlockVec.size()+1)
132  // Include a factor of 8 so that the offsets are in units of 16-bit adc_t values (8 per 128-bit packet)
133  cur_offset += 8 * dataBlockVec[cur_index];
134  *(dataBegin() + 1 + cur_index) = (adc_t)cur_offset;
135  }
136  setDataBlockIndex(0);
137 
138  return;
139 }
140 
141 #endif /* mu2e_artdaq_Overlays_DetectorFragmentWriter_hh */