HLT/BASE/AliHLTTriggerMenuItem.h

   1 //-*- Mode: C++ -*-
   2 // $Id:$
   3 #ifndef ALIHLTTRIGGERMENUITEM_H
   4 #define ALIHLTTRIGGERMENUITEM_H
   5 /* This file is property of and copyright by the ALICE HLT Project        *
   6  * ALICE Experiment at CERN, All rights reserved.                         *
   7  * See cxx source for full Copyright notice                               */
   8
   9 /// @file   AliHLTTriggerMenuItem.h
  10 /// @author Artur Szostak <artursz@iafrica.com>
  11 /// @date   19 Dec 2008
  12 /// @brief  Declaration of the AliHLTTriggerMenuItem class.
  13
  14 #include "TObject.h"
  15 #include "TString.h"
  16 #include "TArrayL.h"
  17
  18 /**
  19  * \class AliHLTTriggerMenuItem
  20  * TODO
  21  */
  22 class AliHLTTriggerMenuItem : public TObject
  23 {
  24  public:
  25
  26   /**
  27    * Default constructor.
  28    */
  29   AliHLTTriggerMenuItem();
  30
  31   /**
  32    * Default destructor.
  33    */
  34   virtual ~AliHLTTriggerMenuItem();
  35
  36   /**
  37    * Inherited from TObject, this prints the contents of the menu item.
  38    * \param option  Can be "compact", which will print in the compact format.
  39    */
  40   virtual void Print(Option_t* option = "") const;
  41
  42   /**
  43    * Returns the optional comment string.
  44    */
  45   const char* Description() const { return fDescription.Data(); }
  46
  47   /**
  48    * Set the optional comment string.
  49    */
  50   void Description(const char* value) { fDescription = value; }
  51
  52   /**
  53    * Returns the trigger condition expression.
  54    */
  55   const char* TriggerCondision() const { return fConditionExpr.Data(); }
  56
  57   /**
  58    * Set the trigger condition expression.
  59    */
  60   void TriggerCondision(const char* value) { fConditionExpr = value; }
  61
  62   /**
  63    * Returns the trigger domain merging expression.
  64    */
  65   const char* MergeExpression() const { return fDomainExpr.Data(); }
  66
  67   /**
  68    * Set the trigger domain merging expression.
  69    */
  70   void MergeExpression(const char* value) { fDomainExpr = value; }
  71
  72   /**
  73    * Returns the pre-scalar value.
  74    */
  75   UInt_t PreScalar() const { return fPrescalar; }
  76
  77   /**
  78    * Set the pre-scalar value. A value of zero turns off the prescalar.
  79    */
  80   void PreScalar(UInt_t value) { fPrescalar = value; }
  81
  82  private:
  83
  84   TString fDescription;  /// Optional description or comment string.
  85   TString fConditionExpr;  /// The trigger condition expression.
  86   TString fDomainExpr;  /// Trigger domain merging expression.
  87   UInt_t fPrescalar;  /// Pre-scalar value used to optionally reduce the trigger rate. Every modulus n'th event is triggered, where n equals the pre-scalar value.
  88
  89   ClassDef(AliHLTTriggerMenuItem, 2) // Trigger menu item for global HLT trigger.
  90 };
  91
  92 #endif // ALIHLTTRIGGERMENUITEM_H
  93