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 (version 3).
22 /// The AliRawReaderDateV3 is constructed either with a pointer to a
23 /// date event or with a file name and an event number.
25 ///////////////////////////////////////////////////////////////////////////////
27 #include "AliRawReaderDateV3.h"
29 struct eventHeaderStruct {
30 Int_t size; /* size of event in Bytes */
31 UInt_t magic; /* magic number used for consistency check */
32 UInt_t type; /* event type */
33 UInt_t headLen; /* size of header in bytes */
34 UInt_t runNb; /* run number */
35 UInt_t burstNb; /* burst number */
36 UInt_t nbInRun; /* event number in run */
37 UInt_t nbInBurst; /* event number in burst */
38 UInt_t triggerNb; /* trigger number for this detector */
39 UInt_t fileSeqNb; /* file sequence number for multifiles run */
40 UInt_t detectorId[3]; /* detector identification */
41 UInt_t time; /* time in seconds since 0.00 GMT 1.1.1970 */
42 UInt_t usec; /* microseconds */
46 UInt_t typeAttribute[2]; /* event type id mask */
49 #define EVENT_MAGIC_NUMBER ((UInt_t)0xDA1E5AFE)
52 ClassImp(AliRawReaderDateV3)
55 AliRawReaderDateV3::AliRawReaderDateV3(void* event) :
62 // create an object to read digits from the given date event
64 fEvent = (eventHeaderStruct*) event;
67 AliRawReaderDateV3::AliRawReaderDateV3(const char* fileName,
75 // create an object to read digits from the given date event
77 fFile = fopen(fileName, "rb");
79 Error("AliRawReaderDateV3", "could not open file %s", fileName);
82 if (eventNumber < 0) return;
84 eventHeaderStruct header;
85 UInt_t headerSize = sizeof(eventHeaderStruct);
86 while (fread(&header, 1, headerSize, fFile) == headerSize) {
87 if (eventNumber == 0) {
88 UChar_t* buffer = new UChar_t[header.size];
89 fseek(fFile, -headerSize, SEEK_CUR);
90 if (Int_t(fread(buffer, 1, header.size, fFile)) != header.size) break;
91 fEvent = (eventHeaderStruct*) buffer;
94 fseek(fFile, header.size-headerSize, SEEK_CUR);
99 AliRawReaderDateV3::AliRawReaderDateV3(const AliRawReaderDateV3& rawReader) :
100 AliRawReader(rawReader),
101 fFile(rawReader.fFile),
102 fEvent(rawReader.fEvent),
103 fSubEvent(rawReader.fSubEvent),
104 fPosition(rawReader.fPosition),
110 Fatal("AliRawReaderDateV3", "copy constructor not implemented");
113 AliRawReaderDateV3& AliRawReaderDateV3::operator = (const AliRawReaderDateV3&
116 // assignment operator
118 Fatal("operator =", "assignment operator not implemented");
122 AliRawReaderDateV3::~AliRawReaderDateV3()
133 UInt_t AliRawReaderDateV3::GetType() const
135 // get the type from the event header
137 if (!fEvent) return 0;
141 UInt_t AliRawReaderDateV3::GetRunNumber() const
143 // get the run number from the event header
145 if (!fEvent) return 0;
146 return fEvent->runNb;
149 const UInt_t* AliRawReaderDateV3::GetEventId() const
151 // get the event id from the event header
153 if (!fEvent) return NULL;
154 return &(fEvent->nbInRun);
157 const UInt_t* AliRawReaderDateV3::GetTriggerPattern() const
159 // get the trigger pattern from the event header
164 const UInt_t* AliRawReaderDateV3::GetDetectorPattern() const
166 // get the detector pattern from the event header
168 if (!fEvent) return NULL;
169 return fEvent->detectorId;
172 const UInt_t* AliRawReaderDateV3::GetAttributes() const
174 // get the type attributes from the event header
176 if (!fEvent) return NULL;
177 return fEvent->typeAttribute;
180 const UInt_t* AliRawReaderDateV3::GetSubEventAttributes() const
182 // get the type attributes from the sub event header
184 if (!fSubEvent) return NULL;
185 return fSubEvent->typeAttribute;
188 UInt_t AliRawReaderDateV3::GetLDCId() const
190 // get the LDC Id from the event header
195 UInt_t AliRawReaderDateV3::GetGDCId() const
197 // get the GDC Id from the event header
203 Int_t AliRawReaderDateV3::GetEquipmentSize() const
205 // get the size of the equipment
207 if (!fSubEvent) return 0;
208 return fSubEvent->size;
211 Int_t AliRawReaderDateV3::GetEquipmentType() const
213 // get the type from the equipment header
218 Int_t AliRawReaderDateV3::GetEquipmentId() const
220 // get the ID from the equipment header
225 const UInt_t* AliRawReaderDateV3::GetEquipmentAttributes() const
227 // get the attributes from the equipment header
232 Int_t AliRawReaderDateV3::GetEquipmentElementSize() const
234 // get the basic element size from the equipment header
239 Int_t AliRawReaderDateV3::GetEquipmentHeaderSize() const
241 // get the size of the equipment header
246 Bool_t AliRawReaderDateV3::ReadHeader()
248 // read a data header at the current position
249 // returns kFALSE if the data header could not be read
254 if (!fEvent) return kFALSE;
255 // check whether there are sub events
256 if (fEvent->size <= Int_t(fEvent->headLen)) return kFALSE;
259 // skip payload (if event was not selected)
260 if (fCount > 0) fPosition += fCount;
262 // check for end of event data
263 if (fPosition >= ((UChar_t*)fEvent)+fEvent->size) return kFALSE;
264 if ((fEvent->detectorId[2] & 0x8000) != 0x8000) {
265 fSubEvent = fEvent; // no super event
266 } else if (fSubEvent) {
267 fSubEvent = (eventHeaderStruct*) (((UChar_t*)fSubEvent) +
270 fSubEvent = (eventHeaderStruct*) (((UChar_t*)fEvent) +
274 // check the magic word of the sub event
275 if (fSubEvent->magic != EVENT_MAGIC_NUMBER) {
276 Error("ReadHeader", "wrong magic number in sub event!\n"
277 " run: %d event: %d\n",
278 fSubEvent->runNb, fSubEvent->nbInRun);
279 fErrorCode = kErrMagic;
283 // continue if no data in the subevent
284 if (fSubEvent->size == Int_t(fSubEvent->headLen)) {
285 fPosition = fEnd = ((UChar_t*)fSubEvent) + fSubEvent->size;
291 fPosition = ((UChar_t*)fSubEvent) + sizeof(eventHeaderStruct);
292 fEnd = ((UChar_t*)fSubEvent) + fSubEvent->size;
294 // continue with the next sub event if no data left in the payload
295 if (fPosition >= fEnd) continue;
297 if (fRequireHeader) {
298 // check that there are enough bytes left for the data header
299 if (fPosition + sizeof(AliRawDataHeader) > fEnd) {
300 Error("ReadHeader", "could not read data header data!");
301 Warning("ReadHeader", "skipping %d bytes\n"
302 " run: %d event: %d\n",
303 fEnd - fPosition, fSubEvent->runNb, fSubEvent->nbInRun);
306 fErrorCode = kErrNoDataHeader;
310 // "read" the data header
311 fHeader = (AliRawDataHeader*) fPosition;
312 if ((fPosition + fHeader->fSize) != fEnd) {
313 Warning("ReadHeader",
314 "raw data size found in the header is wrong (%d != %d)! Using the equipment size instead !",
315 fHeader->fSize, fEnd - fPosition);
316 fHeader->fSize = fEnd - fPosition;
318 fPosition += sizeof(AliRawDataHeader);
321 if (fHeader && (fHeader->fSize != 0xFFFFFFFF)) {
322 fCount = fHeader->fSize - sizeof(AliRawDataHeader);
324 // check consistency of data size in the header and in the sub event
325 if (fPosition + fCount > fEnd) {
326 Error("ReadHeader", "size in data header exceeds event size!");
327 Warning("ReadHeader", "skipping %d bytes\n"
328 " run: %d event: %d\n",
329 fEnd - fPosition, fSubEvent->runNb, fSubEvent->nbInRun);
332 fErrorCode = kErrSize;
337 fCount = fEnd - fPosition;
340 } while (!IsSelected());
345 Bool_t AliRawReaderDateV3::ReadNextData(UChar_t*& data)
347 // reads the next payload at the current position
348 // returns kFALSE if the data could not be read
351 while (fCount == 0) {
352 if (!ReadHeader()) return kFALSE;
360 Bool_t AliRawReaderDateV3::ReadNext(UChar_t* data, Int_t size)
362 // reads the next block of data at the current position
363 // returns kFALSE if the data could not be read
366 if (fPosition + size > fEnd) {
367 Error("ReadNext", "could not read data!");
368 fErrorCode = kErrOutOfBounds;
371 memcpy(data, fPosition, size);
378 Bool_t AliRawReaderDateV3::Reset()
380 // reset the current position to the beginning of the event
384 fPosition = fEnd = NULL;
389 Bool_t AliRawReaderDateV3::NextEvent()
391 // go to the next event in the date file
393 if (!fFile) return kFALSE;
396 eventHeaderStruct header;
397 UInt_t headerSize = sizeof(eventHeaderStruct);
398 if (fEvent) delete[] fEvent;
401 while (fread(&header, 1, headerSize, fFile) == headerSize) {
402 if (!IsEventSelected()) {
403 fseek(fFile, header.size-headerSize, SEEK_CUR);
406 UChar_t* buffer = new UChar_t[header.size];
407 fseek(fFile, -headerSize, SEEK_CUR);
408 if (Int_t(fread(buffer, 1, header.size, fFile)) != header.size) {
409 Error("NextEvent", "could not read event from file");
413 fEvent = (eventHeaderStruct*) buffer;
422 Bool_t AliRawReaderDateV3::RewindEvents()
424 // go back to the beginning of the date file
426 if (!fFile) return kFALSE;
428 fseek(fFile, 0, SEEK_SET);
434 Int_t AliRawReaderDateV3::CheckData() const
436 // check the consistency of the data
438 if (!fEvent) return 0;
439 // check whether there are sub events
440 if (fEvent->size <= Int_t(fEvent->headLen)) return 0;
442 eventHeaderStruct* subEvent = NULL;
443 UChar_t* position = 0;
448 // check for end of event data
449 if (position >= ((UChar_t*)fEvent)+fEvent->size) return result;
450 if ((fEvent->detectorId[2] & 0x8000) != 0x8000) {
451 subEvent = fEvent; // no super event
452 } else if (subEvent) {
453 subEvent = (eventHeaderStruct*) (((UChar_t*)subEvent) +
456 subEvent = (eventHeaderStruct*) (((UChar_t*)fEvent) +
460 // check the magic word of the sub event
461 if (subEvent->magic != EVENT_MAGIC_NUMBER) {
466 position = ((UChar_t*)subEvent) + subEvent->headLen;
467 end = ((UChar_t*)subEvent) + subEvent->size;
469 // continue with the next sub event if no data left in the payload
470 if (position >= end) continue;
472 if (fRequireHeader) {
473 // check that there are enough bytes left for the data header
474 if (position + sizeof(AliRawDataHeader) > end) {
475 result |= kErrNoDataHeader;
480 // check consistency of data size in the data header and in the sub event
481 AliRawDataHeader* header = (AliRawDataHeader*) position;
482 if ((position + header->fSize) != end) {
483 Warning("ReadHeader",
484 "raw data size found in the header is wrong (%d != %d)! Using the equipment size instead !",
485 header->fSize, end - position);
486 header->fSize = end - position;