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 (without header)
253 if (!fEquipment) return 0;
254 if (fSubEvent->eventVersion <= 0x00030001) {
255 return fEquipment->equipmentSize;
257 return fEquipment->equipmentSize - sizeof(equipmentHeaderStruct);
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;
313 Bool_t AliRawReaderDate::ReadHeader()
315 // read a data header at the current position
316 // returns kFALSE if the data header could not be read
322 if (!fEvent) return kFALSE;
323 // check whether there are sub events
324 if (fEvent->eventSize <= fEvent->eventHeadSize) return kFALSE;
327 // skip payload (if event was not selected)
328 if (fCount > 0) fPosition += fCount;
330 // get the first or the next equipment if at the end of an equipment
331 if (!fEquipment || (fPosition >= fEnd)) {
334 // get the first or the next sub event if at the end of a sub event
336 (fPosition >= ((UChar_t*)fSubEvent) + fSubEvent->eventSize)) {
338 // check for end of event data
339 if (fPosition >= ((UChar_t*)fEvent)+fEvent->eventSize) return kFALSE;
340 if (!TEST_SYSTEM_ATTRIBUTE(fEvent->eventTypeAttribute,
342 fSubEvent = fEvent; // no super event
343 } else if (fSubEvent) {
344 fSubEvent = (eventHeaderStruct*) (((UChar_t*)fSubEvent) +
345 fSubEvent->eventSize);
347 fSubEvent = (eventHeaderStruct*) (((UChar_t*)fEvent) +
348 fEvent->eventHeadSize);
351 // check the magic word of the sub event
352 if (fSubEvent->eventMagic != EVENT_MAGIC_NUMBER) {
353 Error("ReadHeader", "wrong magic number in sub event!\n"
354 " run: %d event: %d %d LDC: %d GDC: %d\n",
355 fSubEvent->eventRunNb,
356 fSubEvent->eventId[0], fSubEvent->eventId[1],
357 fSubEvent->eventLdcId, fSubEvent->eventGdcId);
358 fErrorCode = kErrMagic;
362 // continue if no data in the subevent
363 if (fSubEvent->eventSize == fSubEvent->eventHeadSize) {
364 fPosition = fEnd = ((UChar_t*)fSubEvent) + fSubEvent->eventSize;
369 fEquipment = (equipmentHeaderStruct*)
370 (((UChar_t*)fSubEvent) + fSubEvent->eventHeadSize);
373 fEquipment = (equipmentHeaderStruct*) fEnd;
377 fPosition = ((UChar_t*)fEquipment) + sizeof(equipmentHeaderStruct);
378 if (fSubEvent->eventVersion <= 0x00030001) {
379 fEnd = fPosition + fEquipment->equipmentSize;
381 fEnd = ((UChar_t*)fEquipment) + fEquipment->equipmentSize;
385 // continue with the next sub event if no data left in the payload
386 if (fPosition >= fEnd) continue;
388 if (fRequireHeader) {
389 // check that there are enough bytes left for the data header
390 if (fPosition + sizeof(AliRawDataHeader) > fEnd) {
391 Error("ReadHeader", "could not read data header data!");
392 Warning("ReadHeader", "skipping %d bytes\n"
393 " run: %d event: %d %d LDC: %d GDC: %d\n",
394 fEnd - fPosition, fSubEvent->eventRunNb,
395 fSubEvent->eventId[0], fSubEvent->eventId[1],
396 fSubEvent->eventLdcId, fSubEvent->eventGdcId);
399 fErrorCode = kErrNoDataHeader;
403 // "read" the data header
404 fHeader = (AliRawDataHeader*) fPosition;
405 fPosition += sizeof(AliRawDataHeader);
408 if (fHeader && (fHeader->fSize != 0xFFFFFFFF)) {
409 fCount = fHeader->fSize - sizeof(AliRawDataHeader);
411 // check consistency of data size in the header and in the sub event
412 if (fPosition + fCount > fEnd) {
413 Error("ReadHeader", "size in data header exceeds event size!");
414 Warning("ReadHeader", "skipping %d bytes\n"
415 " run: %d event: %d %d LDC: %d GDC: %d\n",
416 fEnd - fPosition, fSubEvent->eventRunNb,
417 fSubEvent->eventId[0], fSubEvent->eventId[1],
418 fSubEvent->eventLdcId, fSubEvent->eventGdcId);
421 fErrorCode = kErrSize;
426 fCount = fEnd - fPosition;
429 } while (!fEquipment || !IsSelected());
437 Bool_t AliRawReaderDate::ReadNextData(UChar_t*& data)
439 // reads the next payload at the current position
440 // returns kFALSE if the data could not be read
443 while (fCount == 0) {
444 if (!ReadHeader()) return kFALSE;
452 Bool_t AliRawReaderDate::ReadNext(UChar_t* data, Int_t size)
454 // reads the next block of data at the current position
455 // returns kFALSE if the data could not be read
458 if (fPosition + size > fEnd) {
459 Error("ReadNext", "could not read data!");
460 fErrorCode = kErrOutOfBounds;
463 memcpy(data, fPosition, size);
470 Bool_t AliRawReaderDate::Reset()
472 // reset the current position to the beginning of the event
479 fPosition = fEnd = NULL;
484 Bool_t AliRawReaderDate::NextEvent()
486 // go to the next event in the date file
489 if (!fFile) return kFALSE;
492 eventHeaderStruct header;
493 UInt_t headerSize = sizeof(eventHeaderStruct);
494 if (fEvent) delete[] fEvent;
497 while (fread(&header, 1, headerSize, fFile) == headerSize) {
498 if (!IsEventSelected()) {
499 fseek(fFile, header.eventSize-headerSize, SEEK_CUR);
502 UChar_t* buffer = new UChar_t[header.eventSize];
503 fseek(fFile, -headerSize, SEEK_CUR);
504 if (fread(buffer, 1, header.eventSize, fFile) != header.eventSize) {
505 Error("NextEvent", "could not read event from file");
509 fEvent = (eventHeaderStruct*) buffer;
519 Bool_t AliRawReaderDate::RewindEvents()
521 // go back to the beginning of the date file
523 if (!fFile) return kFALSE;
525 fseek(fFile, 0, SEEK_SET);
530 Int_t AliRawReaderDate::CheckData() const
532 // check the consistency of the data
535 if (!fEvent) return 0;
536 // check whether there are sub events
537 if (fEvent->eventSize <= fEvent->eventHeadSize) return 0;
539 eventHeaderStruct* subEvent = NULL;
540 UChar_t* position = 0;
545 // get the first or the next sub event if at the end of a sub event
546 if (!subEvent || (position >= end)) {
548 // check for end of event data
549 if (position >= ((UChar_t*)fEvent)+fEvent->eventSize) return result;
550 if (!TEST_SYSTEM_ATTRIBUTE(fEvent->eventTypeAttribute,
552 subEvent = fEvent; // no super event
553 } else if (subEvent) {
554 subEvent = (eventHeaderStruct*) (((UChar_t*)subEvent) +
555 subEvent->eventSize);
557 subEvent = (eventHeaderStruct*) (((UChar_t*)fEvent) +
558 fEvent->eventHeadSize);
561 // check the magic word of the sub event
562 if (subEvent->eventMagic != EVENT_MAGIC_NUMBER) {
567 position = ((UChar_t*)subEvent) + subEvent->eventHeadSize +
568 sizeof(equipmentHeaderStruct);
569 end = ((UChar_t*)subEvent) + subEvent->eventSize;
572 // continue with the next sub event if no data left in the payload
573 if (position >= end) continue;
575 if (fRequireHeader) {
576 // check that there are enough bytes left for the data header
577 if (position + sizeof(AliRawDataHeader) > end) {
578 result |= kErrNoDataHeader;
583 // check consistency of data size in the data header and in the sub event
584 AliRawDataHeader* header = (AliRawDataHeader*) position;
585 if (header->fSize != 0xFFFFFFFF) {
586 if (position + header->fSize > end) result |= kErrSize;