Export AliDAQ header file into include
[u/mrichter/AliRoot.git] / RAW / AliRawReaderRoot.cxx
CommitLineData
04fa961a 1/**************************************************************************
2 * Copyright(c) 1998-1999, ALICE Experiment at CERN, All rights reserved. *
3 * *
4 * Author: The ALICE Off-line Project. *
5 * Contributors are mentioned in the code where appropriate. *
6 * *
7 * Permission to use, copy, modify and distribute this software and its *
8 * documentation strictly for non-commercial purposes is hereby granted *
9 * without fee, provided that the above copyright notice appears in all *
10 * copies and that both the copyright notice and this permission notice *
11 * appear in the supporting documentation. The authors make no claims *
12 * about the suitability of this software for any purpose. It is *
13 * provided "as is" without express or implied warranty. *
14 **************************************************************************/
15
bea6b2a4 16/* $Id$ */
17
04fa961a 18///////////////////////////////////////////////////////////////////////////////
bea6b2a4 19///
20/// This is a class for reading raw data from a root file.
21///
22/// The root file is expected to contain a tree of name "RAW" with
23/// a branch of name "rawevent" which contains objects of type
24/// AliRawEvent.
25///
26/// The file name and the event number are arguments of the constructor
27/// of AliRawReaderRoot.
28///
04fa961a 29///////////////////////////////////////////////////////////////////////////////
30
a197a4ce 31#include <TFile.h>
32#include <TTree.h>
04fa961a 33#include "AliRawReaderRoot.h"
42d20574 34#include "AliRawEvent.h"
f2dc6b20 35#include "AliRawEventHeaderBase.h"
94d918a7 36#include "AliRawEquipment.h"
a197a4ce 37#include "AliRawEquipmentHeader.h"
38#include "AliRawData.h"
04fa961a 39
40
41ClassImp(AliRawReaderRoot)
42
43
dd9a70fe 44AliRawReaderRoot::AliRawReaderRoot(const char* fileName, Int_t eventNumber) :
45 fFile(NULL),
46 fBranch(NULL),
47 fEventIndex(eventNumber),
48 fEvent(NULL),
49 fSubEventIndex(0),
50 fSubEvent(NULL),
94d918a7 51 fEquipmentIndex(0),
52 fEquipment(NULL),
dd9a70fe 53 fRawData(NULL),
54 fPosition(NULL),
55 fEnd(NULL)
04fa961a 56{
57// create an object to read digits from the given input file for the
58// event with the given number
59
03c6d9a3 60 TDirectory* dir = gDirectory;
04fa961a 61 fFile = TFile::Open(fileName);
03c6d9a3 62 dir->cd();
04fa961a 63 if (!fFile || !fFile->IsOpen()) {
64 Error("AliRawReaderRoot", "could not open file %s", fileName);
65 return;
66 }
67 TTree* tree = (TTree*) fFile->Get("RAW");
68 if (!tree) {
69 Error("AliRawReaderRoot", "no raw data tree found");
70 return;
71 }
dd9a70fe 72 fBranch = tree->GetBranch("rawevent");
73 if (!fBranch) {
04fa961a 74 Error("AliRawReaderRoot", "no raw data branch found");
75 return;
76 }
77
78 fEvent = new AliRawEvent;
dd9a70fe 79 fBranch->SetAddress(&fEvent);
80 if (fEventIndex >= 0) {
81 if (fBranch->GetEntry(fEventIndex) <= 0) {
82 Error("AliRawReaderRoot", "no event with number %d found", fEventIndex);
83 return;
84 }
04fa961a 85 }
04fa961a 86}
87
dd9a70fe 88AliRawReaderRoot::AliRawReaderRoot(AliRawEvent* event) :
89 fFile(NULL),
90 fBranch(NULL),
91 fEventIndex(-1),
92 fEvent(event),
93 fSubEventIndex(0),
94 fSubEvent(NULL),
94d918a7 95 fEquipmentIndex(0),
96 fEquipment(NULL),
dd9a70fe 97 fRawData(NULL),
98 fPosition(NULL),
99 fEnd(NULL)
04fa961a 100{
101// create an object to read digits from the given raw event
102
04fa961a 103}
104
42d20574 105AliRawReaderRoot::AliRawReaderRoot(const AliRawReaderRoot& rawReader) :
dd9a70fe 106 AliRawReader(rawReader),
107 fFile(NULL),
108 fBranch(NULL),
109 fEventIndex(rawReader.fEventIndex),
110 fEvent(NULL),
111 fSubEventIndex(rawReader.fSubEventIndex),
112 fSubEvent(NULL),
94d918a7 113 fEquipmentIndex(rawReader.fEquipmentIndex),
114 fEquipment(NULL),
dd9a70fe 115 fRawData(NULL),
116 fPosition(NULL),
117 fEnd(NULL)
42d20574 118{
119// copy constructor
120
dd9a70fe 121 if (rawReader.fFile) {
122 TDirectory* dir = gDirectory;
123 fFile = TFile::Open(rawReader.fFile->GetName());
124 dir->cd();
125 if (!fFile || !fFile->IsOpen()) {
126 Error("AliRawReaderRoot", "could not open file %s",
127 rawReader.fFile->GetName());
128 return;
129 }
130 TTree* tree = (TTree*) fFile->Get("RAW");
131 if (!tree) {
132 Error("AliRawReaderRoot", "no raw data tree found");
133 return;
134 }
135 fBranch = tree->GetBranch("rawevent");
136 if (!fBranch) {
137 Error("AliRawReaderRoot", "no raw data branch found");
138 return;
139 }
140
141 fEvent = new AliRawEvent;
142 fBranch->SetAddress(&fEvent);
143 if (fEventIndex >= 0) {
144 if (fBranch->GetEntry(fEventIndex) <= 0) {
145 Error("AliRawReaderRoot", "no event with number %d found",
146 fEventIndex);
147 return;
148 }
149 }
150 } else {
151 fEvent = rawReader.fEvent;
152 }
153
154 if (fSubEventIndex > 0) {
155 fSubEvent = fEvent->GetSubEvent(fSubEventIndex-1);
94d918a7 156 fEquipment = fSubEvent->GetEquipment(fEquipmentIndex);
157 fRawData = fEquipment->GetRawData();
dd9a70fe 158 fCount = 0;
159 fHeader = (AliRawDataHeader*) ((UChar_t*) fRawData->GetBuffer() +
160 ((UChar_t*) rawReader.fHeader -
161 (UChar_t*) rawReader.fRawData->GetBuffer()));
162 fPosition = (UChar_t*) fRawData->GetBuffer() +
163 (rawReader.fPosition - (UChar_t*) rawReader.fRawData->GetBuffer());
164 fEnd = ((UChar_t*) fRawData->GetBuffer()) + fRawData->GetSize();
165 }
42d20574 166}
167
168AliRawReaderRoot& AliRawReaderRoot::operator = (const AliRawReaderRoot&
169 rawReader)
170{
171// assignment operator
172
173 this->~AliRawReaderRoot();
174 new(this) AliRawReaderRoot(rawReader);
175 return *this;
176}
177
04fa961a 178AliRawReaderRoot::~AliRawReaderRoot()
179{
180// delete objects and close root file
181
182 if (fFile) {
183 if (fEvent) delete fEvent;
184 fFile->Close();
185 delete fFile;
186 }
187}
188
189
42d20574 190UInt_t AliRawReaderRoot::GetType() const
04fa961a 191{
192// get the type from the event header
193
194 if (!fEvent) return 0;
f2dc6b20 195 return fEvent->GetHeader()->Get("Type");
04fa961a 196}
197
42d20574 198UInt_t AliRawReaderRoot::GetRunNumber() const
04fa961a 199{
200// get the run number from the event header
201
202 if (!fEvent) return 0;
f2dc6b20 203 return fEvent->GetHeader()->Get("RunNb");
04fa961a 204}
205
42d20574 206const UInt_t* AliRawReaderRoot::GetEventId() const
04fa961a 207{
208// get the event id from the event header
209
210 if (!fEvent) return NULL;
f2dc6b20 211 return fEvent->GetHeader()->GetP("Id");
04fa961a 212}
213
42d20574 214const UInt_t* AliRawReaderRoot::GetTriggerPattern() const
04fa961a 215{
216// get the trigger pattern from the event header
217
218 if (!fEvent) return NULL;
f2dc6b20 219 return fEvent->GetHeader()->GetP("TriggerPattern");
04fa961a 220}
221
42d20574 222const UInt_t* AliRawReaderRoot::GetDetectorPattern() const
04fa961a 223{
224// get the detector pattern from the event header
225
226 if (!fEvent) return NULL;
f2dc6b20 227 return fEvent->GetHeader()->GetP("DetectorPattern");
04fa961a 228}
229
42d20574 230const UInt_t* AliRawReaderRoot::GetAttributes() const
04fa961a 231{
232// get the type attributes from the event header
233
234 if (!fEvent) return NULL;
f2dc6b20 235 return fEvent->GetHeader()->GetP("TypeAttribute");
04fa961a 236}
237
e94ad92c 238const UInt_t* AliRawReaderRoot::GetSubEventAttributes() const
239{
240// get the type attributes from the sub event header
241
242 if (!fSubEvent) return NULL;
f2dc6b20 243 return fSubEvent->GetHeader()->GetP("TypeAttribute");
e94ad92c 244}
245
c946ab02 246UInt_t AliRawReaderRoot::GetLDCId() const
247{
248// get the LDC Id from the event header
249
94d918a7 250 if (!fEvent || !fSubEvent) return 0;
f2dc6b20 251 return fSubEvent->GetHeader()->Get("LdcId");
c946ab02 252}
253
42d20574 254UInt_t AliRawReaderRoot::GetGDCId() const
04fa961a 255{
256// get the GDC Id from the event header
257
258 if (!fEvent) return 0;
f2dc6b20 259 return fEvent->GetHeader()->Get("GdcId");
04fa961a 260}
261
262
c946ab02 263Int_t AliRawReaderRoot::GetEquipmentSize() const
264{
265// get the size of the equipment
266
94d918a7 267 if (!fEvent || !fEquipment || !fEquipment->GetEquipmentHeader()) return 0;
268 return fEquipment->GetEquipmentHeader()->GetEquipmentSize();
c946ab02 269}
270
271Int_t AliRawReaderRoot::GetEquipmentType() const
272{
273// get the type from the equipment header
274
94d918a7 275 if (!fEvent || !fEquipment || !fEquipment->GetEquipmentHeader()) return -1;
276 return fEquipment->GetEquipmentHeader()->GetEquipmentType();
c946ab02 277}
278
279Int_t AliRawReaderRoot::GetEquipmentId() const
280{
281// get the ID from the equipment header
282
94d918a7 283 if (!fEvent || !fEquipment || !fEquipment->GetEquipmentHeader()) return -1;
284 return fEquipment->GetEquipmentHeader()->GetId();
c946ab02 285}
286
287const UInt_t* AliRawReaderRoot::GetEquipmentAttributes() const
288{
289// get the attributes from the equipment header
290
94d918a7 291 if (!fEvent || !fEquipment || !fEquipment->GetEquipmentHeader()) return NULL;
292 return fEquipment->GetEquipmentHeader()->GetTypeAttribute();
c946ab02 293}
294
295Int_t AliRawReaderRoot::GetEquipmentElementSize() const
296{
297// get the basic element size from the equipment header
298
94d918a7 299 if (!fEvent || !fEquipment || !fEquipment->GetEquipmentHeader()) return 0;
300 return fEquipment->GetEquipmentHeader()->GetBasicSizeType();
c946ab02 301}
302
299738b9 303Int_t AliRawReaderRoot::GetEquipmentHeaderSize() const
304{
305// get the size of the equipment header (28 bytes by default)
306
307 if (!fEvent || !fEquipment || !fEquipment->GetEquipmentHeader()) return 0;
308 return fEquipment->GetEquipmentHeader()->HeaderSize();
309}
310
c946ab02 311
312Bool_t AliRawReaderRoot::ReadHeader()
04fa961a 313{
39f9963f 314// read a data header at the current position
315// returns kFALSE if the data header could not be read
04fa961a 316
b4857df7 317 fErrorCode = 0;
04fa961a 318 if (!fEvent) return kFALSE;
b4857df7 319
04fa961a 320 do {
b4857df7 321 // skip payload (if event was not selected)
322 if (fCount > 0) fPosition += fCount;
323
94d918a7 324 // get the first or the next equipment if at the end of an equipment
325 if (!fEquipment || (fPosition >= fEnd)) {
b4857df7 326
94d918a7 327 // get the first or the next sub event if at the end of a sub event
328 if (!fSubEvent || (fEquipmentIndex >= fSubEvent->GetNEquipments())) {
b4857df7 329
94d918a7 330 // check for end of event data
331 if (fSubEventIndex >= fEvent->GetNSubEvents()) return kFALSE;
332 fSubEvent = fEvent->GetSubEvent(fSubEventIndex++);
333
334 // check the magic word of the sub event
335 if (!fSubEvent->GetHeader()->IsValid()) {
336 Error("ReadHeader", "wrong magic number in sub event!");
337 fSubEvent->GetHeader()->Dump();
338 fErrorCode = kErrMagic;
339 return kFALSE;
340 }
341
342 fEquipmentIndex = 0;
343 fEquipment = NULL;
344 fRawData = NULL;
b4857df7 345 }
346
94d918a7 347 // get the next equipment and raw data
04fa961a 348 fCount = 0;
94d918a7 349 fEquipment = fSubEvent->GetEquipment(fEquipmentIndex++);
350 if (!fEquipment) continue;
351 fRawData = fEquipment->GetRawData();
352 if (!fRawData) {
353 fPosition = fEnd;
354 continue;
355 }
04fa961a 356 fPosition = (UChar_t*) fRawData->GetBuffer();
357 fEnd = ((UChar_t*) fRawData->GetBuffer()) + fRawData->GetSize();
358 }
b4857df7 359
94d918a7 360 // continue with the next equipment if no data left in the payload
b4857df7 361 if (fPosition >= fEnd) continue;
362
18882b3b 363 if (fRequireHeader) {
364 // check that there are enough bytes left for the data header
365 if (fPosition + sizeof(AliRawDataHeader) > fEnd) {
366 Error("ReadHeader", "could not read data header!");
367 Warning("ReadHeader", "skipping %d bytes", fEnd - fPosition);
368 fEquipment->GetEquipmentHeader()->Dump();
369 fCount = 0;
370 fPosition = fEnd;
371 fErrorCode = kErrNoDataHeader;
372 continue;
373 }
374
375 // "read" the data header
376 fHeader = (AliRawDataHeader*) fPosition;
299738b9 377 if ((fPosition + fHeader->fSize) != fEnd) {
378 Warning("ReadHeader",
379 "raw data size found in the header is wrong (%d != %d)! Using the equipment size instead !",
380 fHeader->fSize, fEnd - fPosition);
381 fHeader->fSize = fEnd - fPosition;
382 }
18882b3b 383 fPosition += sizeof(AliRawDataHeader);
04fa961a 384 }
b4857df7 385
7c726b91 386 if (fHeader && (fHeader->fSize != 0xFFFFFFFF)) {
39f9963f 387 fCount = fHeader->fSize - sizeof(AliRawDataHeader);
7c726b91 388
389 // check consistency of data size in the header and in the sub event
390 if (fPosition + fCount > fEnd) {
391 Error("ReadHeader", "size in data header exceeds event size!");
392 Warning("ReadHeader", "skipping %d bytes", fEnd - fPosition);
393 fEquipment->GetEquipmentHeader()->Dump();
394 fCount = 0;
395 fPosition = fEnd;
396 fErrorCode = kErrSize;
397 continue;
398 }
399
39f9963f 400 } else {
401 fCount = fEnd - fPosition;
72dd1d4f 402 }
b4857df7 403
04fa961a 404 } while (!IsSelected());
b4857df7 405
04fa961a 406 return kTRUE;
407}
408
409Bool_t AliRawReaderRoot::ReadNextData(UChar_t*& data)
410{
411// reads the next payload at the current position
412// returns kFALSE if the data could not be read
413
b4857df7 414 fErrorCode = 0;
04fa961a 415 while (fCount == 0) {
c946ab02 416 if (!ReadHeader()) return kFALSE;
04fa961a 417 }
418 data = fPosition;
419 fPosition += fCount;
420 fCount = 0;
421 return kTRUE;
422}
423
424Bool_t AliRawReaderRoot::ReadNext(UChar_t* data, Int_t size)
425{
426// reads the next block of data at the current position
427// returns kFALSE if the data could not be read
428
b4857df7 429 fErrorCode = 0;
04fa961a 430 if (fPosition + size > fEnd) {
431 Error("ReadNext", "could not read data!");
b4857df7 432 fErrorCode = kErrOutOfBounds;
04fa961a 433 return kFALSE;
434 }
435 memcpy(data, fPosition, size);
436 fPosition += size;
437 fCount -= size;
438 return kTRUE;
439}
440
441
442Bool_t AliRawReaderRoot::Reset()
443{
444// reset the current position to the beginning of the event
445
446 fSubEventIndex = 0;
447 fSubEvent = NULL;
94d918a7 448 fEquipmentIndex = 0;
449 fEquipment = NULL;
04fa961a 450 fRawData = NULL;
39f9963f 451 fHeader = NULL;
04fa961a 452
453 fCount = 0;
454 fPosition = fEnd = NULL;
455 return kTRUE;
456}
457
b4857df7 458
dd9a70fe 459Bool_t AliRawReaderRoot::NextEvent()
460{
461// go to the next event in the root file
462
463 if (!fFile) return kFALSE;
464
465 do {
d41ecdd0 466 delete fEvent;
467 fEvent = new AliRawEvent;
468 fBranch->SetAddress(&fEvent);
469 if (fBranch->GetEntry(fEventIndex+1) <= 0)
dd9a70fe 470 return kFALSE;
dd9a70fe 471 fEventIndex++;
472 } while (!IsEventSelected());
473 return Reset();
474}
475
476Bool_t AliRawReaderRoot::RewindEvents()
477{
478// go back to the beginning of the root file
479
480 if (!fFile) return kFALSE;
481
482 fEventIndex = -1;
483 delete fEvent;
484 fEvent = new AliRawEvent;
485 fBranch->SetAddress(&fEvent);
486 return Reset();
487}
488
489
b4857df7 490Int_t AliRawReaderRoot::CheckData() const
491{
492// check the consistency of the data
493
494 if (!fEvent) return 0;
495
496 AliRawEvent* subEvent = NULL;
497 Int_t subEventIndex = 0;
94d918a7 498 AliRawEquipment* equipment = NULL;
499 Int_t equipmentIndex = 0;
b4857df7 500 UChar_t* position = 0;
501 UChar_t* end = 0;
be50fca2 502 Int_t result = 0;
b4857df7 503
504 while (kTRUE) {
94d918a7 505 // get the first or the next sub event if at the end of an equipment
506 if (!subEvent || (equipmentIndex >= subEvent->GetNEquipments())) {
b4857df7 507
508 // check for end of event data
be50fca2 509 if (subEventIndex >= fEvent->GetNSubEvents()) return result;
b4857df7 510 subEvent = fEvent->GetSubEvent(subEventIndex++);
511
512 // check the magic word of the sub event
be50fca2 513 if (!fSubEvent->GetHeader()->IsValid()) {
514 result |= kErrMagic;
515 return result;
516 }
b4857df7 517
94d918a7 518 equipmentIndex = 0;
b4857df7 519 }
520
94d918a7 521 // get the next equipment and raw data
522 equipment = subEvent->GetEquipment(equipmentIndex++);
523 if (!equipment) continue;
524 AliRawData* rawData = equipment->GetRawData();
525 if (!rawData) continue;
526 position = (UChar_t*) rawData->GetBuffer();
527 end = ((UChar_t*) rawData->GetBuffer()) + rawData->GetSize();
528
b4857df7 529 // continue with the next sub event if no data left in the payload
530 if (position >= end) continue;
531
18882b3b 532 if (fRequireHeader) {
39f9963f 533 // check that there are enough bytes left for the data header
18882b3b 534 if (position + sizeof(AliRawDataHeader) > end) {
535 result |= kErrNoDataHeader;
536 continue;
537 }
b4857df7 538
18882b3b 539 // check consistency of data size in the header and in the equipment
540 AliRawDataHeader* header = (AliRawDataHeader*) position;
299738b9 541 if ((position + header->fSize) != end) {
542 Warning("ReadHeader",
543 "raw data size found in the header is wrong (%d != %d)! Using the equipment size instead !",
544 header->fSize, end - position);
545 header->fSize = end - position;
546 result |= kErrSize;
39f9963f 547 }
be50fca2 548 }
299738b9 549 position = end;
b4857df7 550 };
fd0de2e2 551
552 return result;
b4857df7 553}