RawTOFDigit Class Reference

#include <RawTOFDigit.h>

Inheritance diagram for RawTOFDigit:

List of all members.

Public Member Functions
	RawTOFDigit ()
	RawTOFDigit (const Int_t *&p, const RawDigitCrateStatus *cstat)
virtual	~RawTOFDigit ()
Int_t	GetNumberOfEntries () const
Int_t	GetTdcEventCounter () const
Bool_t	IsStructureOk () const
Short_t	GetTdcChannel (Int_t indx) const
Short_t	GetTdcValue (Int_t indx) const
Bool_t	IsTdcValid (Int_t indx) const
Bool_t	IsTdcUnderThreshold (Int_t indx) const
Bool_t	IsTdcOverflow (Int_t indx) const
Int_t	GetTdcArraySize () const
const Int_t *	GetTdcArray () const
virtual void	Print (Option_t *option="") const
Protected Attributes
const Int_t *	fTDCArray
Friends
std::ostream &	operator<< (std::ostream &os, const RawTOFDigit &r)

---

Detailed Description

Definition at line 17 of file RawTOFDigit.h.

---

Constructor & Destructor Documentation

RawTOFDigit::RawTOFDigit

(

)

Definition at line 57 of file RawTOFDigit.cxx.

{
   // Default constructor
}

RawTOFDigit::RawTOFDigit	(	const Int_t *&	p,
		const RawDigitCrateStatus *	cstat
	)

Definition at line 63 of file RawTOFDigit.cxx.

References fTDCArray, and GetTdcArraySize().

   : RawVaDigit(p,cstat)
{
   // a RawTOFDigit looks like a RawVaDigit with extra words tacked
   // onto the end.

   // use fTDCArray just to reference back to real data in mother block
   // don't make any copy of the data
   fTDCArray = p;
   // advance pointer beyond entries
   int nskip = GetTdcArraySize();
   p += nskip;
}

RawTOFDigit::~RawTOFDigit

(

)

[virtual]

Definition at line 78 of file RawTOFDigit.cxx.

{
   // fTDCArray *isn't* an owned object ... don't delete it
}

---

Member Function Documentation

Int_t RawTOFDigit::GetNumberOfEntries

(

)

const

Definition at line 84 of file RawTOFDigit.cxx.

References RawDigit::fDigitCrateStatus, fTDCArray, RawBlockId::GetMinor(), RawCrateStatus::GetRawBlockId(), Msg::kWarning, and MSG.

Referenced by GetTdcArraySize(), GetTdcChannel(), GetTdcEventCounter(), GetTdcValue(), IsStructureOk(), IsTdcOverflow(), IsTdcUnderThreshold(), IsTdcValid(), and Print().

{
   // number of TDC channels read out per TOF "hit"
   // is dependent on the minor version id of the block
   // but for most cases actual count comes from header word

   const int cntMask  = 0x3f;
   const int cntShift = 8;

   static int nmsg = 5;

   // we can get this from the CrateStatus
   Int_t minor = fDigitCrateStatus->GetRawBlockId().GetMinor();
   switch (minor) {
   case 0:  
      // pull count size of block from header word
      return (fTDCArray[0]>>cntShift)&cntMask;
      break;
   default:
      if (nmsg > 0) {
         MSG("RawData",Msg::kWarning)
            << "RawTOFDigit::GetNumberOfEntries() unknown minor version "
            << minor << ", assume std TDC header format" << endl;
         nmsg--;
         if (nmsg==0) 
            MSG("RawData",Msg::kWarning)
               << " ... last warning" << endl;
      }
      // pull count size of block from header word
      return (fTDCArray[0]>>cntShift)&cntMask;
      break;
   }
      
}

const Int_t* RawTOFDigit::GetTdcArray

(

)

const [inline]

Definition at line 40 of file RawTOFDigit.h.

References fTDCArray.

Referenced by Print().

{ return fTDCArray; }

