//-*- Mode: C++ -*-
-// $Id:$
+// $Id$
#ifndef ALIHLTTRIGGERMENUITEM_H
#define ALIHLTTRIGGERMENUITEM_H
/* This file is property of and copyright by the ALICE HLT Project *
/**
* \class AliHLTTriggerMenuItem
- * TODO
+ * A trigger menu item is used to store the information for a single entry in the
+ * HLT global trigger menu AliHLTTriggerMenu.
+ * It stores information about the trigger condition, trigger domain merging
+ * expression, trigger priority, trigger scale-down and the prescalar to apply.
+ * The trigger condition is an expression which indicates what must be true
+ * for the trigger menu entry to be fired. A fired item will then use the trigger
+ * domain merging expression for the computation of the final global trigger domain.
+ * All expressions must be valid C++.
+ *
+ * The symbols used in the trigger condition expressions are assumed to be AliHLTTrigger
+ * names, unless they are predefined in the trigger menu symbols table. All symbols
+ * should be valid C++ symbol names. However, the '-' and '.' characters are allowed
+ * as a special extention. Neither the '-', nor '.' characters can be the first
+ * character of the symbol and there cannot be any spaces between it and the
+ * alphanumeric characters. If there are any spaces then the '-' or '.' character is
+ * treated as the normal C++ minus or dereferencing operator respectively.
+ * For example, "abc-xyz" is a single whole symbol, while "abc - xyz" are two symbols,
+ * abc and xyz, separated by a minus operator.
+ *
+ * Merging expressions can use all the symbols defined in the trigger menu symbols table
+ * including all the implicit symbols used in the trigger conditions which are assumed
+ * to be AliHLTTrigger names. If a AliHLTTrigger name is not used in a trigger condition
+ * expression, but one wants to use the trigger domain in a merging expression, then a
+ * predefined symbol must be added to the trigger menu symbol table. As an example, in
+ * the following manner:
+ * \code
+ * AliHLTGlobalTriggerConfig config("test config");
+ * config.AddSymbol("myTriggerName", "bool", "this->Result()", "0", "AliHLTTriggerDecision");
+ * \endcode
+ * The trigger name "myTriggerName" should be replaced with the actual name of the
+ * AliHLTTrigger from which one wants to use the trigger domain result.
+ * Symbols with the '-' sign are be handled automatically and will be replaced
+ * by their appropriate versions with the minus signs replaced by underscores.
+ * This means that a minus sign in any other location is always treated as an operator.
+ * If uncertain then just put spaces around the minus operator.
+ *
+ * \note The following symbol names are reserved and should not be used in either
+ * the trigger condition or merging expressions:
+ * _trigger_result_
+ * _domain_
+ * _description_
+ * _item_result_
+ * _group_result_
+ * _previous_match_
+ * _trigger_matched_
+ * FillFromMenu
+ * NewEvent
+ * Add
+ * CalculateTriggerDecision
+ * GetCounters
+ * SetCounters
+ * CreateNew
*/
class AliHLTTriggerMenuItem : public TObject
{
/**
* Returns the trigger condition expression.
*/
- const char* TriggerCondision() const { return fConditionExpr.Data(); }
+ const char* TriggerCondition() const { return fConditionExpr.Data(); }
/**
* Set the trigger condition expression.
*/
- void TriggerCondision(const char* value) { fConditionExpr = value; }
+ void TriggerCondition(const char* value) { fConditionExpr = value; }
/**
* Returns the trigger domain merging expression.
/**
* Set the pre-scalar value. A value of zero turns off the prescalar.
+ * \param value Indicates that only every n'th trigger should be passed.
+ * HLT triggers will be scaled down by the amount 1/value.
+ * \note If both the prescalar and the scale-down factors are set then the
+ * trigger rate reduction r will be higher and can be calculated by:
+ * r = 1/n * s
+ * where n is the prescalar value (an integer) and s is the scale down
+ * factor, which is a floating point number in the range [0..1].
*/
void PreScalar(UInt_t value) { fPrescalar = value; }
+
+ /**
+ * Returns the priority value.
+ */
+ UInt_t Priority() const { return fPriority; }
+
+ /**
+ * Set the priority value. Higher values give a higher priority.
+ */
+ void Priority(UInt_t value) { fPriority = value; }
+
+ /**
+ * Returns the scale down factor in the range [0..1].
+ */
+ Double_t ScaleDown() const { return fScaleDown; }
+
+ /**
+ * Set the scale down factor.
+ * \param value The scale down to set. Valid values are in the range [0..1].
+ * If <i>value</i> is outside the valid range it will be truncated the
+ * nearest valid value in the range.
+ * \note A scale-down of 0 indicates no triggers are passes through, 1 indicates
+ * all triggers are passed through and all values between this range will
+ * cause the triggers to be vetoed randomally so as to reproduce:
+ * triggers passed / triggers dropped = scale-down
+ */
+ void ScaleDown(Double_t value) { fScaleDown = (value < 0 ? 0 : (value > 1 ? 1 : value)); }
+
+ /**
+ * Returns the default result for the global trigger if this item is matched.
+ */
+ bool DefaultResult() const { return TestBit(BIT(15)) == 1; }
+
+ /**
+ * Set the default result for the global trigger if this item is matched.
+ */
+ void DefaultResult(bool value) { SetBit(BIT(15), value); }
private:
TString fConditionExpr; /// The trigger condition expression.
TString fDomainExpr; /// Trigger domain merging expression.
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.
+ UInt_t fPriority; /// Priority of the trigger menu item. Higher values have higher priority.
+ Double_t fScaleDown; /// Trigger scale-down factor to apply to this item. Valid values are in the range [0..1].
- ClassDef(AliHLTTriggerMenuItem, 2) // Trigger menu item for global HLT trigger.
+ ClassDef(AliHLTTriggerMenuItem, 4) // Trigger menu item for global HLT trigger.
};
#endif // ALIHLTTRIGGERMENUITEM_H
git://git.uio.no / u / mrichter / AliRoot.git / blobdiff