RawBlockId.h

Go to the documentation of this file.

// $Id: RawBlockId.h,v 1.12 2005/08/26 19:04:53 rhatcher Exp $
//
// RawBlockId
//
// RawBlockId encapsulates raw block-ids
//
// Author:  R. Hatcher 2001.04.12
//

#ifndef RAWBLOCKID_H
#define RAWBLOCKID_H

#include "Conventions/Detector.h"
#include "Conventions/SimFlag.h"

// make the RawBlockId cout'able
#include <iosfwd>

class RawBlockId;
std::ostream& operator<<(std::ostream& os, const RawBlockId& rbid);

class RawBlockId {

 public:

   RawBlockId();
   RawBlockId(Int_t major, Int_t minor, Bool_t isDCS,
              Detector::Detector_t detector,
              SimFlag::SimFlag_t simflag);

   virtual ~RawBlockId();

   // use these two with caution as they work on the rawest level
   RawBlockId(const Int_t encoded);
   inline Int_t             GetEncoded() const;

   const Char_t            *AsString(Option_t *option="") const;

   Int_t                           GetMajor() const;
   const Char_t                   *GetMajorAsString() const;
   Int_t                           GetMinor() const;
   Bool_t                          IsDCS() const;
   Detector::Detector_t            GetDetector() const;
   SimFlag::SimFlag_t              GetSimFlag() const;
 
   void Print(Option_t *option="") const;
   virtual std::ostream& FormatToOStream(std::ostream& os,
                                         Option_t *option="") const;

   friend Bool_t operator==(const RawBlockId &lhs, const RawBlockId &rhs);
   friend Bool_t operator!=(const RawBlockId &lhs, const RawBlockId &rhs);

 protected:

   Int_t   fEncoded;  // encoded value

 private:

   ClassDef(RawBlockId,1)
};

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

//==========================================================================
// Implementation details 
//==========================================================================
//
// The details of the encoding of RawBlockId are here in RawBlockId.h;
// this is so that the compiler can inline the code.
// Users should NOT rely on intimate knowledge of these details.
//
//    MSB                          LSB
//     3         2         1         0
//    10987654321098765432109876543210
//    --xxCFNSMMMMMMMMMMMMMMMMmmmmmmmm
//
//         xx: compactSimFlag: {00=data, 01=fakedaqdata, 10=MC, 11=Reroot}
//        CFN: Detector & 0x07 (CalDet,Far,Near bits)
//          S: Source (0=DAQ, 1=DCS)
//   MMMMMMMM: major block id
//   mmmmmmmm: minor block id

const Int_t  defaultRawBlockId     =  0;

const Int_t  shiftRawBlkIdMinor    =  0;
const Int_t  shiftRawBlkIdMajor    =  8;
const Int_t  shiftRawBlkIdIsDCS    = 24;
const Int_t  shiftRawBlkIdDetector = 25;
const Int_t  shiftRawBlkIdCSimFlag = 28;

const Int_t  maskRawBlkIdMinor     = 0x000000ff;
const Int_t  maskRawBlkIdMajor     = 0x00ffff00;
const Int_t  maskRawBlkIdIsDCS     = 0x01000000;
const Int_t  maskRawBlkIdDetector  = 0x0e000000;
const Int_t  maskRawBlkIdCSimFlag  = 0x30000000;

//==========================================================================

inline Bool_t operator==(const RawBlockId &lhs, const RawBlockId &rhs)
{ return (lhs.fEncoded) == (rhs.fEncoded); }

inline Bool_t operator!=(const RawBlockId &lhs, const RawBlockId &rhs)
{ return (lhs.fEncoded) != (rhs.fEncoded); }

inline RawBlockId::RawBlockId() : fEncoded(defaultRawBlockId) { ; }
inline RawBlockId::~RawBlockId() { ; }

inline RawBlockId::RawBlockId(const Int_t encoded) : fEncoded(encoded) { ; }
inline Int_t RawBlockId::GetEncoded() const
{ return fEncoded; }

inline Int_t RawBlockId::GetMajor() const
{ return (fEncoded & maskRawBlkIdMajor) >> shiftRawBlkIdMajor; }

inline Int_t RawBlockId::GetMinor() const
{ return (fEncoded & maskRawBlkIdMinor) >> shiftRawBlkIdMinor; }

inline Bool_t RawBlockId::IsDCS() const
{
   return (fEncoded & maskRawBlkIdIsDCS) >> shiftRawBlkIdIsDCS;
}

inline Detector::Detector_t RawBlockId::GetDetector() const
{ 
   Int_t bitField = (fEncoded & maskRawBlkIdDetector) >> shiftRawBlkIdDetector;
   return (Detector::Detector_t) bitField;   
}

inline SimFlag::SimFlag_t RawBlockId::GetSimFlag() const
{
   Int_t bitField = (fEncoded & maskRawBlkIdCSimFlag) >> shiftRawBlkIdCSimFlag;
   return SimFlag::Expand(bitField);
}
#endif // !__CINT__

#endif // RAWBLOCKID_H

---