Int_t RawTOFDigit::GetTdcArraySize

(

)

const

Definition at line 120 of file RawTOFDigit.cxx.

References RawDigit::fDigitCrateStatus, RawBlockId::GetMinor(), GetNumberOfEntries(), RawCrateStatus::GetRawBlockId(), Msg::kWarning, and MSG.

Referenced by Print(), and RawTOFDigit().

{
   // the size of the Tdc array is dependent on the minor 
   // version id of the block but for most cases actual count 
   // comes from header word plus one each for the header and trailer

   static int nmsg = 5;

   Int_t minor = fDigitCrateStatus->GetRawBlockId().GetMinor();
   switch (minor) {
   case 0:  
      return 2+GetNumberOfEntries();
      break;
   default:
      if (nmsg > 0) {
         MSG("RawData",Msg::kWarning)
            << "RawTOFDigit::GetTdcArraySize() unknown minor version "
            << minor << ", assume std TDC header format" << endl;
         nmsg--;
         if (nmsg==0) 
            MSG("RawData",Msg::kWarning)
               << " ... last warning" << endl;
      }
      return 2+GetNumberOfEntries();
      break;
   }
      
}

Short_t RawTOFDigit::GetTdcChannel

(

Int_t

indx

)

const

Definition at line 192 of file RawTOFDigit.cxx.

References fTDCArray, and GetNumberOfEntries().

Referenced by Print(), and AlgCalDetSI::RunAlg().

{
   // pull the "channel" field from the data word "indx"
   // simply assume that minorid>0

   if (indx<0 || indx>=GetNumberOfEntries()) return -1;

   const int chanMask  = 0x3f;
   const int chanShift = 16;
   // index past header word
   return (fTDCArray[indx+1]>>chanShift)&chanMask;

}

Int_t RawTOFDigit::GetTdcEventCounter

(

)

const

Definition at line 150 of file RawTOFDigit.cxx.

References fTDCArray, and GetNumberOfEntries().

Referenced by Print().

{
   // pull the "event counter" field from the trailer word
   // simply assume that minorid>0

   // skip past header + data words
   int indx = GetNumberOfEntries() + 1;

   return fTDCArray[indx]&0x00ffffff;
}

Short_t RawTOFDigit::GetTdcValue

(

Int_t

indx

)

const

Definition at line 207 of file RawTOFDigit.cxx.

References fTDCArray, and GetNumberOfEntries().

Referenced by Print(), and AlgCalDetSI::RunAlg().

{
   // pull the "adc" field from the data word "indx"
   // simply assume that minorid>0

   if (indx<0 || indx>=GetNumberOfEntries()) return -1;

   const int adcMask  = 0x0fff;

   // index past header word
   return fTDCArray[indx+1]&adcMask;

}

Bool_t RawTOFDigit::IsStructureOk

(

)

const

Definition at line 162 of file RawTOFDigit.cxx.

References fTDCArray, GetNumberOfEntries(), and n.

Referenced by Print(), and AlgCalDetSI::RunAlg().

{
   // verify that flag bits are all in the right places in the TDC block
   // simply assume minorid>0

   //           3         2         1
   //          10987654321098765432109876543210
   // header:  ggggg010cccccccc00nnnnnn--------
   // data:    ggggg00000cccccc-vuoaaaaaaaaaaaa
   // trailer: ggggg100eeeeeeeeeeeeeeeeeeeeeeee

   bool isokay = true;

   const Int_t *p = fTDCArray;

   if ((*p&0x0700c000) != 0x02000000) isokay = false;
   p++;

   int n = GetNumberOfEntries();
   for (int i=0; i<n; i++) {
      if ((*p&0x07c00000) != 0x00000000) isokay = false;
      p++;
   }

   if ((*p&0x07000000) != 0x04000000) isokay = false;

   return isokay;
}

Bool_t RawTOFDigit::IsTdcOverflow

(

Int_t

indx

)

const

