Added some comments for the global class variables
authordecaro <decaro@f7af4fe6-9843-0410-8265-dc069ae4e863>
Fri, 9 Jan 2009 15:32:27 +0000 (15:32 +0000)
committerdecaro <decaro@f7af4fe6-9843-0410-8265-dc069ae4e863>
Fri, 9 Jan 2009 15:32:27 +0000 (15:32 +0000)
TOF/AliTOFTDCPackedHit.h
TOF/AliTOFTDCUnpackedHit.h
TOF/AliTOFTRMChainHeader.h
TOF/AliTOFTRMChainTrailer.h
TOF/AliTOFTRMDiagnosticErrorWord1.h
TOF/AliTOFTRMDiagnosticErrorWord2.h
TOF/AliTOFTRMGlobalHeader.h
TOF/AliTOFTRMGlobalTrailer.h
TOF/AliTOFTRMTDCError.h

index 462b5a9..d9ef51a 100644 (file)
@@ -25,13 +25,13 @@ class AliTOFTDCPackedHit
   UInt_t GetPSBits() {return fPSBits;};
   UInt_t GetMBO() {return fMBO;};
  private:
-  UInt_t fHitTime:  13;
-  UInt_t fTOTWidth: 8;
-  UInt_t fChan:     3;
-  UInt_t fTDCID:    4;
-  UInt_t fEBit:     1;
-  UInt_t fPSBits:   2;
-  UInt_t fMBO:      1;
+  UInt_t fHitTime:  13; // time-of-flight measurement
+  UInt_t fTOTWidth:  8; // time-over-threshold measurement
+  UInt_t fChan:      3; // TDC channel number
+  UInt_t fTDCID:     4; // TDC ID
+  UInt_t fEBit:      1; // E bit
+  UInt_t fPSBits:    2; // PS bits
+  UInt_t fMBO:       1; // must-be-zero bits
 };
 
 #endif
index 0aa11ba..32a1ac9 100644 (file)
@@ -24,12 +24,12 @@ class AliTOFTDCUnpackedHit
   UInt_t GetPSBits() {return fPSBits;};
   UInt_t GetMBO() {return fMBO;};
  private:
-  UInt_t fHitTime:  21;
-  UInt_t fChan:     3;
-  UInt_t fTDCID:    4;
-  UInt_t fEBit:     1;
-  UInt_t fPSBits:   2;
-  UInt_t fMBO:      1;
+  UInt_t fHitTime:  21; // leading or trailing edge measurement
+  UInt_t fChan:      3; // TDC channel number
+  UInt_t fTDCID:     4; // TDC ID
+  UInt_t fEBit:      1; // E bit
+  UInt_t fPSBits:    2; // PS bits
+  UInt_t fMBO:       1; // must-be-zero bits
 };
 
 #endif
index 5072fbd..11551bf 100644 (file)
@@ -24,12 +24,12 @@ class AliTOFTRMChainHeader
   UInt_t GetTSBit() {return fTSBit;};
   UInt_t GetWordType() {return fWordType;};
  private:
-  UInt_t fSlotID:   4;
-  UInt_t fBunchID:  12;
-  UInt_t fPB24Temp: 8;
-  UInt_t fPB24ID:   3;
-  UInt_t fTSBit:    1;
-  UInt_t fWordType: 4;
+  UInt_t fSlotID:    4; // TRM number
+  UInt_t fBunchID:  12; // bunch ID
+  UInt_t fPB24Temp:  8; // PB24 temperature
+  UInt_t fPB24ID:    3; // PB24 ID
+  UInt_t fTSBit:     1; // TS bit
+  UInt_t fWordType:  4; // word type
 };
 
 #endif
index 81d9704..fb7894d 100644 (file)
@@ -22,10 +22,10 @@ class AliTOFTRMChainTrailer
   UInt_t GetEventCounter() {return fEventCounter;};
   UInt_t GetWordType() {return fWordType;};
  private:
-  UInt_t fStatus:       4;
-  UInt_t fMBZ:          12;
-  UInt_t fEventCounter: 12;
-  UInt_t fWordType:     4;
+  UInt_t fStatus:        4; // status
+  UInt_t fMBZ:          12; // must-be-zero bits
+  UInt_t fEventCounter: 12; // event counter
+  UInt_t fWordType:      4; // word type
 };
 
 #endif
