Coding conventions
authorivana <ivana@f7af4fe6-9843-0410-8265-dc069ae4e863>
Thu, 11 May 2006 15:00:43 +0000 (15:00 +0000)
committerivana <ivana@f7af4fe6-9843-0410-8265-dc069ae4e863>
Thu, 11 May 2006 15:00:43 +0000 (15:00 +0000)
(Rachid)

MUON/AliMUONGlobalTriggerBoard.cxx
MUON/AliMUONGlobalTriggerBoard.h
MUON/AliMUONRegionalTriggerBoard.cxx
MUON/AliMUONRegionalTriggerBoard.h
MUON/AliMUONTriggerBoard.cxx
MUON/AliMUONTriggerBoard.h
MUON/AliMUONTriggerCrate.cxx
MUON/AliMUONTriggerCrate.h

index 62b168bf7297ff31c0ca4e2afee7e90e86b7b129..26c144fe3faddfbf107473a22e6e7d2495ad18fd 100644 (file)
 /* $Id$ */
 
 //*-- Author: Rachid Guernane (LPCCFd)
+//    GLOBAL TRIGGER IMPLEMENTATION
+//    INPUTS ARE REGIONAL RESPONSES
+//    OUTPUT IS A 12-BIT WORD
+//    4 BITS PER TRIGGER LEVEL
 
 #include "AliMUONGlobalTriggerBoard.h"
 #include "AliLog.h"
