Restored compilation on Windows/Cygwin
[u/mrichter/AliRoot.git] / RAW / AliRawReaderDate.cxx
CommitLineData
16048fcf 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
16048fcf 18///////////////////////////////////////////////////////////////////////////////
bea6b2a4 19///
20/// This is a class for reading raw data from a date file or event.
21///
22/// The AliRawReaderDate is constructed either with a pointer to a
23/// date event or with a file name and an event number.
24///
16048fcf 25///////////////////////////////////////////////////////////////////////////////
26
27#include "AliRawReaderDate.h"
28#ifdef ALI_DATE
29#include "event.h"
30#endif
31
32ClassImp(AliRawReaderDate)
33
34
35AliRawReaderDate::AliRawReaderDate(
36#ifdef ALI_DATE
37 void* event
38#else
39 void* /* event */
40#endif
c946ab02 41 ) :
dd9a70fe 42 fFile(NULL),
c946ab02 43 fEvent(NULL),
44 fSubEvent(NULL),
45 fEquipment(NULL),
c946ab02 46 fPosition(NULL),
47 fEnd(NULL)
16048fcf 48{
49// create an object to read digits from the given date event
50
51#ifdef ALI_DATE
52 fEvent = (eventHeaderStruct*) event;
c946ab02 53#else
54 Fatal("AliRawReaderDate", "this class was compiled without DATE");
55#endif
56}
57
58AliRawReaderDate::AliRawReaderDate(
59#ifdef ALI_DATE
60 const char* fileName, Int_t eventNumber
61#else
62 const char* /*fileName*/,
63 Int_t /*eventNumber*/
64#endif
65 ) :
dd9a70fe 66 fFile(NULL),
c946ab02 67 fEvent(NULL),
68 fSubEvent(NULL),
69 fEquipment(NULL),
c946ab02 70 fPosition(NULL),
71 fEnd(NULL)
72{
73// create an object to read digits from the given date event
74
75#ifdef ALI_DATE
dd9a70fe 76 fFile = fopen(fileName, "rb");
77 if (!fFile) {
c946ab02 78 Error("AliRawReaderDate", "could not open file %s", fileName);
79 return;
80 }
dd9a70fe 81 if (eventNumber < 0) return;
82
c946ab02 83 eventHeaderStruct header;
84 UInt_t headerSize = sizeof(eventHeaderStruct);
dd9a70fe 85 while (fread(&header, 1, headerSize, fFile) == headerSize) {
c946ab02 86 if (eventNumber == 0) {
87 UChar_t* buffer = new UChar_t[header.eventSize];
b91d160c 88 fseek(fFile, -(long)headerSize, SEEK_CUR);
dd9a70fe 89 if (fread(buffer, 1, header.eventSize, fFile) != header.eventSize) break;
c946ab02 90 fEvent = (eventHeaderStruct*) buffer;
c946ab02 91 break;
92 }
dd9a70fe 93 fseek(fFile, header.eventSize-headerSize, SEEK_CUR);
c946ab02 94 eventNumber--;
95 }
c946ab02 96
16048fcf 97#else
98 Fatal("AliRawReaderDate", "this class was compiled without DATE");
99#endif
100}
101
102AliRawReaderDate::AliRawReaderDate(const AliRawReaderDate& rawReader) :
c946ab02 103 AliRawReader(rawReader),
dd9a70fe 104 fFile(rawReader.fFile),
c946ab02 105 fEvent(rawReader.fEvent),
106 fSubEvent(rawReader.fSubEvent),
107 fEquipment(rawReader.fEquipment),
c946ab02 108 fPosition(rawReader.fPosition),
109 fEnd(rawReader.fEnd)
110
16048fcf 111{
112// copy constructor
113
dd9a70fe 114 Fatal("AliRawReaderDate", "copy constructor not implemented");
16048fcf 115}
116
117AliRawReaderDate& AliRawReaderDate::operator = (const AliRawReaderDate&
dd9a70fe 118 /*rawReader*/)
16048fcf 119{
120// assignment operator
121
dd9a70fe 122 Fatal("operator =", "assignment operator not implemented");
16048fcf 123 return *this;
124}
125
c946ab02 126AliRawReaderDate::~AliRawReaderDate()
127{
128// destructor
129
130#ifdef ALI_DATE
dd9a70fe 131 if (fFile) {
132 delete[] fEvent;
133 fclose(fFile);
134 }
c946ab02 135#endif
136}
137
16048fcf 138
139UInt_t AliRawReaderDate::GetType() const
140{
141// get the type from the event header
142
143#ifdef ALI_DATE
144 if (!fEvent) return 0;
145 return fEvent->eventType;
146#else
147 return 0;
148#endif
149}
150
151UInt_t AliRawReaderDate::GetRunNumber() const
152{
153// get the run number from the event header
154
155#ifdef ALI_DATE
156 if (!fEvent) return 0;
157 return fEvent->eventRunNb;
158#else
159 return 0;
160#endif
161}
162
163const UInt_t* AliRawReaderDate::GetEventId() const
164{
165// get the event id from the event header
166
167#ifdef ALI_DATE
168 if (!fEvent) return NULL;
169 return fEvent->eventId;
170#else
171 return NULL;
172#endif
173}
174
175const UInt_t* AliRawReaderDate::GetTriggerPattern() const
176{
177// get the trigger pattern from the event header
178
179#ifdef ALI_DATE
180 if (!fEvent) return NULL;
181 return fEvent->eventTriggerPattern;
182#else
183 return NULL;
184#endif
185}
186
187const UInt_t* AliRawReaderDate::GetDetectorPattern() const
188{
189// get the detector pattern from the event header
190
191#ifdef ALI_DATE
192 if (!fEvent) return NULL;
193 return fEvent->eventDetectorPattern;
194#else
195 return NULL;
196#endif
197}
198
199const UInt_t* AliRawReaderDate::GetAttributes() const
200{
201// get the type attributes from the event header
202
203#ifdef ALI_DATE
204 if (!fEvent) return NULL;
205 return fEvent->eventTypeAttribute;
206#else
207 return NULL;
208#endif
209}
210
e94ad92c 211const UInt_t* AliRawReaderDate::GetSubEventAttributes() const
212{
213// get the type attributes from the sub event header
214
215#ifdef ALI_DATE
216 if (!fSubEvent) return NULL;
217 return fSubEvent->eventTypeAttribute;
218#else
219 return NULL;
220#endif
221}
222
c946ab02 223UInt_t AliRawReaderDate::GetLDCId() const
224{
225// get the LDC Id from the event header
226
227#ifdef ALI_DATE
228 if (!fSubEvent) return 0;
229 return fSubEvent->eventLdcId;
230#else
231 return 0;
232#endif
233}
234
16048fcf 235UInt_t AliRawReaderDate::GetGDCId() const
236{
237// get the GDC Id from the event header
238
239#ifdef ALI_DATE
240 if (!fEvent) return 0;
241 return fEvent->eventGdcId;
242#else
243 return 0;
244#endif
245}
246
741c154c 247UInt_t AliRawReaderDate::GetTimestamp() const
248{
249// get the timestamp from the event header
250
251#ifdef ALI_DATE
252 if (!fEvent) return 0;
253 return fEvent->eventTimestamp;
254#else
255 return 0;
256#endif
257}
16048fcf 258
c946ab02 259Int_t AliRawReaderDate::GetEquipmentSize() const
260{
299738b9 261// get the size of the equipment (including the header)
c946ab02 262
263#ifdef ALI_DATE
264 if (!fEquipment) return 0;
87db01b0 265 if (fSubEvent->eventVersion <= 0x00030001) {
299738b9 266 return fEquipment->equipmentSize + sizeof(equipmentHeaderStruct);
87db01b0 267 } else {
299738b9 268 return fEquipment->equipmentSize;
87db01b0 269 }
c946ab02 270#else
271 return 0;
272#endif
273}
274
275Int_t AliRawReaderDate::GetEquipmentType() const
276{
277// get the type from the equipment header
278
279#ifdef ALI_DATE
280 if (!fEquipment) return -1;
281 return fEquipment->equipmentType;
282#else
283 return 0;
284#endif
285}
286
287Int_t AliRawReaderDate::GetEquipmentId() const
288{
289// get the ID from the equipment header
290
291#ifdef ALI_DATE
292 if (!fEquipment) return -1;
293 return fEquipment->equipmentId;
294#else
295 return 0;
296#endif
297}
298
299const UInt_t* AliRawReaderDate::GetEquipmentAttributes() const
300{
301// get the attributes from the equipment header
302
303#ifdef ALI_DATE
304 if (!fEquipment) return NULL;
305 return fEquipment->equipmentTypeAttribute;
306#else
307 return 0;
308#endif
309}
310
311Int_t AliRawReaderDate::GetEquipmentElementSize() const
312{
313// get the basic element size from the equipment header
314
315#ifdef ALI_DATE
316 if (!fEquipment) return 0;
317 return fEquipment->equipmentBasicElementSize;
318#else
319 return 0;
320#endif
321}
322
299738b9 323Int_t AliRawReaderDate::GetEquipmentHeaderSize() const
324{
325 // Get the equipment header size
326 // 28 bytes by default
327#ifdef ALI_DATE
328 return sizeof(equipmentHeaderStruct);
329#else
330 return 0;
331#endif
332}
c946ab02 333
334Bool_t AliRawReaderDate::ReadHeader()
16048fcf 335{
39f9963f 336// read a data header at the current position
337// returns kFALSE if the data header could not be read
16048fcf 338
b4857df7 339 fErrorCode = 0;
340
16048fcf 341#ifdef ALI_DATE
921a8308 342 fHeader = NULL;
16048fcf 343 if (!fEvent) return kFALSE;
b4857df7 344 // check whether there are sub events
345 if (fEvent->eventSize <= fEvent->eventHeadSize) return kFALSE;
346
16048fcf 347 do {
b4857df7 348 // skip payload (if event was not selected)
349 if (fCount > 0) fPosition += fCount;
350
c946ab02 351 // get the first or the next equipment if at the end of an equipment
352 if (!fEquipment || (fPosition >= fEnd)) {
921a8308 353 fEquipment = NULL;
c946ab02 354
355 // get the first or the next sub event if at the end of a sub event
356 if (!fSubEvent ||
357 (fPosition >= ((UChar_t*)fSubEvent) + fSubEvent->eventSize)) {
358
359 // check for end of event data
360 if (fPosition >= ((UChar_t*)fEvent)+fEvent->eventSize) return kFALSE;
5ba96ac1 361 if (!TEST_SYSTEM_ATTRIBUTE(fEvent->eventTypeAttribute,
362 ATTR_SUPER_EVENT)) {
363 fSubEvent = fEvent; // no super event
364 } else if (fSubEvent) {
c946ab02 365 fSubEvent = (eventHeaderStruct*) (((UChar_t*)fSubEvent) +
366 fSubEvent->eventSize);
367 } else {
368 fSubEvent = (eventHeaderStruct*) (((UChar_t*)fEvent) +
369 fEvent->eventHeadSize);
370 }
371
372 // check the magic word of the sub event
373 if (fSubEvent->eventMagic != EVENT_MAGIC_NUMBER) {
374 Error("ReadHeader", "wrong magic number in sub event!\n"
375 " run: %d event: %d %d LDC: %d GDC: %d\n",
376 fSubEvent->eventRunNb,
377 fSubEvent->eventId[0], fSubEvent->eventId[1],
378 fSubEvent->eventLdcId, fSubEvent->eventGdcId);
379 fErrorCode = kErrMagic;
380 return kFALSE;
381 }
382
921a8308 383 // continue if no data in the subevent
384 if (fSubEvent->eventSize == fSubEvent->eventHeadSize) {
385 fPosition = fEnd = ((UChar_t*)fSubEvent) + fSubEvent->eventSize;
386 fCount = 0;
387 continue;
388 }
389
c946ab02 390 fEquipment = (equipmentHeaderStruct*)
391 (((UChar_t*)fSubEvent) + fSubEvent->eventHeadSize);
b4857df7 392
16048fcf 393 } else {
c946ab02 394 fEquipment = (equipmentHeaderStruct*) fEnd;
b4857df7 395 }
396
16048fcf 397 fCount = 0;
c946ab02 398 fPosition = ((UChar_t*)fEquipment) + sizeof(equipmentHeaderStruct);
87db01b0 399 if (fSubEvent->eventVersion <= 0x00030001) {
921a8308 400 fEnd = fPosition + fEquipment->equipmentSize;
401 } else {
402 fEnd = ((UChar_t*)fEquipment) + fEquipment->equipmentSize;
403 }
16048fcf 404 }
b4857df7 405
406 // continue with the next sub event if no data left in the payload
407 if (fPosition >= fEnd) continue;
408
39f9963f 409 if (fRequireHeader) {
410 // check that there are enough bytes left for the data header
411 if (fPosition + sizeof(AliRawDataHeader) > fEnd) {
412 Error("ReadHeader", "could not read data header data!");
c946ab02 413 Warning("ReadHeader", "skipping %d bytes\n"
414 " run: %d event: %d %d LDC: %d GDC: %d\n",
415 fEnd - fPosition, fSubEvent->eventRunNb,
416 fSubEvent->eventId[0], fSubEvent->eventId[1],
417 fSubEvent->eventLdcId, fSubEvent->eventGdcId);
418 fCount = 0;
419 fPosition = fEnd;
39f9963f 420 fErrorCode = kErrNoDataHeader;
c946ab02 421 continue;
422 }
b4857df7 423
39f9963f 424 // "read" the data header
425 fHeader = (AliRawDataHeader*) fPosition;
299738b9 426 if ((fPosition + fHeader->fSize) != fEnd) {
806e573c 427 if (fHeader->fSize != 0xFFFFFFFF)
428 Warning("ReadHeader",
429 "raw data size found in the header is wrong (%d != %d)! Using the equipment size instead !",
430 fHeader->fSize, fEnd - fPosition);
299738b9 431 fHeader->fSize = fEnd - fPosition;
432 }
39f9963f 433 fPosition += sizeof(AliRawDataHeader);
72dd1d4f 434 }
c946ab02 435
39f9963f 436 if (fHeader && (fHeader->fSize != 0xFFFFFFFF)) {
437 fCount = fHeader->fSize - sizeof(AliRawDataHeader);
c946ab02 438
39f9963f 439 // check consistency of data size in the header and in the sub event
c946ab02 440 if (fPosition + fCount > fEnd) {
39f9963f 441 Error("ReadHeader", "size in data header exceeds event size!");
c946ab02 442 Warning("ReadHeader", "skipping %d bytes\n"
443 " run: %d event: %d %d LDC: %d GDC: %d\n",
444 fEnd - fPosition, fSubEvent->eventRunNb,
445 fSubEvent->eventId[0], fSubEvent->eventId[1],
446 fSubEvent->eventLdcId, fSubEvent->eventGdcId);
447 fCount = 0;
448 fPosition = fEnd;
449 fErrorCode = kErrSize;
450 continue;
451 }
452
453 } else {
454 fCount = fEnd - fPosition;
16048fcf 455 }
b4857df7 456
921a8308 457 } while (!fEquipment || !IsSelected());
b4857df7 458
16048fcf 459 return kTRUE;
460#else
461 return kFALSE;
462#endif
463}
464
465Bool_t AliRawReaderDate::ReadNextData(UChar_t*& data)
466{
467// reads the next payload at the current position
468// returns kFALSE if the data could not be read
469
b4857df7 470 fErrorCode = 0;
16048fcf 471 while (fCount == 0) {
c946ab02 472 if (!ReadHeader()) return kFALSE;
16048fcf 473 }
474 data = fPosition;
475 fPosition += fCount;
476 fCount = 0;
477 return kTRUE;
478}
479
480Bool_t AliRawReaderDate::ReadNext(UChar_t* data, Int_t size)
481{
482// reads the next block of data at the current position
483// returns kFALSE if the data could not be read
484
b4857df7 485 fErrorCode = 0;
16048fcf 486 if (fPosition + size > fEnd) {
487 Error("ReadNext", "could not read data!");
b4857df7 488 fErrorCode = kErrOutOfBounds;
16048fcf 489 return kFALSE;
490 }
491 memcpy(data, fPosition, size);
492 fPosition += size;
493 fCount -= size;
494 return kTRUE;
495}
496
497
498Bool_t AliRawReaderDate::Reset()
499{
500// reset the current position to the beginning of the event
501
502#ifdef ALI_DATE
503 fSubEvent = NULL;
d7aa1c7c 504 fEquipment = NULL;
16048fcf 505#endif
506 fCount = 0;
507 fPosition = fEnd = NULL;
508 return kTRUE;
509}
b4857df7 510
511
dd9a70fe 512Bool_t AliRawReaderDate::NextEvent()
513{
514// go to the next event in the date file
515
5bec8712 516#ifdef ALI_DATE
b04576f7 517 if (!fFile) {
518 if (fEventNumber < 0 && fEvent) {
519 fEventNumber++;
520 return kTRUE;
521 }
522 else
523 return kFALSE;
524 }
dd9a70fe 525
d7aa1c7c 526 Reset();
dd9a70fe 527 eventHeaderStruct header;
528 UInt_t headerSize = sizeof(eventHeaderStruct);
529 if (fEvent) delete[] fEvent;
530 fEvent = &header;
531
532 while (fread(&header, 1, headerSize, fFile) == headerSize) {
533 if (!IsEventSelected()) {
534 fseek(fFile, header.eventSize-headerSize, SEEK_CUR);
535 continue;
536 }
537 UChar_t* buffer = new UChar_t[header.eventSize];
b91d160c 538 fseek(fFile, -(long)headerSize, SEEK_CUR);
dd9a70fe 539 if (fread(buffer, 1, header.eventSize, fFile) != header.eventSize) {
540 Error("NextEvent", "could not read event from file");
541 delete[] buffer;
542 break;
543 }
544 fEvent = (eventHeaderStruct*) buffer;
38cf12f3 545 fEventNumber++;
dd9a70fe 546 return kTRUE;
547 };
548
549 fEvent = NULL;
bba5b21b 550#endif
5bec8712 551
dd9a70fe 552 return kFALSE;
553}
554
555Bool_t AliRawReaderDate::RewindEvents()
556{
557// go back to the beginning of the date file
558
b04576f7 559 if (fFile)
560 fseek(fFile, 0, SEEK_SET);
dd9a70fe 561
38cf12f3 562 fEventNumber = -1;
dd9a70fe 563 return Reset();
564}
565
566
b4857df7 567Int_t AliRawReaderDate::CheckData() const
568{
569// check the consistency of the data
570
571#ifdef ALI_DATE
572 if (!fEvent) return 0;
573 // check whether there are sub events
574 if (fEvent->eventSize <= fEvent->eventHeadSize) return 0;
575
576 eventHeaderStruct* subEvent = NULL;
577 UChar_t* position = 0;
578 UChar_t* end = 0;
be50fca2 579 Int_t result = 0;
b4857df7 580
581 while (kTRUE) {
582 // get the first or the next sub event if at the end of a sub event
583 if (!subEvent || (position >= end)) {
584
585 // check for end of event data
be50fca2 586 if (position >= ((UChar_t*)fEvent)+fEvent->eventSize) return result;
5ba96ac1 587 if (!TEST_SYSTEM_ATTRIBUTE(fEvent->eventTypeAttribute,
588 ATTR_SUPER_EVENT)) {
589 subEvent = fEvent; // no super event
590 } else if (subEvent) {
b4857df7 591 subEvent = (eventHeaderStruct*) (((UChar_t*)subEvent) +
592 subEvent->eventSize);
593 } else {
594 subEvent = (eventHeaderStruct*) (((UChar_t*)fEvent) +
595 fEvent->eventHeadSize);
596 }
597
598 // check the magic word of the sub event
be50fca2 599 if (subEvent->eventMagic != EVENT_MAGIC_NUMBER) {
600 result |= kErrMagic;
601 return result;
602 }
b4857df7 603
604 position = ((UChar_t*)subEvent) + subEvent->eventHeadSize +
605 sizeof(equipmentHeaderStruct);
606 end = ((UChar_t*)subEvent) + subEvent->eventSize;
607 }
608
609 // continue with the next sub event if no data left in the payload
610 if (position >= end) continue;
611
18882b3b 612 if (fRequireHeader) {
39f9963f 613 // check that there are enough bytes left for the data header
18882b3b 614 if (position + sizeof(AliRawDataHeader) > end) {
615 result |= kErrNoDataHeader;
39f9963f 616 position = end;
18882b3b 617 continue;
618 }
619
620 // check consistency of data size in the data header and in the sub event
621 AliRawDataHeader* header = (AliRawDataHeader*) position;
299738b9 622 if ((position + header->fSize) != end) {
806e573c 623 if (header->fSize != 0xFFFFFFFF)
624 Warning("ReadHeader",
625 "raw data size found in the header is wrong (%d != %d)! Using the equipment size instead !",
626 header->fSize, end - position);
299738b9 627 header->fSize = end - position;
628 result |= kErrSize;
39f9963f 629 }
be50fca2 630 }
18882b3b 631 position = end;
b4857df7 632 };
633
634#endif
635 return 0;
636}