1 /**************************************************************************
2 * Copyright(c) 1998-1999, ALICE Experiment at CERN, All rights reserved. *
4 * Author: The ALICE Off-line Project. *
5 * Contributors are mentioned in the code where appropriate. *
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 **************************************************************************/
18 ///////////////////////////////////////////////////////////////////////////////
20 /// This is a class for reading raw data from a date file or event.
22 /// The AliRawReaderDate is constructed either with a pointer to a
23 /// date event or with a file name and an event number.
25 ///////////////////////////////////////////////////////////////////////////////
27 #include "AliRawReaderDate.h"
32 ClassImp(AliRawReaderDate)
35 AliRawReaderDate::AliRawReaderDate(
49 // create an object to read digits from the given date event
52 fEvent = (eventHeaderStruct*) event;
54 Fatal("AliRawReaderDate", "this class was compiled without DATE");
58 AliRawReaderDate::AliRawReaderDate(
60 const char* fileName, Int_t eventNumber
62 const char* /*fileName*/,
73 // create an object to read digits from the given date event
76 fFile = fopen(fileName, "rb");
78 Error("AliRawReaderDate", "could not open file %s", fileName);
81 if (eventNumber < 0) return;
83 eventHeaderStruct header;
84 UInt_t headerSize = sizeof(eventHeaderStruct);
85 while (fread(&header, 1, headerSize, fFile) == headerSize) {
86 if (eventNumber == 0) {
87 UChar_t* buffer = new UChar_t[header.eventSize];
88 fseek(fFile, -headerSize, SEEK_CUR);
89 if (fread(buffer, 1, header.eventSize, fFile) != header.eventSize) break;
90 fEvent = (eventHeaderStruct*) buffer;
93 fseek(fFile, header.eventSize-headerSize, SEEK_CUR);
98 Fatal("AliRawReaderDate", "this class was compiled without DATE");
102 AliRawReaderDate::AliRawReaderDate(const AliRawReaderDate& rawReader) :
103 AliRawReader(rawReader),
104 fFile(rawReader.fFile),
105 fEvent(rawReader.fEvent),
106 fSubEvent(rawReader.fSubEvent),
107 fEquipment(rawReader.fEquipment),
108 fPosition(rawReader.fPosition),
114 Fatal("AliRawReaderDate", "copy constructor not implemented");
117 AliRawReaderDate& AliRawReaderDate::operator = (const AliRawReaderDate&
120 // assignment operator
122 Fatal("operator =", "assignment operator not implemented");
126 AliRawReaderDate::~AliRawReaderDate()
139 UInt_t AliRawReaderDate::GetType() const
141 // get the type from the event header
144 if (!fEvent) return 0;
145 return fEvent->eventType;
151 UInt_t AliRawReaderDate::GetRunNumber() const
153 // get the run number from the event header
156 if (!fEvent) return 0;
157 return fEvent->eventRunNb;
163 const UInt_t* AliRawReaderDate::GetEventId() const
165 // get the event id from the event header
168 if (!fEvent) return NULL;
169 return fEvent->eventId;
175 const UInt_t* AliRawReaderDate::GetTriggerPattern() const
177 // get the trigger pattern from the event header
180 if (!fEvent) return NULL;
181 return fEvent->eventTriggerPattern;
187 const UInt_t* AliRawReaderDate::GetDetectorPattern() const
189 // get the detector pattern from the event header
192 if (!fEvent) return NULL;
193 return fEvent->eventDetectorPattern;
199 const UInt_t* AliRawReaderDate::GetAttributes() const
201 // get the type attributes from the event header
204 if (!fEvent) return NULL;
205 return fEvent->eventTypeAttribute;
211 const UInt_t* AliRawReaderDate::GetSubEventAttributes() const
213 // get the type attributes from the sub event header
216 if (!fSubEvent) return NULL;
217 return fSubEvent->eventTypeAttribute;
223 UInt_t AliRawReaderDate::GetLDCId() const
225 // get the LDC Id from the event header
228 if (!fSubEvent) return 0;
229 return fSubEvent->eventLdcId;
235 UInt_t AliRawReaderDate::GetGDCId() const
237 // get the GDC Id from the event header
240 if (!fEvent) return 0;
241 return fEvent->eventGdcId;
248 Int_t AliRawReaderDate::GetEquipmentSize() const
250 // get the size of the equipment (including the header)
253 if (!fEquipment) return 0;
254 if (fSubEvent->eventVersion <= 0x00030001) {
255 return fEquipment->equipmentSize + sizeof(equipmentHeaderStruct);
257 return fEquipment->equipmentSize;
264 Int_t AliRawReaderDate::GetEquipmentType() const
266 // get the type from the equipment header
269 if (!fEquipment) return -1;
270 return fEquipment->equipmentType;
276 Int_t AliRawReaderDate::GetEquipmentId() const
278 // get the ID from the equipment header
281 if (!fEquipment) return -1;
282 return fEquipment->equipmentId;
288 const UInt_t* AliRawReaderDate::GetEquipmentAttributes() const
290 // get the attributes from the equipment header
293 if (!fEquipment) return NULL;
294 return fEquipment->equipmentTypeAttribute;
300 Int_t AliRawReaderDate::GetEquipmentElementSize() const
302 // get the basic element size from the equipment header
305 if (!fEquipment) return 0;
306 return fEquipment->equipmentBasicElementSize;
312 Int_t AliRawReaderDate::GetEquipmentHeaderSize() const
314 // Get the equipment header size
315 // 28 bytes by default
317 return sizeof(equipmentHeaderStruct);
323 Bool_t AliRawReaderDate::ReadHeader()
325 // read a data header at the current position
326 // returns kFALSE if the data header could not be read
332 if (!fEvent) return kFALSE;
333 // check whether there are sub events
334 if (fEvent->eventSize <= fEvent->eventHeadSize) return kFALSE;
337 // skip payload (if event was not selected)
338 if (fCount > 0) fPosition += fCount;
340 // get the first or the next equipment if at the end of an equipment
341 if (!fEquipment || (fPosition >= fEnd)) {
344 // get the first or the next sub event if at the end of a sub event
346 (fPosition >= ((UChar_t*)fSubEvent) + fSubEvent->eventSize)) {
348 // check for end of event data
349 if (fPosition >= ((UChar_t*)fEvent)+fEvent->eventSize) return kFALSE;
350 if (!TEST_SYSTEM_ATTRIBUTE(fEvent->eventTypeAttribute,
352 fSubEvent = fEvent; // no super event
353 } else if (fSubEvent) {
354 fSubEvent = (eventHeaderStruct*) (((UChar_t*)fSubEvent) +
355 fSubEvent->eventSize);
357 fSubEvent = (eventHeaderStruct*) (((UChar_t*)fEvent) +
358 fEvent->eventHeadSize);
361 // check the magic word of the sub event
362 if (fSubEvent->eventMagic != EVENT_MAGIC_NUMBER) {
363 Error("ReadHeader", "wrong magic number in sub event!\n"
364 " run: %d event: %d %d LDC: %d GDC: %d\n",
365 fSubEvent->eventRunNb,
366 fSubEvent->eventId[0], fSubEvent->eventId[1],
367 fSubEvent->eventLdcId, fSubEvent->eventGdcId);
368 fErrorCode = kErrMagic;
372 // continue if no data in the subevent
373 if (fSubEvent->eventSize == fSubEvent->eventHeadSize) {
374 fPosition = fEnd = ((UChar_t*)fSubEvent) + fSubEvent->eventSize;
379 fEquipment = (equipmentHeaderStruct*)
380 (((UChar_t*)fSubEvent) + fSubEvent->eventHeadSize);
383 fEquipment = (equipmentHeaderStruct*) fEnd;
387 fPosition = ((UChar_t*)fEquipment) + sizeof(equipmentHeaderStruct);
388 if (fSubEvent->eventVersion <= 0x00030001) {
389 fEnd = fPosition + fEquipment->equipmentSize;
391 fEnd = ((UChar_t*)fEquipment) + fEquipment->equipmentSize;
395 // continue with the next sub event if no data left in the payload
396 if (fPosition >= fEnd) continue;
398 if (fRequireHeader) {
399 // check that there are enough bytes left for the data header
400 if (fPosition + sizeof(AliRawDataHeader) > fEnd) {
401 Error("ReadHeader", "could not read data header data!");
402 Warning("ReadHeader", "skipping %d bytes\n"
403 " run: %d event: %d %d LDC: %d GDC: %d\n",
404 fEnd - fPosition, fSubEvent->eventRunNb,
405 fSubEvent->eventId[0], fSubEvent->eventId[1],
406 fSubEvent->eventLdcId, fSubEvent->eventGdcId);
409 fErrorCode = kErrNoDataHeader;
413 // "read" the data header
414 fHeader = (AliRawDataHeader*) fPosition;
415 if ((fPosition + fHeader->fSize) != fEnd) {
416 Warning("ReadHeader",
417 "raw data size found in the header is wrong (%d != %d)! Using the equipment size instead !",
418 fHeader->fSize, fEnd - fPosition);
419 fHeader->fSize = fEnd - fPosition;
421 fPosition += sizeof(AliRawDataHeader);
424 if (fHeader && (fHeader->fSize != 0xFFFFFFFF)) {
425 fCount = fHeader->fSize - sizeof(AliRawDataHeader);
427 // check consistency of data size in the header and in the sub event
428 if (fPosition + fCount > fEnd) {
429 Error("ReadHeader", "size in data header exceeds event size!");
430 Warning("ReadHeader", "skipping %d bytes\n"
431 " run: %d event: %d %d LDC: %d GDC: %d\n",
432 fEnd - fPosition, fSubEvent->eventRunNb,
433 fSubEvent->eventId[0], fSubEvent->eventId[1],
434 fSubEvent->eventLdcId, fSubEvent->eventGdcId);
437 fErrorCode = kErrSize;
442 fCount = fEnd - fPosition;
445 } while (!fEquipment || !IsSelected());
453 Bool_t AliRawReaderDate::ReadNextData(UChar_t*& data)
455 // reads the next payload at the current position
456 // returns kFALSE if the data could not be read
459 while (fCount == 0) {
460 if (!ReadHeader()) return kFALSE;
468 Bool_t AliRawReaderDate::ReadNext(UChar_t* data, Int_t size)
470 // reads the next block of data at the current position
471 // returns kFALSE if the data could not be read
474 if (fPosition + size > fEnd) {
475 Error("ReadNext", "could not read data!");
476 fErrorCode = kErrOutOfBounds;
479 memcpy(data, fPosition, size);
486 Bool_t AliRawReaderDate::Reset()
488 // reset the current position to the beginning of the event
495 fPosition = fEnd = NULL;
500 Bool_t AliRawReaderDate::NextEvent()
502 // go to the next event in the date file
505 if (!fFile) return kFALSE;
508 eventHeaderStruct header;
509 UInt_t headerSize = sizeof(eventHeaderStruct);
510 if (fEvent) delete[] fEvent;
513 while (fread(&header, 1, headerSize, fFile) == headerSize) {
514 if (!IsEventSelected()) {
515 fseek(fFile, header.eventSize-headerSize, SEEK_CUR);
518 UChar_t* buffer = new UChar_t[header.eventSize];
519 fseek(fFile, -headerSize, SEEK_CUR);
520 if (fread(buffer, 1, header.eventSize, fFile) != header.eventSize) {
521 Error("NextEvent", "could not read event from file");
525 fEvent = (eventHeaderStruct*) buffer;
536 Bool_t AliRawReaderDate::RewindEvents()
538 // go back to the beginning of the date file
540 if (!fFile) return kFALSE;
542 fseek(fFile, 0, SEEK_SET);
548 Int_t AliRawReaderDate::CheckData() const
550 // check the consistency of the data
553 if (!fEvent) return 0;
554 // check whether there are sub events
555 if (fEvent->eventSize <= fEvent->eventHeadSize) return 0;
557 eventHeaderStruct* subEvent = NULL;
558 UChar_t* position = 0;
563 // get the first or the next sub event if at the end of a sub event
564 if (!subEvent || (position >= end)) {
566 // check for end of event data
567 if (position >= ((UChar_t*)fEvent)+fEvent->eventSize) return result;
568 if (!TEST_SYSTEM_ATTRIBUTE(fEvent->eventTypeAttribute,
570 subEvent = fEvent; // no super event
571 } else if (subEvent) {
572 subEvent = (eventHeaderStruct*) (((UChar_t*)subEvent) +
573 subEvent->eventSize);
575 subEvent = (eventHeaderStruct*) (((UChar_t*)fEvent) +
576 fEvent->eventHeadSize);
579 // check the magic word of the sub event
580 if (subEvent->eventMagic != EVENT_MAGIC_NUMBER) {
585 position = ((UChar_t*)subEvent) + subEvent->eventHeadSize +
586 sizeof(equipmentHeaderStruct);
587 end = ((UChar_t*)subEvent) + subEvent->eventSize;
590 // continue with the next sub event if no data left in the payload
591 if (position >= end) continue;
593 if (fRequireHeader) {
594 // check that there are enough bytes left for the data header
595 if (position + sizeof(AliRawDataHeader) > end) {
596 result |= kErrNoDataHeader;
601 // check consistency of data size in the data header and in the sub event
602 AliRawDataHeader* header = (AliRawDataHeader*) position;
603 if ((position + header->fSize) != end) {
604 Warning("ReadHeader",
605 "raw data size found in the header is wrong (%d != %d)! Using the equipment size instead !",
606 header->fSize, end - position);
607 header->fSize = end - position;