[u/mrichter/AliRoot.git] / RAW / AliRawReader.h

#ifndef ALIRAWREADER_H
#define ALIRAWREADER_H
/* Copyright(c) 1998-1999, ALICE Experiment at CERN, All rights reserved. *
 * See cxx source for full Copyright notice                               */

/* $Id$ */

///////////////////////////////////////////////////////////////////////////////
///
/// This is the base class for reading raw data.
///
///////////////////////////////////////////////////////////////////////////////

#include <TObject.h>
#include <TArrayI.h>
#include <TClonesArray.h>

#include "AliRawDataErrorLog.h"
#include "AliRawDataHeader.h"

class TChain;
class AliRawEventHeaderBase;
class AliRawVEvent;

class AliRawReader: public TObject {
  public :
    AliRawReader();
    AliRawReader(const AliRawReader& rawReader);
    AliRawReader& operator = (const AliRawReader& rawReader);
    virtual ~AliRawReader();

    static  AliRawReader* Create(const char *uri);

    virtual void     Select(Int_t detectorID, 
			    Int_t minDDLID = -1, Int_t maxDDLID = -1);
    virtual void     Select(const char *detectorName, 
			    Int_t minDDLID = -1, Int_t maxDDLID = -1);
    virtual void     SelectEquipment(Int_t equipmentType, 
				     Int_t minEquipmentId = -1, 
				     Int_t maxEquipmentId = -1);
    virtual void     SkipInvalid(Bool_t skip = kTRUE)
      {fSkipInvalid = skip;};
    virtual void     RequireHeader(Bool_t required)
      {fRequireHeader = required;};

    virtual const AliRawEventHeaderBase* GetEventHeader() const {return NULL;};
    virtual const AliRawVEvent* GetEvent() const {return NULL;}

    virtual UInt_t   GetType() const = 0;
    virtual UInt_t   GetRunNumber() const = 0;
    virtual const UInt_t* GetEventId() const = 0;
    UInt_t                GetPeriod() const {
      const UInt_t *id = GetEventId();
      return id ? (((id)[0]>>4)&0x0fffffff): 0;
    }
    UInt_t                GetOrbitID() const {
      const UInt_t *id = GetEventId();
      return id ? ((((id)[0]<<20)&0xf00000)|(((id)[1]>>12)&0xfffff)) : 0;
    }
    UShort_t              GetBCID() const {
      const UInt_t *id = GetEventId();
      return id ? ((id)[1]&0x00000fff) : 0;
    }
    virtual const UInt_t* GetTriggerPattern() const = 0;
    ULong64_t             GetClassMask() const {
      const UInt_t *pattern = GetTriggerPattern();
      return pattern ? (((ULong64_t)pattern[1] & 0x3ffff) << 32)|(pattern[0]) : 0;
    }
    virtual const UInt_t* GetDetectorPattern() const = 0;
    virtual const UInt_t* GetAttributes() const = 0;
    virtual const UInt_t* GetSubEventAttributes() const = 0;
    virtual UInt_t   GetLDCId() const = 0;
    virtual UInt_t   GetGDCId() const = 0;
    virtual UInt_t   GetTimestamp() const = 0;

    virtual Int_t    GetEquipmentSize() const = 0;
    virtual Int_t    GetEquipmentType() const = 0;
    virtual Int_t    GetEquipmentId() const = 0;
    Int_t            GetMappedEquipmentId() const;
    Bool_t           LoadEquipmentIdsMap(const char *fileName);
    virtual const UInt_t* GetEquipmentAttributes() const = 0;
    virtual Int_t    GetEquipmentElementSize() const = 0;
    virtual Int_t    GetEquipmentHeaderSize() const = 0;

    Int_t            GetDetectorID() const;
    Int_t            GetDDLID() const;

