+//-*- Mode: C++ -*-
+// $Id$
#ifndef ALIHLTTRIGGER_H
#define ALIHLTTRIGGER_H
-/* This file is property of and copyright by the ALICE HLT Project *
+/* 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 AliHLTTrigger.cxx
+/// @author Artur Szostak <artursz@iafrica.com>
+/// @date 12 Aug 2008
+/// @brief Declaration of the AliHLTTrigger base component class.
+
#include "AliHLTProcessor.h"
+#include "AliHLTReadoutList.h"
+#include "AliHLTTriggerDomain.h"
+
+class AliHLTTriggerDecision;
+/**
+ * \class AliHLTTrigger
+ * This is the base class from which all HLT trigger components should inherit.
+ *
+ * The class implements an AliHLTProcessor and implements specific functions
+ * for the implementation of a trigger component.
+ *
+ * Mandatory functions to be implemented by the child class
+ * - GetTriggerName() <br>
+ * must return a unique char string, serves also as component id
+ * - DoTrigger()
+ * this is the processing method. Can loop over all input blocks and
+ * calculate a trigger decision based on the input
+ * - Spawn()
+ * refer to AliHLTComponent::Spawn() for more details
+ *
+ * The class provides default methods for the following methods of the
+ * component interface. The methods can still be overloaded if needed:
+ * - AliHLTComponent::GetNumberOfInputBlocks()
+ * - AliHLTComponent::GetInputDataTypes()
+ * - AliHLTComponent::GetOutputDataType()
+ * - AliHLTComponent::GetOutputDataTypes()
+ * - AliHLTComponent::GetOutputDataSize()
+ *
+ * Within the DoTrigger() function, the component has access to the input
+ * data via:
+ * - AliHLTComponent::GetFirstInputObject()
+ * - AliHLTComponent::GetNextInputObject()
+ * - AliHLTComponent::GetFirstInputBlock()
+ * - AliHLTComponent::GetNextInputBlock()
+ * - GetEventData()
+ * - GetTriggerData()
+ *
+ * Further information about the event and the external trigger classes
+ * can be checked by the base class methods:
+ * - AliHLTComponent::EvaluateCTPTriggerClass()
+ * - AliHLTComponent::GetRunNo() const;
+ * - AliHLTComponent::GetRunType() const;
+ * - AliHLTComponent::GetEventId()
+ *
+ * Inside DoTrigger() the component can call TriggerEvent() to create a
+ * trigger. The trigger information is stored and propagated in an
+ * AliHLTTriggerDecision object.
+ *
+ * \ingroup alihlt_trigger_components
+ */
class AliHLTTrigger : public AliHLTProcessor
{
public:
* Returns the name of the trigger. This must be unique across the system.
* This method is pure virtual and must be implemented by child classes.
* @return string containing the trigger name.
+ * \note The name returned by this method should be a valid C++ symbol name.
+ * Otherwise the global trigger component will not be able to handle the
+ * derived trigger component properly.
+ * As an extention the '-' character is allowed in the symbol name,
+ * but not as the first character.
*/
virtual const char* GetTriggerName() const = 0;
/**
* Get the input data types of the component.
* This method returns kAliHLTAnyDataType by default.
- * @param list <i>[out]</i>: The list of data types to be filled.
+ * @param [out] list The list of data types to be filled.
*/
- virtual void GetInputDataTypes(AliHLTComponentDataTypeList& list) const
- {
- list.push_back(kAliHLTAnyDataType);
- }
+ virtual void GetInputDataTypes(AliHLTComponentDataTypeList& list) const;
/**
* Returns extra output data types this trigger generates.
- * This returns an empty list by default.
- * @param list <i>[out]</i>: The list of data types to be filled.
+ * This returns kAliHLTDataTypeTriggerDecision by default.
+ * @param [out] list The list of data types to be filled.
+ * \note The underlying non const version of GetOutputDataTypes adds the value
+ * kAliHLTDataTypeReadoutList to the list automatically.
*/
- virtual void GetOutputDataTypes(AliHLTComponentDataTypeList& list) const
- {
- list.push_back(kAliHLTDataTypeTObject);
- }
+ virtual void GetOutputDataTypes(AliHLTComponentDataTypeList& list) const;
/**
- * Get a ratio by how much the data volume is shrinked or enhanced.
- * The method returns a size proporional to the trigger name string length
+ * Get a ratio by how much the data volume is shrunk or enhanced.
+ * The method returns a size proportional to the trigger name string length
* for constBase, and 1 for inputMultiplier.
- * @param constBase <i>[out]</i>: additive part, independent of the
- * input data volume
- * @param inputMultiplier <i>[out]</i>: multiplication ratio
+ * @param [out] constBase Additive part, independent of the input data volume
+ * @param [out] inputMultiplier Multiplication ratio.
*/
- virtual void GetOutputDataSize(unsigned long& constBase, double& inputMultiplier)
- {
- constBase = strlen(GetTriggerName()) + sizeof(TObjString) + 1;
- inputMultiplier = 1;
- }
+ virtual void GetOutputDataSize(unsigned long& constBase, double& inputMultiplier);
protected:
+ /// Not implemented.
+ AliHLTTrigger(const AliHLTTrigger& obj);
+ /// Not implemented.
+ AliHLTTrigger& operator = (const AliHLTTrigger& obj);
+
/**
* This method needs to be implemented by child classes to implement the actual
- * trigger algorithm. A possitive trigger decision is made by calling the TriggerEvent
+ * trigger algorithm. A positive trigger decision is made by calling the TriggerEvent
* method with TriggerEvent(true), or TriggerEvent(false) for a negative result
* (no trigger).
* If the AliHLTComponentEventData structure is needed for the current event being
* method when a trigger decision has been made.
* @param value The trigger decision value. True for positive trigger and false
* for a negative result. (true by default)
+ * \returns zero on success and negative value on failure. The possible failure
+ * codes are:<br>
+ * -ENOSPC - If there is not enough output buffer space for the trigger decision.<br>
+ * -ENOMSG - If the trigger decision object could not be serialised.
+ */
+ int TriggerEvent(bool value = true);
+
+ /**
+ * Fills the output with the given trigger decision. This should be called in the
+ * DoTrigger method when a custom trigger decision has been constructed.
+ * @param result The custom trigger decision object.
+ * @param type The data block type to use (set to
+ * kAliHLTDataTypeTObject|kAliHLTDataOriginOut by default).
+ * @param spec The data block specification to use (set to kAliHLTVoidDataSpec
+ * by default).
+ * \returns zero on success and negative value on failure. The possible failure
+ * codes are:<br>
+ * -ENOSPC - If there is not enough output buffer space for the trigger decision.<br>
+ * -ENOMSG - If the trigger decision object could not be serialised.<br>
+ * -EINVAL - If the <i>result</i> object is NULL.
+ */
+ int TriggerEvent(
+ AliHLTTriggerDecision* result,
+ const AliHLTComponentDataType& type = kAliHLTDataTypeTObject|kAliHLTDataOriginOut,
+ AliHLTUInt32_t spec = kAliHLTVoidDataSpec
+ );
+
+ /**
+ * This method allows one to completely ignore an event. The DoEvent method will
+ * not even generate a false trigger decision if this method is called.
*/
- void TriggerEvent(bool value = true);
+ void IgnoreEvent(bool value = true) { fDecisionMade = value; }
+
+ /**
+ * Method for finding out the result of the last call to TriggerEvent.
+ * \returns the error code for the last call to TriggerEvent.
+ */
+ int GetLastTriggerEventResult() const { return fTriggerEventResult; }
/**
* Returns the event data structure for the current event.
*/
AliHLTComponentTriggerData* GetTriggerData() const { return fTriggerData; }
+ /**
+ * Set a bit to 1 in the readout list which will enable that DDL for readout
+ * @param ddlId Equipment ID of DDL to readout, in decimal.
+ */
+ void EnableDDLBit(Int_t ddlId)
+ {
+ fReadoutList.EnableDDLBit(ddlId);
+ }
+
+ /**
+ * Set a bit to 0 in the readout list which will exclude that DDL from the readout.
+ * @param ddlId Equipment ID of DDL not to readout, in decimal.
+ */
+ void DisableDDLBit(Int_t ddlId)
+ {
+ fReadoutList.DisableDDLBit(ddlId);
+ }
+
+ /**
+ * Set or unset bit in the readout list.
+ * @param ddlId Equipment ID of DDL to set, in decimal.
+ * @param state kTRUE will enable readout of that DDL, kFALSE will disable readout.
+ */
+ void SetDDLBit(Int_t ddlId, Bool_t state)
+ {
+ fReadoutList.SetDDLBit(ddlId, state);
+ }
+
+ /**
+ * Returns the DDL readout list.
+ */
+ const AliHLTReadoutList& GetReadoutList() const { return fReadoutList; }
+
+ /**
+ * Returns the DDL readout list for modification by hand.
+ */
+ AliHLTReadoutList& GetReadoutList() { return fReadoutList; }
+
+ /**
+ * Sets the readout list object.
+ * \param value The new value to use for the readout list.
+ */
+ void SetReadoutList(const AliHLTReadoutList& value) { fReadoutList = value; }
+
+ /**
+ * Returns the DDL readout list block specification bits to be used.
+ */
+ AliHLTUInt32_t GetReadoutListSpecBits() const { return fReadoutListSpecBits; }
+
+ /**
+ * Sets the DDL readout list block specification bits to be used.
+ */
+ void SetReadoutListSpecBits(AliHLTUInt32_t spec) { fReadoutListSpecBits = spec; }
+
+ /**
+ * Returns the trigger domain object.
+ */
+ const AliHLTTriggerDomain& GetTriggerDomain() const { return fTriggerDomain; }
+
+ /**
+ * Returns the trigger domain object for modification.
+ */
+ AliHLTTriggerDomain& GetTriggerDomain() { return fTriggerDomain; }
+
+ /**
+ * Sets the trigger domain object.
+ * \param value The new value to use for the trigger domain.
+ */
+ void SetTriggerDomain(const AliHLTTriggerDomain& value) { fTriggerDomain = value; }
+
+ /**
+ * Returns the trigger description string.
+ */
+ const char* GetDescription() const { return fDescription.Data(); }
+
+ /**
+ * Sets the trigger description string.
+ * \param value The new value to use for the description string.
+ */
+ void SetDescription(const char* value) { fDescription = value; }
+
+ /**
+ * \returns true if the trigger description, trigger domain and readout list
+ * should be cleared for each new event.
+ */
+ bool WillClearInfoForNewEvent() const { return fClearInfo; }
+
+ /**
+ * Sets the flag indicating in the trigger description, trigger domain and
+ * readout list should be cleared for each new event.
+ * \param value The new value to use for the flag.
+ */
+ void ClearInfoForNewEvent(bool value = true) { fClearInfo = value; }
+
+ /**
+ * Create the EventDoneData and add the specified readout list
+ * from a Trigger domain object.
+ * @param domain the domain as calculated by the (Global)trigger
+ * @param type type of the readout list, defined by PubSub
+ * 3 monitoring filter
+ * 4 monitoring filter
+ * 5 monitoring filter
+ */
+ int CreateEventDoneReadoutFilter(const AliHLTTriggerDomain& domain, unsigned type);
+
private:
/**
* @return kAliHLTMultipleDataType is returned.
*/
virtual AliHLTComponentDataType GetOutputDataType() { return kAliHLTMultipleDataType; };
-
+
+ /**
+ * Inherited from AliHLTComponent. This method is deprecated so we hide it.
+ * Rather use the const version of this method which this method calls anyway.
+ * @param list list to receive the output data types.
+ */
+ virtual void GetInputDataTypes(AliHLTComponentDataTypeList& list);
+
/**
* Inherited from AliHLTComponent. This method is replaced with one that is
* symmetric to GetInputDataTypes that returns void, so we make this method
- * private.
+ * private. The list will always contain kAliHLTDataTypeTObject, including whatever
+ * values were added by the const version of GetOutputDataTypes.
* @param list list to receive the output data types.
* @return the number of elements in the list.
*/
- virtual int GetOutputDataTypes(AliHLTComponentDataTypeList& list)
- {
- GetOutputDataTypes(list);
- return list.size();
- }
+ virtual int GetOutputDataTypes(AliHLTComponentDataTypeList& list);
- const AliHLTComponentEventData* fEventData; ///! Event data for the current event. Only valid inside DoTrigger.
- AliHLTComponentTriggerData* fTriggerData; ///! Trigger data for the current event. Only valid inside DoTrigger.
- bool fDecisionMade; ///! Flag indicating if the trigger decision has been made for this trigger yet.
- int fTriggerEventResult; ///! Result returned by PushBack method in the TriggerEvent method.
+ const AliHLTComponentEventData* fEventData; //! Event data for the current event. Only valid inside DoTrigger.
+ AliHLTComponentTriggerData* fTriggerData; //! Trigger data for the current event. Only valid inside DoTrigger.
+ bool fDecisionMade; //! Flag indicating if the trigger decision has been made for this trigger yet.
+ bool fClearInfo; //! Flag indicating if fDescription, fReadoutList and fTriggerDomain should be cleared for each new event.
+ int fTriggerEventResult; //! Result returned by PushBack method in the TriggerEvent method.
+ TString fDescription; //! The description to use for the trigger decision.
+ AliHLTReadoutList fReadoutList; //! The DDL readout list object for the current event being processed.
+ AliHLTTriggerDomain fTriggerDomain; //! The trigger domain object for the current event being processed.
+ AliHLTUInt32_t fReadoutListSpecBits; //! Readout list data block specification bits used when generating the data block.
ClassDef(AliHLTTrigger, 0) // Base class for HLT triggers.
git://git.uio.no / u / mrichter / AliRoot.git / blobdiff