index dda4799..4a970c5 100644 (file)
@@ -23,11 +23,11 @@ class AliTOFTRMDiagnosticErrorWord1
   UInt_t GetMBO() {return fMBO;};
   UInt_t GetWordType() {return fWordType;};
  private:
-  UInt_t fFaultChipFlagID: 15;
-  UInt_t fCBit:            1;
-  UInt_t fMBZ:             8;
-  UInt_t fMBO:             4;
-  UInt_t fWordType:        4;
+  UInt_t fFaultChipFlagID: 15; // fault chip flag ID
+  UInt_t fCBit:             1; // C bit
+  UInt_t fMBZ:              8; // must-be-zero bits
+  UInt_t fMBO:              4; // must-be-zero bits
+  UInt_t fWordType:         4; // word type
 };
 
 #endif
index acedde8..7dfc8f7 100644 (file)
@@ -24,12 +24,12 @@ class AliTOFTRMDiagnosticErrorWord2
   UInt_t GetMBO() {return fMBO;};
   UInt_t GetWordType() {return fWordType;};
  private:
-  UInt_t fJtagErrorCode: 11;
-  UInt_t fTDCID:         4;
-  UInt_t fCBit:          1;
-  UInt_t fMBZ:           8;
-  UInt_t fMBO:           4;
-  UInt_t fWordType:      4;
+  UInt_t fJtagErrorCode: 11; // Jtag error code
+  UInt_t fTDCID:          4; // TDC ID
+  UInt_t fCBit:           1; // C bit
+  UInt_t fMBZ:            8; // must-be-zero bits
+  UInt_t fMBO:            4; // must-be-zero bits
+  UInt_t fWordType:       4; // word type
 };
 
 #endif
index d5830fa..c83d373 100644 (file)
@@ -24,12 +24,12 @@ class AliTOFTRMGlobalHeader
   UInt_t GetMBZ() {return fMBZ;};
   UInt_t GetWordType() {return fWordType;};
  private:
-  UInt_t fSlotID:     4;
-  UInt_t fEventWords: 13;
-  UInt_t fACQBits:    2;
-  UInt_t fLBit:       1;
-  UInt_t fMBZ:        8;
-  UInt_t fWordType:   4;
+  UInt_t fSlotID:      4; // TRM number
+  UInt_t fEventWords: 13; // event word
+  UInt_t fACQBits:     2; // ACQ bits
+  UInt_t fLBit:        1; // L bit
+  UInt_t fMBZ:         8; // must-be-zero bits
+  UInt_t fWordType:    4; // word type
 };
 
 #endif /* ALITOFTRMGLOBALHEADER_H */
index a483401..9e1c124 100644 (file)
@@ -22,10 +22,10 @@ class AliTOFTRMGlobalTrailer
   UInt_t GetEventCounter() {return fEventCounter;};
   UInt_t GetWordType() {return fWordType;};
  private:
-  UInt_t fSlotID:       4;
-  UInt_t fEventCRC:     12;
-  UInt_t fEventCounter: 12;
-  UInt_t fWordType:     4;
+  UInt_t fSlotID:        4; // TRM number
+  UInt_t fEventCRC:     12; // event CRC
+  UInt_t fEventCounter: 12; // event couter
+  UInt_t fWordType:      4; // word type
 };
 
 #endif /* ALITOFTRMGLOBALTRAILER_H */
index 788f372..0f97acb 100644 (file)
@@ -22,10 +22,10 @@ class AliTOFTRMTDCError
   UInt_t GetTDCID () {return fTDCID;};
   UInt_t GetWordType() {return fWordType;};
  private:
-  UInt_t fErrorFlags: 15;
-  UInt_t fMBZ:        9;
-  UInt_t fTDCID:      4;
-  UInt_t fWordType:   4;
+  UInt_t fErrorFlags: 15; // error flags
+  UInt_t fMBZ:         9; // must-be-zero bits
+  UInt_t fTDCID:       4; // TDC number
+  UInt_t fWordType:    4; // word type
 };
 
 #endif