    Int_t            GetDataSize() const 
      {if (fHeader) {
	if (fHeader->fSize != 0xFFFFFFFF) return fHeader->fSize - sizeof(AliRawDataHeader); 
	else return GetEquipmentSize() - GetEquipmentHeaderSize() - sizeof(AliRawDataHeader);
      } else return GetEquipmentSize() - GetEquipmentHeaderSize();};

    Int_t            GetVersion() const 
      {if (fHeader) return fHeader->GetVersion(); else return -1;};
    Bool_t           IsValid() const 
      {if (fHeader) return fHeader->TestAttribute(0); 
      else return kFALSE;};
    Bool_t           IsCompressed() const 
      {if (fHeader) return fHeader->TestAttribute(1); 
      else return kFALSE;};
    Bool_t           TestBlockAttribute(Int_t index) const
      {if (fHeader) return fHeader->TestAttribute(index); 
      else return kFALSE;};
    UChar_t          GetBlockAttributes() const 
      {if (fHeader) return fHeader->GetAttributes(); 
      else return 0;};
    UInt_t           GetStatusBits() const
      {if (fHeader) return fHeader->GetStatus(); 
      else return 0;};
    const AliRawDataHeader* GetDataHeader() const
      {return fHeader;}

    virtual Bool_t   ReadHeader() = 0;
    virtual Bool_t   ReadNextData(UChar_t*& data) = 0;
    virtual Bool_t   ReadNextInt(UInt_t& data);
    virtual Bool_t   ReadNextShort(UShort_t& data);
    virtual Bool_t   ReadNextChar(UChar_t& data);
    virtual Bool_t   ReadNext(UChar_t* data, Int_t size) = 0;

    virtual Bool_t   Reset() = 0;

    virtual Bool_t   NextEvent() = 0;
    virtual Bool_t   RewindEvents() = 0;
    virtual Bool_t   GotoEvent(Int_t event);
    virtual Int_t    GetEventIndex() const { return -1; }
    virtual Int_t    GetNumberOfEvents() const { return -1; }

    enum {kErrMagic=1, kErrNoDataHeader=2, 
	  kErrSize=4, kErrOutOfBounds=8};
    virtual Int_t    CheckData() const;
    Int_t            GetErrorCode() const {return fErrorCode;};

    void             DumpData(Int_t limit = -1);

    void             AddErrorLog(AliRawDataErrorLog::ERawDataErrorLevel level,
				 Int_t code,
				 const char *message = NULL);
    void             AddMinorErrorLog(Int_t code,
				      const char *message = NULL) {
      return AddErrorLog(AliRawDataErrorLog::kMinor,code,message);
    }
    void             AddMajorErrorLog(Int_t code,
				      const char *message = NULL) {
      return AddErrorLog(AliRawDataErrorLog::kMajor,code,message);
    }
    void             AddFatalErrorLog(Int_t code,
				      const char *message = NULL) {
      return AddErrorLog(AliRawDataErrorLog::kFatal,code,message);
    }
    Int_t            GetNumberOfErrorLogs() const { return fErrorLogs.GetEntriesFast(); }
    const TClonesArray &GetAllErrorLogs() const { return fErrorLogs; }
    AliRawDataErrorLog *GetErrorLog(Int_t i) const {
      return (AliRawDataErrorLog *)fErrorLogs.UncheckedAt(i);
    }

    // Method which can be used in order to force the auto-save on
    // ESD tree inside AliReconstruction. For the moment it will be
    // activated only for AliRawReaderDateOnline.
    virtual Bool_t   UseAutoSaveESD() const { return kFALSE; }
    virtual TChain*  GetChain() const { return NULL; }

    Bool_t           IsRawReaderValid() const { return fIsValid; }

    void             LoadTriggerClass(const char* name, Int_t index);

  protected :
    virtual void     SelectEvents(Int_t type, ULong64_t triggerMask = 0, const char *triggerExpr = NULL);
    Bool_t           IsSelected() const;
    Bool_t           IsEventSelected() const;

