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