extra bit for TPC and Global constrained flagging

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

#ifndef ALIMUONDARCHEADER_H
#define ALIMUONDARCHEADER_H
/* Copyright(c) 1998-1999, ALICE Experiment at CERN, All rights reserved. *
 * See cxx source for full Copyright notice                               */

/*$Id$*/

/// \ingroup raw
/// \class AliMUONDarcHeader
/// \brief MUON Darc header for Trigger
///
//  Author Christian Finck

#include <TObject.h>
#include <TClonesArray.h>

class AliMUONRegHeader;

class AliMUONDarcHeader : public TObject {
 
public:
   AliMUONDarcHeader();
   AliMUONDarcHeader(const AliMUONDarcHeader& event);
   AliMUONDarcHeader& operator=(const AliMUONDarcHeader& event);

   virtual ~AliMUONDarcHeader();


            /// Return first word
   UInt_t   GetWord()               const {return fWord;}
            /// Return global input
   UInt_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);}
   Bool_t  GetEventType() const;
            /// 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 >> 12) &  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(UInt_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
   UInt_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;} 

           /// Return default type for DARC def.
   UInt_t GetDarcDefaultType()   const {return fgkDarcDefaultType;} 
          /// Return default type for DARC def.
   UInt_t GetDarcVadohrType()   const {return fgkDarcVadorhType;} 

   // set random numbers to fill variable
   void SetScalersNumbers();

   /// get TClonesArray
   TClonesArray*  GetRegHeaderArray()  const {return fRegHeaderArray;}

   /// get entries
   Int_t GetRegHeaderEntries()  const {return fRegHeaderArray->GetEntriesFast();}

   /// get entry
   AliMUONRegHeader* GetRegHeaderEntry(Int_t i) const  {
     return (AliMUONRegHeader*)fRegHeaderArray->At(i);}

   // clear
   void Clear(Option_t* opt);

 private:

   UInt_t    fWord;              ///< first word
   UInt_t    fGlobalInput[4];    ///< global input
   Int_t     fGlobalOutput;      ///< global ouput

   static const Int_t fgkDarcHeaderLength;   ///< darc header length
   static const Int_t fgkGlobalHeaderLength; ///< global header length


 // global card scalers   
   UInt_t     fGlobalL0;         ///< global L0
   UInt_t     fGlobalClk;        ///< global clock
   UInt_t     fGlobalScaler[6];  ///< global ouput
   UInt_t     fGlobalHold;       ///< global hold (dead time)
   UInt_t     fGlobalSpare;      ///< global spare
   static const Int_t      fgkGlobalScalerLength;  ///< length of global scaler in word

   // DARC Scalers
   UInt_t     fDarcL0R;       ///< DARC L0 received and used
   UInt_t     fDarcL1P;       ///< DARC L1 physics
   UInt_t     fDarcL1S;       ///< DARC L1 software
   UInt_t     fDarcL2A;       ///< DARC L2 accept
   UInt_t     fDarcL2R;       ///< DARC L2 reject
   UInt_t     fDarcClk;       ///< DARC clock
   UInt_t     fDarcHold;      ///< DARC hold (dead time)
   UInt_t     fDarcSpare;     ///< DARC Empty slot (for the moment)

   static const Int_t      fgkDarcScalerLength;  ///< length of DARC scaler in word

   static const UInt_t     fgkEndOfDarc;         ///< end of darc info word
   static const UInt_t     fgkEndOfGlobal;       ///< end of global info word

   static const UInt_t     fgkDarcDefaultType;   ///< default type for DARC def.
   static const UInt_t     fgkDarcVadorhType;    ///< default type for DARC vadorh


   TClonesArray* fRegHeaderArray; ///< container for regional header

   ClassDef(AliMUONDarcHeader,2)  // MUON DDL Trigger
};
#endif