    TArrayI         *fEquipmentIdsIn;       // array of equipment Ids to be mapped
    TArrayI         *fEquipmentIdsOut;      // array of mapped equipment Ids

    Bool_t           fRequireHeader;        // if false, data without header is accepted

    AliRawDataHeader* fHeader;              // current data header
    Int_t            fCount;                // counter of bytes to be read for current DDL

    Int_t            fSelectEquipmentType;  // type of selected equipment (<0 = no selection)
    Int_t            fSelectMinEquipmentId; // minimal index of selected equipment (<0 = no selection)
    Int_t            fSelectMaxEquipmentId; // maximal index of selected equipment (<0 = no selection)
    Bool_t           fSkipInvalid;          // skip invalid data
    Int_t            fSelectEventType;      // type of selected events (<0 = no selection)
    ULong64_t        fSelectTriggerMask;    // trigger mask for selecting events (0 = no selection)
    TString          fSelectTriggerExpr;    // trigger expression for selecting events (empty = no selection)

    Int_t            fErrorCode;            // code of last error

    Int_t            fEventNumber;          // current event number
    TClonesArray     fErrorLogs;            // raw data decoding errors

    AliRawDataHeader* fHeaderSwapped;       // temporary buffer for swapping header on PowerPC

    UInt_t SwapWord(UInt_t x) const;
    UShort_t SwapShort(UShort_t x) const;

    Bool_t           fIsValid;              // is raw-reader created successfully

    ClassDef(AliRawReader, 0) // base class for reading raw digits
};

