Adding trigger domain and trigger decision classes. AliHLTTrigger now produces an...

[u/mrichter/AliRoot.git] / HLT / trigger / AliHLTTriggerDecision.h

#ifndef ALIHLTTRIGGERDECISION_H
#define ALIHLTTRIGGERDECISION_H
/* This file is property of and copyright by the ALICE HLT Project        *
 * ALICE Experiment at CERN, All rights reserved.                         *
 * See cxx source for full Copyright notice                               */

/// @file   AliHLTTriggerDecision.h
/// @author Artur Szostak <artursz@iafrica.com>
/// @date   21 Nov 2008
/// @brief  Declaration of the AliHLTTriggerDecision class storing the a AliHLTTrigger component's decision.

#include "TString.h"
#include "AliHLTReadoutList.h"
#include "AliHLTTriggerDomain.h"

/**
 * \class AliHLTTriggerDecision
 * Stores the information and result of a trigger decision made by a component
 * deriving from AliHLTTrigger. The information includes the DDL readout list
 * indicating which DDLs to readout and the trigger domain specifying which HLT
 * raw data blocks to forward to HLTOUT.
 */
class AliHLTTriggerDecision : public TObject
{
 public:
  
  /**
   * Default constructor.
   */
  AliHLTTriggerDecision();
  
  /**
   * Constructor specifying the result and trigger name.
   * \param result  The result of the trigger decision.
   * \param name  The name of the trigger decision. Should be the name of the
   *     AliHLTTrigger component.
   */
  AliHLTTriggerDecision(bool result, const char* name);
  
  /**
   * Constructor specifying all information fields.
   * \param result  The result of the trigger decision.
   * \param name  The name of the trigger decision. Should be the name of the
   *     AliHLTTrigger component.
   * \param readoutList  The DDL readout list for the trigger decision.
   * \param triggerDomain  The trigger domain for the trigger decision.
   * \param description  The description of (reason for) the trigger decision.
   */
  AliHLTTriggerDecision(
      bool result, const char* name, const AliHLTReadoutList& readoutList,
      const AliHLTTriggerDomain& triggerDomain, const char* description = ""
    );
  
  /**
   * Default destructor.
   */
  virtual ~AliHLTTriggerDecision();
  
  /**
   * Inherited from TObject. Returns the name of the trigger decision.
   */
  virtual const char* GetName() const { return fName.Data(); }
  
  /**
   * Inherited from TObject. This prints the contents of the trigger decision.
   * \param option  Can be "short" which will print the short format.
   */
  virtual void Print(Option_t* option = "") const;
  
  /**
   * Returns the result of the trigger decision.
   * \returns true if the event was triggered and should be readout.
   */
  bool EventTriggered() const { return Result(); }
  
  /**
   * Returns the result of the trigger decision.
   * The decision is stored in bit 15 of the fBits field.
   * \returns true if the event was triggered and should be readout.
   */
  bool Result() const { return TestBit(15) == 1; }
  
  /**
   * Sets the result of the trigger decision.
   * The decision is stored in bit 15 of the fBits field.
   * \param value  The value to set; true if the event triggered and should be
   *     readout and false otherwise.
   */
  void Result(bool value) { SetBit(15, value); }
  
  /**
   * Returns the name of the trigger decision.
   */
  const char* Name() const { return fName.Data(); }
  
  /**
   * Sets the name of the trigger decision.
   */
  void Name(const char* name) { fName = name; }
  
  /**
   * Returns the description of (reason for) the trigger decision.
   */
  const char* Description() const { return fDescription.Data(); }
  
  /**
   * Sets the description of the trigger decision.
   */
  void Description(const char* value) { fDescription = value; }
  
  /**
   * Returns the DDL readout list associated with this trigger decision.
   */
  const AliHLTReadoutList& ReadoutList() const { return fReadoutList; }
  
  /**
   * Returns the DDL readout list associated with this trigger decision for
   * modification.
   */
  AliHLTReadoutList& ReadoutList() { return fReadoutList; }
  
  /**
   * Sets the DDL readout list associated with this trigger decision.
   */
  void ReadoutList(const AliHLTReadoutList& value) { fReadoutList = value; }
  
  /**
   * Returns the trigger domain associated with this trigger decision.
   */
  const AliHLTTriggerDomain& TriggerDomain() const { return fTriggerDomain; }
  
  /**
   * Sets the trigger domain associated with this trigger decision.
   */
  void TriggerDomain(const AliHLTTriggerDomain& value) { fTriggerDomain = value; }
  
 private:
  
  TString fName; /// The name of the trigger decision. Should be the name of the trigger component that generated it.
  TString fDescription; /// Optional descriptive text giving the reason for the trigger.
  AliHLTReadoutList fReadoutList; /// The readout DDL list.
  AliHLTTriggerDomain fTriggerDomain;  /// The trigger domain associated with this trigger. i.e. the HLT data blocks to read out.
  
  ClassDef(AliHLTTriggerDecision, 1) // HLT trigger decision object storing information about the readout list, trigger domain and result.
};

#endif // ALIHLTTRIGGERDECISION_H