From 895f3660ca680ecc6b5209d57ab3f205e7836f16 Mon Sep 17 00:00:00 2001 From: richterm Date: Sat, 1 Aug 2009 09:04:31 +0000 Subject: [PATCH] updated component documentation --- HLT/trigger/AliHLTTrigger.h | 48 +++++++++++++++++-- HLT/trigger/AliHLTTriggerBarrelCosmic.h | 33 +++++++++++++ HLT/trigger/AliHLTTriggerBarrelMultiplicity.h | 40 ++++++++++++++++ 3 files changed, 118 insertions(+), 3 deletions(-) diff --git a/HLT/trigger/AliHLTTrigger.h b/HLT/trigger/AliHLTTrigger.h index 8eafcd2bfbd..de184d9a963 100644 --- a/HLT/trigger/AliHLTTrigger.h +++ b/HLT/trigger/AliHLTTrigger.h @@ -18,6 +18,48 @@ 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()
+ * 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 { @@ -56,7 +98,7 @@ class AliHLTTrigger : public AliHLTProcessor * \note The underlying non const version of GetOutputDataTypes adds the value * kAliHLTDataTypeTObject to the list. */ - virtual void GetOutputDataTypes(AliHLTComponentDataTypeList& /*list*/) const {} + virtual void GetOutputDataTypes(AliHLTComponentDataTypeList& list) const {} /** * Get a ratio by how much the data volume is shrunk or enhanced. @@ -104,8 +146,8 @@ class AliHLTTrigger : public AliHLTProcessor /** * 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 value The custom trigger decision object. - * @param datatype The data block type to use (set to + * @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). diff --git a/HLT/trigger/AliHLTTriggerBarrelCosmic.h b/HLT/trigger/AliHLTTriggerBarrelCosmic.h index c8b41f9d9f8..12a7c21e2e1 100644 --- a/HLT/trigger/AliHLTTriggerBarrelCosmic.h +++ b/HLT/trigger/AliHLTTriggerBarrelCosmic.h @@ -17,7 +17,40 @@ * @class AliHLTTriggerBarrelCosmic * HLT cosmics trigger component for the central barrel region. * + * NOTE: UNDER DEVELOPMENT + * + *

General properties:

+ * + * Component ID: \b BarrelCosmicsTrigger
+ * Library: \b libAliHLTTrigger.so
+ * Input Data Types: kAliHLTDataTypeESDObject, kAliHLTDataTypeESDTree + * kAliHLTDataTypeTrack
+ * Output Data Types: ::kAliHLTAnyDataType
+ * + *

Mandatory arguments:

+ * + * + *

Optional arguments:

+ * + * + *

Configuration:

+ * + * + * By default, configuration is loaded from OCDB, can be overridden by + * component arguments. + * + *

Default CDB entries:

+ * HLT/ConfigHLT/BarrelCosmicsTrigger: TObjString storing the arguments + * + *

Performance:

* + * + *

Memory consumption:

+ * + * + *

Output size:

+ * + * \ingroup alihlt_trigger_components */ class AliHLTTriggerBarrelCosmic : public AliHLTTrigger { diff --git a/HLT/trigger/AliHLTTriggerBarrelMultiplicity.h b/HLT/trigger/AliHLTTriggerBarrelMultiplicity.h index 4c2a79ba6b6..19e2c6660c3 100644 --- a/HLT/trigger/AliHLTTriggerBarrelMultiplicity.h +++ b/HLT/trigger/AliHLTTriggerBarrelMultiplicity.h @@ -22,6 +22,46 @@ class AliESDtrack; * central barrel. * * Triggers on charged particle number in a certain pt range. + * + *

General properties:

+ * + * Component ID: \b BarrelMultiplicityTrigger
+ * Library: \b libAliHLTTrigger.so
+ * Input Data Types: kAliHLTDataTypeESDObject, kAliHLTDataTypeESDTree + * kAliHLTDataTypeTrack
+ * Output Data Types: ::kAliHLTAnyDataType
+ * + *

Mandatory arguments:

+ * + * + *

Optional arguments:

+ * + * + *

Configuration:

+ * + * \li -mintracks n
+ * required number of tracks for a trigger + * \li -minpt pt
+ * required minimum pt for a trigger + * \li -maxpt pt
+ * required maximum pt for a trigger + * + * By default, configuration is loaded from OCDB, can be overridden by + * component arguments. + * + *

Default CDB entries:

+ * HLT/ConfigHLT/BarrelMultiplicityTrigger: TObjString storing the arguments + * + *

Performance:

+ * + * + *

Memory consumption:

+ * + * + *

Output size:

+ * + * + * \ingroup alihlt_trigger_components */ class AliHLTTriggerBarrelMultiplicity : public AliHLTTrigger { -- 2.43.0