#endif
Commit	Line	Data
	1	#ifndef ALIRAWREADER_H
	2	#define ALIRAWREADER_H
	3	/* Copyright(c) 1998-1999, ALICE Experiment at CERN, All rights reserved. *
	4	* See cxx source for full Copyright notice */
	5
	6	/* $Id$ */
	7
	8	///////////////////////////////////////////////////////////////////////////////
	9	///
	10	/// This is the base class for reading raw data.
	11	///
	12	///////////////////////////////////////////////////////////////////////////////
	13
	14	#include <TObject.h>
	15	#include <TArrayI.h>
	16	#include <TClonesArray.h>
	17
	18	#include "AliRawDataErrorLog.h"
	19	#include "AliRawDataHeader.h"
	20
	21	class TChain;
	22	class AliRawEventHeaderBase;
	23	class AliRawVEvent;
	24
	25	class AliRawReader: public TObject {
	26	public :
	27	AliRawReader();
	28	AliRawReader(const AliRawReader& rawReader);
	29	AliRawReader& operator = (const AliRawReader& rawReader);
	30	virtual ~AliRawReader();
	31
	32	static AliRawReader* Create(const char *uri);
	33
	34	virtual void Select(Int_t detectorID,
	35	Int_t minDDLID = -1, Int_t maxDDLID = -1);
	36	virtual void Select(const char *detectorName,
	37	Int_t minDDLID = -1, Int_t maxDDLID = -1);
	38	virtual void SelectEquipment(Int_t equipmentType,
	39	Int_t minEquipmentId = -1,
	40	Int_t maxEquipmentId = -1);
	41	virtual void SkipInvalid(Bool_t skip = kTRUE)
	42	{fSkipInvalid = skip;};
	43	virtual void RequireHeader(Bool_t required)
	44	{fRequireHeader = required;};
	45
	46	virtual const AliRawEventHeaderBase* GetEventHeader() const {return NULL;};
	47	virtual const AliRawVEvent* GetEvent() const {return NULL;}
	48
	49	virtual UInt_t GetType() const = 0;
	50	virtual UInt_t GetRunNumber() const = 0;
	51	virtual const UInt_t* GetEventId() const = 0;
	52	UInt_t GetPeriod() const {
	53	const UInt_t *id = GetEventId();
	54	return id ? (((id)[0]>>4)&0x0fffffff): 0;
	55	}
	56	UInt_t GetOrbitID() const {
	57	const UInt_t *id = GetEventId();
	58	return id ? ((((id)[0]<<20)&0xf00000)\|(((id)[1]>>12)&0xfffff)) : 0;
	59	}
	60	UShort_t GetBCID() const {
	61	const UInt_t *id = GetEventId();
	62	return id ? ((id)[1]&0x00000fff) : 0;
	63	}
	64	virtual const UInt_t* GetTriggerPattern() const = 0;
	65	ULong64_t GetClassMask() const {
	66	const UInt_t *pattern = GetTriggerPattern();
	67	return pattern ? (((ULong64_t)pattern[1] & 0x3ffff) << 32)\|(pattern[0]) : 0;
	68	}
	69	virtual const UInt_t* GetDetectorPattern() const = 0;
	70	virtual const UInt_t* GetAttributes() const = 0;
	71	virtual const UInt_t* GetSubEventAttributes() const = 0;
	72	virtual UInt_t GetLDCId() const = 0;
	73	virtual UInt_t GetGDCId() const = 0;
	74	virtual UInt_t GetTimestamp() const = 0;
	75
	76	virtual Int_t GetEquipmentSize() const = 0;
	77	virtual Int_t GetEquipmentType() const = 0;
	78	virtual Int_t GetEquipmentId() const = 0;
	79	Int_t GetMappedEquipmentId() const;
	80	Bool_t LoadEquipmentIdsMap(const char *fileName);
	81	virtual const UInt_t* GetEquipmentAttributes() const = 0;
	82	virtual Int_t GetEquipmentElementSize() const = 0;
	83	virtual Int_t GetEquipmentHeaderSize() const = 0;
	84
	85	Int_t GetDetectorID() const;
	86	Int_t GetDDLID() const;
	87
	88	Int_t GetDataSize() const
	89	{if (fHeader) {
	90	if (fHeader->fSize != 0xFFFFFFFF) return fHeader->fSize - sizeof(AliRawDataHeader);
	91	else return GetEquipmentSize() - GetEquipmentHeaderSize() - sizeof(AliRawDataHeader);
	92	} else return GetEquipmentSize() - GetEquipmentHeaderSize();};
	93
	94	Int_t GetVersion() const
	95	{if (fHeader) return fHeader->GetVersion(); else return -1;};
	96	Bool_t IsValid() const
	97	{if (fHeader) return fHeader->TestAttribute(0);
	98	else return kFALSE;};
	99	Bool_t IsCompressed() const
	100	{if (fHeader) return fHeader->TestAttribute(1);
	101	else return kFALSE;};
	102	Bool_t TestBlockAttribute(Int_t index) const
	103	{if (fHeader) return fHeader->TestAttribute(index);
	104	else return kFALSE;};
	105	UChar_t GetBlockAttributes() const
	106	{if (fHeader) return fHeader->GetAttributes();
	107	else return 0;};
	108	UInt_t GetStatusBits() const
	109	{if (fHeader) return fHeader->GetStatus();
	110	else return 0;};
	111	const AliRawDataHeader* GetDataHeader() const
	112	{return fHeader;}
	113
	114	virtual Bool_t ReadHeader() = 0;
	115	virtual Bool_t ReadNextData(UChar_t*& data) = 0;
	116	virtual Bool_t ReadNextInt(UInt_t& data);
	117	virtual Bool_t ReadNextShort(UShort_t& data);
	118	virtual Bool_t ReadNextChar(UChar_t& data);
	119	virtual Bool_t ReadNext(UChar_t* data, Int_t size) = 0;
	120
	121	virtual Bool_t Reset() = 0;
	122
	123	virtual Bool_t NextEvent() = 0;
	124	virtual Bool_t RewindEvents() = 0;
	125	virtual Bool_t GotoEvent(Int_t event);
	126	virtual Int_t GetEventIndex() const { return -1; }
	127	virtual Int_t GetNumberOfEvents() const { return -1; }
	128
	129	enum {kErrMagic=1, kErrNoDataHeader=2,
	130	kErrSize=4, kErrOutOfBounds=8};
	131	virtual Int_t CheckData() const;
	132	Int_t GetErrorCode() const {return fErrorCode;};
	133
	134	void DumpData(Int_t limit = -1);
	135
	136	void AddErrorLog(AliRawDataErrorLog::ERawDataErrorLevel level,
	137	Int_t code,
	138	const char *message = NULL);
	139	void AddMinorErrorLog(Int_t code,
	140	const char *message = NULL) {
	141	return AddErrorLog(AliRawDataErrorLog::kMinor,code,message);
	142	}
	143	void AddMajorErrorLog(Int_t code,
	144	const char *message = NULL) {
	145	return AddErrorLog(AliRawDataErrorLog::kMajor,code,message);
	146	}
	147	void AddFatalErrorLog(Int_t code,
	148	const char *message = NULL) {
	149	return AddErrorLog(AliRawDataErrorLog::kFatal,code,message);
	150	}
	151	Int_t GetNumberOfErrorLogs() const { return fErrorLogs.GetEntriesFast(); }
	152	const TClonesArray &GetAllErrorLogs() const { return fErrorLogs; }
	153	AliRawDataErrorLog *GetErrorLog(Int_t i) const {
	154	return (AliRawDataErrorLog *)fErrorLogs.UncheckedAt(i);
	155	}
	156
	157	// Method which can be used in order to force the auto-save on
	158	// ESD tree inside AliReconstruction. For the moment it will be
	159	// activated only for AliRawReaderDateOnline.
	160	virtual Bool_t UseAutoSaveESD() const { return kFALSE; }
	161	virtual TChain* GetChain() const { return NULL; }
	162
	163	Bool_t IsRawReaderValid() const { return fIsValid; }
	164
	165	void LoadTriggerClass(const char* name, Int_t index);
	166
	167	protected :
	168	virtual void SelectEvents(Int_t type, ULong64_t triggerMask = 0, const char *triggerExpr = NULL);
	169	Bool_t IsSelected() const;
	170	Bool_t IsEventSelected() const;
	171
	172	TArrayI *fEquipmentIdsIn; // array of equipment Ids to be mapped
	173	TArrayI *fEquipmentIdsOut; // array of mapped equipment Ids
	174
	175	Bool_t fRequireHeader; // if false, data without header is accepted
	176
	177	AliRawDataHeader* fHeader; // current data header
	178	Int_t fCount; // counter of bytes to be read for current DDL
	179
	180	Int_t fSelectEquipmentType; // type of selected equipment (<0 = no selection)
	181	Int_t fSelectMinEquipmentId; // minimal index of selected equipment (<0 = no selection)
	182	Int_t fSelectMaxEquipmentId; // maximal index of selected equipment (<0 = no selection)
	183	Bool_t fSkipInvalid; // skip invalid data
	184	Int_t fSelectEventType; // type of selected events (<0 = no selection)
	185	ULong64_t fSelectTriggerMask; // trigger mask for selecting events (0 = no selection)
	186	TString fSelectTriggerExpr; // trigger expression for selecting events (empty = no selection)
	187
	188	Int_t fErrorCode; // code of last error
	189
	190	Int_t fEventNumber; // current event number
	191	TClonesArray fErrorLogs; // raw data decoding errors
	192
	193	AliRawDataHeader* fHeaderSwapped; // temporary buffer for swapping header on PowerPC
	194
	195	UInt_t SwapWord(UInt_t x) const;
	196	UShort_t SwapShort(UShort_t x) const;
	197
	198	Bool_t fIsValid; // is raw-reader created successfully
	199
	200	ClassDef(AliRawReader, 0) // base class for reading raw digits
	201	};
	202
	203	#endif