@@ -40,6 +44,7 @@ AliMUONGlobalTriggerBoard::AliMUONGlobalTriggerBoard(const char *name, Int_t a)
 //___________________________________________
 void AliMUONGlobalTriggerBoard::Mask(Int_t index, UShort_t mask)
 {
+  // MASK GLOBAL TRIGGER BOARD INPUT index WITH VALUE mask
   if ( index>=0 && index < 16 ) 
   {
     fMask[index]=mask;
@@ -53,6 +58,8 @@ void AliMUONGlobalTriggerBoard::Mask(Int_t index, UShort_t mask)
 //___________________________________________
 void AliMUONGlobalTriggerBoard::Response()
 {
+   // COMPUTE THE GLOBAL TRIGGER BOARD
+   // RESPONSE ACCORDING TO THE Algo() METHOD
    Int_t t[16];
 
    for (Int_t i=0;i<16;i++) t[i] = fRegionalResponse[i] & fMask[i];
@@ -85,6 +92,7 @@ void AliMUONGlobalTriggerBoard::Response()
 //___________________________________________
 UShort_t AliMUONGlobalTriggerBoard::Algo(UShort_t i, UShort_t j, char *thres)
 {
+   // GLOBAL TRIGGER ALGORITHM
    TBits a(12), b(12); a.Set(12,&i); b.Set(12,&j);
 
    TBits trg1(2), trg2(2), trg(2);
@@ -143,9 +151,10 @@ UShort_t AliMUONGlobalTriggerBoard::Algo(UShort_t i, UShort_t j, char *thres)
 }
 
 //___________________________________________
-void AliMUONGlobalTriggerBoard::Scan(Option_t*)
+void AliMUONGlobalTriggerBoard::Scan(Option_t*) const
 {
-   TBits w(12); w.Set(12,&fResponse);
+  // PRINT GLOBAL TRIGGER OUTPUT 
+  TBits w(12); w.Set(12,&fResponse);
 
 // TRG[1:0]
 // 00 noth
index 92c7120a98767bb843aa4ff64533918ae6d2ec18..b91fd79acd9d0169d26b75fb56bd3cb35346771d 100644 (file)
@@ -5,7 +5,11 @@
 
 /* $Id$ */
 
-//*-- Author: Rachid Guernane (LPCCFd)
+/// \ingroup sim
+/// \class AliMUONGlobalTriggerBoard
+/// \brief GLOBAL TRIGGER
+///
+/// \author Rachid Guernane (LPCCFd)
 
 #include "AliMUONTriggerBoard.h"
 
@@ -25,16 +29,16 @@ class AliMUONGlobalTriggerBoard : public AliMUONTriggerBoard
 
       virtual void     Reset() {for (Int_t i=0; i<16; i++) fRegionalResponse[i] = 0;}
 
-      virtual void     Scan(Option_t *option);
+      virtual void     Scan(Option_t *option) const;
 
-      virtual void     Resp(Option_t*) {}
+      virtual void     Resp(Option_t*) const {}
 
       void Mask(Int_t index, UShort_t mask);
       
    private:
 
-      UShort_t fRegionalResponse[16];
-      UShort_t fMask[16];
+      UShort_t fRegionalResponse[16]; // REGIONAL BOARD RESPONSES
+      UShort_t fMask[16];             // MASK
 
    ClassDef(AliMUONGlobalTriggerBoard,1) 
 };
index 586153be5688ac7b06e5b1aca962612cfeeecb41..bed4fc89162a9e0e4c76e1575231231d6995ca7c 100644 (file)
 /* $Id$ */
 
 //*-- Author: Rachid Guernane (LPCCFd)
+//    DIMUON REGIONAL TRIGGER IMPLEMENTATION
+//    ENTRY ARE LOCAL BOARD RESPONSES
+//    OUTPUT IS 12-BIT WORD
+//    ALGORITHM IS SIMILAR TO THE GLOBAL ONE
 
 #include "AliMUONRegionalTriggerBoard.h"
 
@@ -42,7 +46,10 @@ AliMUONRegionalTriggerBoard::AliMUONRegionalTriggerBoard(const char *name, Int_t
 //___________________________________________
 void AliMUONRegionalTriggerBoard::Response()
 {
-   Int_t t[16];
+/*   
+  RESPONSE IS GIVEN FOLLOWING THE REGIONAL ALGORITHM
+*/
+  Int_t t[16];
 
    for (Int_t i=0;i<16;i++) t[i] = fLocalResponse[i] & fMask[i];
 
@@ -74,7 +81,10 @@ void AliMUONRegionalTriggerBoard::Response()
 //___________________________________________
 UShort_t AliMUONRegionalTriggerBoard::Algo(UShort_t i, UShort_t j, char *thres, Int_t level)
 {
-   TBits a(12), b(12); a.Set(12,&i); b.Set(12,&j);
+// IMPLEMENTATION OF THE REGIONAL ALGORITHM
+// SIMILAR TO THE GLOBAL ALGORITHM EXCEPT FOR THE
+// INPUT LAYER
+  TBits a(12), b(12); a.Set(12,&i); b.Set(12,&j);
 
    TBits trg1(2), trg2(2), trg(2);
 
@@ -161,10 +171,14 @@ UShort_t AliMUONRegionalTriggerBoard::Algo(UShort_t i, UShort_t j, char *thres,
 
    return rv;
 }
+
 //___________________________________________
-void AliMUONRegionalTriggerBoard::Scan(Option_t*)
+void AliMUONRegionalTriggerBoard::Scan(Option_t*) const
 {
-   for (Int_t i=0; i<16; i++) 
+/*  
+  SCAN LOCAL BOARD ENTRIES 
+*/
+  for (Int_t i=0; i<16; i++) 
    {
       TBits b;
       b.Set(6,&fLocalResponse[i]);
@@ -178,6 +192,7 @@ void AliMUONRegionalTriggerBoard::Scan(Option_t*)
 //___________________________________________
 void AliMUONRegionalTriggerBoard::Mask(Int_t index, UShort_t mask)
 {
+// MASK ENTRY index
   if ( index>=0 && index < 16 ) 
   {
     fMask[index]=mask;
index 498bbd506c0638bfc9045d0358c7017e5508784c..4748038048e6069af254cc32b3086ceefbdb44a9 100644 (file)
@@ -5,7 +5,11 @@
 
 /* $Id$ */
 
-//*-- Author: Rachid Guernane (LPCCFd)
+/// \ingroup sim
+/// \class AliMUONRegionalTriggerBoard
+/// \brief REGIONAL TRIGGER
+/// REAL HW ALGORITHM IS IMPLEMENTED
+/// \author Rachid Guernane (LPCCFd)
 
 #include "AliMUONTriggerBoard.h"
 
@@ -18,9 +22,9 @@ class AliMUONRegionalTriggerBoard : public AliMUONTriggerBoard
     
       virtual void Reset() {for (Int_t i=0; i<16; i++) fLocalResponse[i] = 0;}
 
-      virtual void Scan(Option_t *option);
+      virtual void Scan(Option_t *option) const;
 
-      virtual void Resp(Option_t*) {}
+      virtual void Resp(Option_t*) const {}
 
       virtual void Response();
 
@@ -31,8 +35,8 @@ class AliMUONRegionalTriggerBoard : public AliMUONTriggerBoard
       void Mask(Int_t index, UShort_t mask);
       
    private:
-      UShort_t fLocalResponse[16];
-      UShort_t fMask[16];
+      UShort_t fLocalResponse[16]; // Local trigger inputs
+      UShort_t fMask[16];          // Entry mask
       
       ClassDef(AliMUONRegionalTriggerBoard,1)
 };
index 895de1e7ae0b2f4b4c34afdaa9dbcda80f6764b4..0fe4b0f36fb06b52a57f2479dbd848119e360c20 100644 (file)
 /* $Id$ */
 
 //*-- Author: Rachid Guernane (LPCCFd)
+//    TRIGGER BOARD SUPER CLASS IMPLEMENTATION
+//    CAN BE A LOCAL, REGIONAL, OR GLOBAL BOARD
+//    REGIONAL BOARD IS PER CONVENTION
+//    ALWAYS IN THE SLOT 0
 
 #include "AliMUONTriggerBoard.h"
 #include "AliLog.h"
@@ -30,6 +34,7 @@ AliMUONTriggerBoard::AliMUONTriggerBoard()
 //___________________________________________
 AliMUONTriggerBoard::AliMUONTriggerBoard(const char *Name, Int_t islot) : TNamed(Name,"Trigger board")
 {
+// Standard Ctor
    fSlot = islot;
 
    fResponse = 0;
index e767cc0c5280b11896e4289014e2d0cb36244658..67672aa0213727c9daec6c37e658189c6074e7dd 100644 (file)
@@ -5,7 +5,11 @@
 
 /* $Id$ */
 
-//*-- Author: Rachid Guernane (LPCCFd)
+/// \ingroup sim
+/// \class AliMUONTriggerBoard
+/// \brief TRIGGER BOARD BASE CLASS
+///
+/// \author Rachid Guernane (LPCCFd)
 
 #include <TNamed.h>
 
@@ -23,19 +27,19 @@ class AliMUONTriggerBoard : public TNamed
 
       virtual void Reset() = 0;
 
-      virtual void Scan(Option_t *option) = 0;
+      virtual void Scan(Option_t *option) const = 0;
 
-      virtual void Resp(Option_t *option) = 0;
+      virtual void Resp(Option_t *option) const = 0;
 
-      virtual UShort_t GetResponse() {return fResponse;}
+      virtual UShort_t GetResponse() const {return fResponse;}
 
       virtual void Mask(Int_t index, UShort_t mask) = 0;
       
    protected:
 
-      Int_t fSlot; 
+      Int_t fSlot;                // SLOT NUMBER IN CRATE
 
-      UShort_t fResponse;
+      UShort_t fResponse;         // RESPONSE
 
       void Copy(TObject&) const;
 
index c123ff76a2f5283a8f63b328150e52138422de11..c656bfe3cd719a6bfd3037996fa6531cc51ec8db 100644 (file)
 /* $Id$ */
 
 //*-- Author: Rachid Guernane (LPCCFd)
+//    COLLECTION OF TRIGGER BOARDS
+//    ONE REGIONAL
+//    SIXTEEN LOCAL
+//    SLOT 0 HOLDS THE REGIONAL BOARD
+
+#include <TObjArray.h>
 
-#include "AliMUONTriggerCrate.h"
 #include "AliMUONTriggerBoard.h"
+#include "AliMUONTriggerCrate.h"
 
 ClassImp(AliMUONTriggerCrate)
 
@@ -47,6 +53,7 @@ AliMUONTriggerCrate::AliMUONTriggerCrate(const char *name, Int_t n) : TNamed(nam
 //___________________________________________
 void AliMUONTriggerCrate::AddBoard(AliMUONTriggerBoard *board, Int_t i)
 {
+  // ADD BOARD IN CRATE CONTAINER
    fBoards->AddAt(board,i);
    fNboards++;
 }
index ea49f3736924811357c4e30c33bc9d8f63f1b152..2a18da2bc1b97348dddde25cf70b4b8598717eb7 100644 (file)
@@ -5,12 +5,16 @@
 
 /* $Id$ */
 
-//*-- Author: Rachid Guernane (LPCCFd)
+/// \ingroup sim
+/// \class AliMUONTriggerCrate
+/// \brief Trigger Crate
+///
+/// \author Rachid Guernane (LPCCFd)
 
 #include <TNamed.h>
-#include <TObjArray.h>
 
 class AliMUONTriggerBoard;
+class TObjArray;
 
 class AliMUONTriggerCrate : public TNamed
 {
@@ -36,11 +40,11 @@ class AliMUONTriggerCrate : public TNamed
 
    private:
 
-      Int_t     fNslots;
-      Int_t     fNboards;
+      Int_t     fNslots;          // NUMBER OF SLOTS
+      Int_t     fNboards;         // NUMBER OF BOARDS
 
-      TObjArray *fBoards;
-      TString   fSourceFileName;
+      TObjArray *fBoards;         // POINTER TO BOARD OBJECTS
+      TString   fSourceFileName;  // SOURCE FILE
 
    ClassDef(AliMUONTriggerCrate,1)
 };