[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 "AliRawDataHeader.h"


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

    void             Select(Int_t detectorID, 
			    Int_t minDDLID = -1, Int_t maxDDLID = -1);
    void             SelectEquipment(Int_t equipmentType, 
				     Int_t minEquipmentId = -1, 
				     Int_t maxEquipmentId = -1);
    void             SkipInvalid(Bool_t skip = kTRUE)
      {fSkipInvalid = skip;};
    void             SelectEvents(Int_t type);

    virtual UInt_t   GetType() const = 0;
    virtual UInt_t   GetRunNumber() const = 0;
    virtual const UInt_t* GetEventId() const = 0;
    virtual const UInt_t* GetTriggerPattern() const = 0;
    virtual const UInt_t* GetDetectorPattern() const = 0;
    virtual const UInt_t* GetAttributes() const = 0;
    virtual UInt_t   GetLDCId() const = 0;
    virtual UInt_t   GetGDCId() const = 0;

    virtual Int_t    GetEquipmentSize() const = 0;
    virtual Int_t    GetEquipmentType() const = 0;
    virtual Int_t    GetEquipmentId() const = 0;
    virtual const UInt_t* GetEquipmentAttributes() const = 0;
    virtual Int_t    GetEquipmentElementSize() const = 0;

    Int_t            GetDetectorID() const 
      {if (GetEquipmentId() >= 0) return (GetEquipmentId() >> 8); else return -1;};
    Int_t            GetDDLID() const 
      {if (GetEquipmentId() >= 0) return (GetEquipmentId() & 0xFF); else return -1;};

    Int_t            GetDataSize() const 
      {if (fHeader) return fHeader->fSize - sizeof(AliRawDataHeader); 
      else return GetEquipmentSize();};

    Int_t            GetVersion() const 
      {if (fHeader) return fHeader->fVersion; 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;};
    UInt_t           GetStatusBits() const
      {if (fHeader) return fHeader->GetStatus(); 
      else return 0;};

    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   Reset() = 0;

    virtual Bool_t   NextEvent() = 0;
    virtual Bool_t   RewindEvents() = 0;

    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);

  protected :
    Bool_t           IsSelected() const;
    Bool_t           IsEventSelected() const;

    virtual Bool_t   ReadNext(UChar_t* data, Int_t size) = 0;

    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)

    Int_t            fErrorCode;         // code of last error

    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 "AliRawDataHeader.h"
	16
	17
	18	class AliRawReader: public TObject {
	19	public :
	20	AliRawReader();
	21	AliRawReader(const AliRawReader& rawReader);
	22	AliRawReader& operator = (const AliRawReader& rawReader);
	23	virtual ~AliRawReader() {};
	24
	25	void Select(Int_t detectorID,
	26	Int_t minDDLID = -1, Int_t maxDDLID = -1);
	27	void SelectEquipment(Int_t equipmentType,
	28	Int_t minEquipmentId = -1,
	29	Int_t maxEquipmentId = -1);
	30	void SkipInvalid(Bool_t skip = kTRUE)
	31	{fSkipInvalid = skip;};
	32	void SelectEvents(Int_t type);
	33
	34	virtual UInt_t GetType() const = 0;
	35	virtual UInt_t GetRunNumber() const = 0;
	36	virtual const UInt_t* GetEventId() const = 0;
	37	virtual const UInt_t* GetTriggerPattern() const = 0;
	38	virtual const UInt_t* GetDetectorPattern() const = 0;
	39	virtual const UInt_t* GetAttributes() const = 0;
	40	virtual UInt_t GetLDCId() const = 0;
	41	virtual UInt_t GetGDCId() const = 0;
	42
	43	virtual Int_t GetEquipmentSize() const = 0;
	44	virtual Int_t GetEquipmentType() const = 0;
	45	virtual Int_t GetEquipmentId() const = 0;
	46	virtual const UInt_t* GetEquipmentAttributes() const = 0;
	47	virtual Int_t GetEquipmentElementSize() const = 0;
	48
	49	Int_t GetDetectorID() const
	50	{if (GetEquipmentId() >= 0) return (GetEquipmentId() >> 8); else return -1;};
	51	Int_t GetDDLID() const
	52	{if (GetEquipmentId() >= 0) return (GetEquipmentId() & 0xFF); else return -1;};
	53
	54	Int_t GetDataSize() const
	55	{if (fHeader) return fHeader->fSize - sizeof(AliRawDataHeader);
	56	else return GetEquipmentSize();};
	57
	58	Int_t GetVersion() const
	59	{if (fHeader) return fHeader->fVersion; else return -1;};
	60	Bool_t IsValid() const
	61	{if (fHeader) return fHeader->TestAttribute(0);
	62	else return kFALSE;};
	63	Bool_t IsCompressed() const
	64	{if (fHeader) return fHeader->TestAttribute(1);
	65	else return kFALSE;};
	66	UInt_t GetStatusBits() const
	67	{if (fHeader) return fHeader->GetStatus();
	68	else return 0;};
	69
	70	virtual Bool_t ReadHeader() = 0;
	71	virtual Bool_t ReadNextData(UChar_t*& data) = 0;
	72	virtual Bool_t ReadNextInt(UInt_t& data);
	73	virtual Bool_t ReadNextShort(UShort_t& data);
	74	virtual Bool_t ReadNextChar(UChar_t& data);
	75
	76	virtual Bool_t Reset() = 0;
	77
	78	virtual Bool_t NextEvent() = 0;
	79	virtual Bool_t RewindEvents() = 0;
	80
	81	enum {kErrMagic=1, kErrNoDataHeader=2,
	82	kErrSize=4, kErrOutOfBounds=8};
	83	virtual Int_t CheckData() const;
	84	Int_t GetErrorCode() const {return fErrorCode;};
	85
	86	void DumpData(Int_t limit = -1);
	87
	88	protected :
	89	Bool_t IsSelected() const;
	90	Bool_t IsEventSelected() const;
	91
	92	virtual Bool_t ReadNext(UChar_t* data, Int_t size) = 0;
	93
	94	AliRawDataHeader* fHeader; // current data header
	95	Int_t fCount; // counter of bytes to be read for current DDL
	96
	97	Int_t fSelectEquipmentType; // type of selected equipment (<0 = no selection)
	98	Int_t fSelectMinEquipmentId; // minimal index of selected equipment (<0 = no selection)
	99	Int_t fSelectMaxEquipmentId; // maximal index of selected equipment (<0 = no selection)
	100	Bool_t fSkipInvalid; // skip invalid data
	101	Int_t fSelectEventType; // type of selected events (<0 = no selection)
	102
	103	Int_t fErrorCode; // code of last error
	104
	105	ClassDef(AliRawReader, 0) // base class for reading raw digits
	106	};
	107
	108	#endif