Definition at line 252 of file RawTOFDigit.cxx.

References fTDCArray, and GetNumberOfEntries().

Referenced by Print().

{
   // pull the "overflow" field from the data word "indx"
   // simply assume that minorid>0

   if (indx<0 || indx>=GetNumberOfEntries()) return true;

   const int overMask  = BIT(12);

   // index past header word
   return fTDCArray[indx+1]&overMask;

}

Bool_t RawTOFDigit::IsTdcUnderThreshold

(

Int_t

indx

)

const

Definition at line 237 of file RawTOFDigit.cxx.

References fTDCArray, and GetNumberOfEntries().

Referenced by Print().

{
   // pull the "underthreshold" field from the data word "indx"
   // simply assume that minorid>0

   if (indx<0 || indx>=GetNumberOfEntries()) return true;

   const int underMask  = BIT(13);

   // index past header word
   return fTDCArray[indx+1]&underMask;

}

Bool_t RawTOFDigit::IsTdcValid

(

Int_t

indx

)

const

Definition at line 222 of file RawTOFDigit.cxx.

References fTDCArray, and GetNumberOfEntries().

Referenced by Print().

{
   // pull the "valid" field from the data word "indx"
   // simply assume that minorid>0

   if (indx<0 || indx>=GetNumberOfEntries()) return false;

   const int validMask  = BIT(14);

   // index past header word
   return fTDCArray[indx+1]&validMask;

}

void RawTOFDigit::Print

(

Option_t *

option = ""

)

const [virtual]

Reimplemented from RawDigit.

Definition at line 267 of file RawTOFDigit.cxx.

References GetNumberOfEntries(), GetTdcArray(), GetTdcArraySize(), GetTdcChannel(), GetTdcEventCounter(), GetTdcValue(), IsStructureOk(), IsTdcOverflow(), IsTdcUnderThreshold(), and IsTdcValid().

Referenced by RawTOFBlock::FillRawTOFDigits().

{
   // print out the digit
   RawVaDigit::Print(option);

   int nvalues = GetNumberOfEntries();
   int evtcntr = GetTdcEventCounter();
   bool isok   = IsStructureOk();
   cout << "  has " << nvalues << " values ("
        << "evtcntr: " << evtcntr << ","
        << ((isok) ? "isok" : "badbits") << ")" << endl;
   if (nvalues)
      cout << "   indx chan value valid thrsh overflow" << endl;
   for (int i=0; i<nvalues; i++) {
      cout << "  [" << setw(3) << i << "]"
           << " " << setw(4) << GetTdcChannel(i)
           << " " << setw(5) << GetTdcValue(i)
           << ((IsTdcValid(i))          ? "   yes" : "    no")
           << ((IsTdcUnderThreshold(i)) ? " under" : " above")
           << ((IsTdcOverflow(i))       ? "   yes" : "    no")
           << endl;
   }

#ifdef TOOVERBOSE
   int arraysize = GetTdcArraySize();
   const Int_t* array = GetTdcArray();
   for (int i=0; i<arraysize; i++) {
      cout << " 0x" << setfill('0') << hex << setw(8) 
           << array[i] << setfill(' ') << dec;
   }
   cout << endl;
#endif

}

---

Friends And Related Function Documentation

std::ostream& operator<<	(	std::ostream &	os,
		const RawTOFDigit &	r
	)			[friend]

Reimplemented from RawDigit.

---

Member Data Documentation

const Int_t* RawTOFDigit::fTDCArray [protected]

Definition at line 46 of file RawTOFDigit.h.

Referenced by GetNumberOfEntries(), GetTdcArray(), GetTdcChannel(), GetTdcEventCounter(), GetTdcValue(), IsStructureOk(), IsTdcOverflow(), IsTdcUnderThreshold(), IsTdcValid(), and RawTOFDigit().

---

The documentation for this class was generated from the following files:

• RawTOFDigit.h
• RawTOFDigit.cxx