RawDataBlock.h

Go to the documentation of this file.

// $Id: RawDataBlock.h,v 1.23 2005/06/02 06:49:05 rhatcher Exp $
// 
// RawDataBlock 
// 
// RawDataBlock is the base class for a block of raw MINOS data 
// The block is an unstructured collection of raw bytes
// Derived versions specialize how to unpack that data
//
// Author:  R. Hatcher 2000.04.19
//

#ifndef RAWDATABLOCK_H
#define RAWDATABLOCK_H

#include "TObject.h"

#include "RawData/RawBlockId.h"
#include "OnlineUtil/rdChecksum.h"

#include <iosfwd>

class RawDataBlock;
std::ostream& operator<<(std::ostream& os, const RawDataBlock& r);

class RawDataBlock : public TObject {

 public:

   RawDataBlock();                        // necessary for streamer io
   RawDataBlock(const Int_t *block);
   RawDataBlock(const RawDataBlock &rhs); // deep copy ctor
   virtual ~RawDataBlock();

   RawDataBlock& operator=(const RawDataBlock& rhs);  // deep copy assignment

   // unfettered read-only access to the unadulterated data
   inline  const Int_t*     GetData() const { return fRawBlock; }
   inline  Int_t            GetSize() const { return fSize; }

   // components that are always there within the fRawBlock
           RawBlockId       GetBlockId() const;
           Int_t            GetMinorId() const;
           Int_t            GetChecksum() const;
                            // Test returns TRUE if there is an error
           Bool_t           TestChecksum() const;

   virtual void             Print(Option_t *option = "") const;
   virtual std::ostream&    FormatToOStream(std::ostream& os,
                                            Option_t *option="") const;
   static  void             SetForceHexDump(Bool_t force) 
                                            {fgForceHexDump=force;}
   static  Bool_t           GetForceHexDump() { return fgForceHexDump; }

   // append this data to a buffer
   Int_t*                   AppendToBuffer(Int_t* bstart) const;

 protected:

   // make the data elements "protected" so derived classes have access

   Int_t      fSize;        // number of long words stored
   Int_t     *fRawBlock;    //[fSize]   the unstructured data (rawest of raw)

 private:

   // a global option
   static Bool_t fgForceHexDump;

   ClassDef(RawDataBlock,1)  // RawDataBlock version 1
};

#if !defined(__CINT__) || defined(__MAKECINT__)

// second word of stored array is checksum
inline Int_t RawDataBlock::GetChecksum() const
{ return (fSize>1) ? fRawBlock[1] : 0; } 

// third word of stored array is block-id
inline RawBlockId RawDataBlock::GetBlockId() const
{ return (fSize>2) ? RawBlockId(fRawBlock[2]) : RawBlockId(0); } 

inline Int_t RawDataBlock::GetMinorId() const 
{ return GetBlockId().GetMinor(); }

inline Bool_t RawDataBlock::TestChecksum() const
{
   // TestChecksum returns TRUE if there is an error
   return rdxsum_test((long*)fRawBlock);
}
#endif // !__CINT__

#endif // RAWDATABLOCK_H

---