adding decoding of participating detectors from the CTP_TRIGGER_CLASSES parameter
[u/mrichter/AliRoot.git] / HLT / BASE / AliHLTCTPData.h
1 //-*- Mode: C++ -*-
2 // $Id$
3
4 #ifndef ALIHLTCTPDATA_H
5 #define ALIHLTCTPDATA_H
6 //* This file is property of and copyright by the ALICE HLT Project        * 
7 //* ALICE Experiment at CERN, All rights reserved.                         *
8 //* See cxx source for full Copyright notice                               *
9
10 /** @file   AliHLTCTPData.h
11     @author Matthias Richter
12     @date   2009-08-20
13     @brief  Container for CTP trigger classes and counters
14 */
15
16 #include "TNamed.h"
17 #include "TClonesArray.h"
18 #include "TArrayL64.h"
19 #include "AliHLTLogging.h"
20 #include "AliHLTDataTypes.h"
21
22 /**
23  * @class AliHLTCTPData
24  * This is a container for the CTP trigger classes, the mapping to the bit
25  * field, and counters.
26  *
27  * The class is initialized from CTP_TRIGGER_CLASSES part of the ECS parameters.
28  * and stores internally a list of trigger classes holding the information on bit
29  * position, class name and involved detectors. The general format og the parameter
30  * is as follows:
31  * <pre>
32  * [bit position]:[Trigger class identifier string]:[detector-id-nr]-[detector-id-nr]-...,[bit position]:.....
33  * </pre>
34  *
35  * The list of participating detectors is converted into an AliHLTReadoutList
36  * object named after the trigger class name, and can be used as mask for the
37  * readout list generated by a component.
38  *
39  * The object is also stored as part of the HLTGlobalTriggerDecision
40  * @ingroup alihlt_trigger
41  */
42 class AliHLTCTPData: public TNamed, public AliHLTLogging
43 {
44  public:
45   /// default constructor
46   AliHLTCTPData();
47   /// standard constructor including initialization from CTP_TRIGGER_CLASS
48   AliHLTCTPData(const char* parameter);
49   /// destructor
50   virtual ~AliHLTCTPData();
51
52   /**
53    * Init the class ids and mapping from the CTP_TRIGGER_CLASS parameter.
54    * The general format of the parameter is as follows:
55    */
56   int InitCTPTriggerClasses(const char* ctpString);
57
58   /**
59    * Evaluate an expression of trigger class ids with respect to the trigger mask.
60    */
61   bool EvaluateCTPTriggerClass(const char* expression, AliHLTComponentTriggerData& trigData) const;
62
63   /**
64    * Reset all counters
65    */
66   void ResetCounters();
67
68   /**
69    * Get index of a trigger class in the tigger pattern
70    */
71   int Index(const char* name) const;
72
73   /**
74    * Increment counter for CTP trigger classes
75    * @param classIds  comma separated list of class ids
76    */
77   void Increment(const char* classIds);
78
79   /**
80    * Increment counter for CTP trigger classes
81    * @param triggerPattern  corresponds to the 50bit trigger mask in the CDH
82    */
83   void Increment(AliHLTUInt64_t triggerPattern);
84
85   /**
86    * Increment counter for a CTP trigger class
87    * @param classIdx  index of the class in the 50bit trigger mask
88    */
89   void Increment(int classIdx);
90
91   /**
92    * Increment counters according to the trigger data struct.
93    * First extract trigger pattern from the CDH and then
94    * increment from the trigger pattern.
95    */
96   int Increment(AliHLTComponentTriggerData& trigData);
97
98   /**
99    * Return a readout list for the active trigger classes.
100    * The list is an 'OR' of the active trugger classes.
101    */
102   AliHLTEventDDL ReadoutList(const AliHLTComponentTriggerData& trigData) const;
103
104   /**
105    * Inherited from TObject, this prints the contents of the trigger decision.
106    */
107   virtual void Print(Option_t* option = "") const;
108
109   AliHLTUInt64_t   Mask() const { return fMask; }
110   const TArrayL64& Counters() const { return fCounters; }
111   AliHLTUInt64_t   Counter(int index) const;
112   AliHLTUInt64_t   Counter(const char* classId) const;
113   const char*      Name(int index) const;
114
115  protected:
116  private:
117   /// copy constructor prohibited
118   AliHLTCTPData(const AliHLTCTPData&);
119   ///assignment operator prohibited
120   AliHLTCTPData& operator=(const AliHLTCTPData&);
121
122   AliHLTUInt64_t fMask;      /// mask of initialized trigger classes
123   TClonesArray   fClassIds;  /// array of trigger class ids
124   TArrayL64      fCounters;  /// trigger class counters
125
126   ClassDef(AliHLTCTPData, 0)
127 };
128
129 #endif