Add Config/HighVoltage directory and entry

[u/mrichter/AliRoot.git] / MUON / AliMUONDarcHeader.h

diff --git a/MUON/AliMUONDarcHeader.h b/MUON/AliMUONDarcHeader.h
index d0974672b103ee8538200736924c32050ce9efc0..9503a12f52332203362e1737199579a9afb03fcf 100644 (file)
--- a/MUON/AliMUONDarcHeader.h
+++ b/MUON/AliMUONDarcHeader.h
@@ -9,7 +9,7 @@
 /// \class AliMUONDarcHeader
 /// \brief MUON Darc header for Trigger
 ///
-/// \author Christian Finck
+//  Author Christian Finck
 
 #include <TObject.h>
 #include <TClonesArray.h>
@@ -26,70 +26,108 @@ public:
    virtual ~AliMUONDarcHeader();
 
 
-   UInt_t  GetWord()               const {return fWord;}
-   Int_t   GetGlobalInput(Int_t n) const {return fGlobalInput[n];}
-   Int_t   GetGlobalOutput()       const {return (fGlobalOutput & 0xFFFF);}
-   Int_t   GetGlobalConfig()       const {return ((fGlobalOutput >> 16) & 0xFFFF);}
+            /// Return first word
+   UInt_t   GetWord()               const {return fWord;}
+            /// Return global input
+   Int_t    GetGlobalInput(Int_t n) const {return fGlobalInput[n];}
+            /// Return global output
+   UChar_t  GetGlobalOutput()       const {return (fGlobalOutput & 0xFF);}
+            /// Return global config  
+   UShort_t GetGlobalConfig()       const {return ((fGlobalOutput >> 16) & 0xFFFF);}
 
    //MBZ:1, phys trig:1, type:3, ,SerialNb:4,Version:8,VME trig:1, 
    //GlobalFlag:1, CTP trig:1, DAQ:1, Reg pattern:8;
 
+            /// Return event type
    Bool_t  GetEventType()  const {return (fWord &  0x40000000);}
-   UChar_t GetDarcType()   const {return (UChar_t)(fWord >> 27) &  0x7;}
-   UChar_t GetSerialNb()   const {return (UChar_t)(fWord >> 23) &  0xF;}
-   UChar_t GetVersion()    const {return (UChar_t)(fWord >> 15) &  0xFF;}
+            /// Return Darc type
+   UChar_t GetDarcType()   const {return (UChar_t)(fWord >> 24) &  0x7;}
+            /// Return serial number
+   UChar_t GetSerialNb()   const {return (UChar_t)(fWord >> 20) &  0xF;}
+            /// Return version
+   UChar_t GetVersion()    const {return (UChar_t)(fWord >> 13) &  0xFF;}
+            /// Return VME trig
    Bool_t  GetVMETrig()    const {return (fWord &  0x800);}
+            /// Return global flag
    Bool_t  GetGlobalFlag() const {return (fWord &  0x400);}
+            /// Return CPT trigger
    Bool_t  GetCTPTrig()    const {return (fWord &  0x200);}
+            /// Return DAQ flag
    Bool_t  GetDAQFlag()    const {return (fWord &  0x100);}
+            /// Return reg pattern
    UChar_t GetRegPattern() const {return (UChar_t)(fWord &  0xFF);}
 
+           /// Set first word
    void    SetWord(UInt_t w) {fWord = w;}
+           /// Set global input
    void    SetGlobalInput(Int_t in, Int_t n) {fGlobalInput[n] = in;}
+           /// Set global output
    void    SetGlobalOutput(Int_t out) {fGlobalOutput = out;}
 
+            /// Return darc header length
    Int_t   GetDarcHeaderLength()   const {return fgkDarcHeaderLength;}
+            /// Return global header length
    Int_t   GetGlobalHeaderLength() const {return fgkGlobalHeaderLength;}
 
+            /// Return header
    UInt_t* GetHeader() {return &fWord;}
+            /// Return global input
    Int_t*  GetGlobalInput()    {return &fGlobalInput[0];}
 
   // DARC get methods
+            /// Return DARC L0 received and used
    UInt_t  GetDarcL0R()     const {return fDarcL0R;}
+            /// Return DARC L1 physics
    UInt_t  GetDarcL1P()     const {return fDarcL1P;}
+            /// Return DARC L1 software
    UInt_t  GetDarcL1S()     const {return fDarcL1S;}
+            /// Return DARC L2 accept
    UInt_t  GetDarcL2A()     const {return fDarcL2A;}
+            /// Return DARC L2 reject
    UInt_t  GetDarcL2R()     const {return fDarcL2R;}
+            /// Return DARC clock
    UInt_t  GetDarcClock()   const {return fDarcClk;}
+            /// Return DARC hold (dead time)
    UInt_t  GetDarcHold()    const {return fDarcHold;}
    
    // don't use setting methods but memcpy
+            /// Return global L0
    UInt_t* GetGlobalScalers()  {return &fGlobalL0;}
+            /// Return DARC L0 received and used
    UInt_t* GetDarcScalers()    {return &fDarcL0R;} 
 
    // global get methods
+            /// Return global L0
    UInt_t  GetGlobalL0()      const {return fGlobalL0;}
+            /// Return global clock
    UInt_t  GetGlobalClock()   const {return fGlobalClk;}
+            /// Return global scaler
    const UInt_t* GetGlobalScaler()  const {return fGlobalScaler;}
+            /// Return global hold (dead time)
    UInt_t  GetGlobalHold()    const {return fGlobalHold;}
+            /// Return global spare
    UInt_t  GetGlobalSpare()   const {return fGlobalSpare;}
 
+            /// Return length of global scaler in word
    Int_t GetGlobalScalerLength() const {return fgkGlobalScalerLength;}
+            /// Return length of DARC scaler in word
    Int_t GetDarcScalerLength()   const {return fgkDarcScalerLength;} 
 
+            /// Return end of darc info word
    UInt_t GetEndOfDarc()     const {return fgkEndOfDarc;} 
+            /// Return end of global info word
    UInt_t GetEndOfGlobal()   const {return fgkEndOfGlobal;} 
 
    // set random numbers to fill variable
    void SetScalersNumbers();
 
-  // get TClonesArray
+   /// get TClonesArray
    TClonesArray*  GetRegHeaderArray()  const {return fRegHeaderArray;}
 
-   // get entries
+   /// get entries
    Int_t GetRegHeaderEntries()  const {return fRegHeaderArray->GetEntriesFast();}
 
-   // get entry
+   /// get entry
    AliMUONRegHeader* GetRegHeaderEntry(Int_t i) const  {
      return (AliMUONRegHeader*)fRegHeaderArray->At(i);}