Cluster indices are published via AliKalmanTrack::GetClusterIndex()

[u/mrichter/AliRoot.git] / HLT / BASE / AliHLTProcessor.h

diff --git a/HLT/BASE/AliHLTProcessor.h b/HLT/BASE/AliHLTProcessor.h
index 992cb562e571bffbfc028d859262f211a4415328..ec38516fb2910193353cb274a27970e780828608 100644 (file)
--- a/HLT/BASE/AliHLTProcessor.h
+++ b/HLT/BASE/AliHLTProcessor.h
@@ -1,8 +1,10 @@
+//-*- Mode: C++ -*-
 // @(#) $Id$
 
 #ifndef ALIHLTPROCESSOR_H
 #define ALIHLTPROCESSOR_H
-/* Copyright(c) 1998-1999, ALICE Experiment at CERN, All rights reserved. *
+/* 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   AliHLTProcessor.h
@@ -10,6 +12,12 @@
     @date   
     @brief  Base class declaration for HLT analysis components. */
 
+// see below for class documentation
+// or
+// refer to README to build package
+// or
+// visit http://web.ift.uib.no/~kjeks/doc/alice-hlt   
+
 #include "AliHLTComponent.h"
 
 /**
@@ -35,25 +43,19 @@ class AliHLTProcessor : public AliHLTComponent {
   /** standard destructor */
   virtual ~AliHLTProcessor();
 
-  /* depricated */
-  int Init( AliHLTComponentEnvironment* environ, void* environ_param, int argc, const char** argv );
-  /* depricated */
-  int Deinit();
-
   /**
    * Event processing function.
    * The method is called by the framework to process one event. After 
    * preparation of data structures. The call is redirected to DoEvent.
    * @return neg. error code if failed 
    */
-  int ProcessEvent( const AliHLTComponent_EventData& evtData,
-                   const AliHLTComponent_BlockData* blocks, 
-                   AliHLTComponent_TriggerData& trigData,
+  int DoProcessing( const AliHLTComponentEventData& evtData,
+                   const AliHLTComponentBlockData* blocks, 
+                   AliHLTComponentTriggerData& trigData,
                    AliHLTUInt8_t* outputPtr, 
                    AliHLTUInt32_t& size,
-                   AliHLTUInt32_t& outputBlockCnt, 
-                   AliHLTComponent_BlockData*& outputBlocks,
-                   AliHLTComponent_EventDoneData*& edd );
+                   AliHLTComponentBlockDataList& outputBlocks,
+                   AliHLTComponentEventDoneData*& edd );
 
   // Information member functions for registration.
 
@@ -63,9 +65,11 @@ class AliHLTProcessor : public AliHLTComponent {
    */
   TComponentType GetComponentType() { return AliHLTComponent::kProcessor;}
 
- private:
+ protected:
   /**
-   * Data processing method for the component.
+   * The low-level data processing method for the component.
+   * This is the custom processing method and can be overloaded by 
+   * the component.
    * @param evtData       event data structure
    * @param blocks        input data block descriptors
    * @param trigData     trigger data structure
@@ -73,14 +77,26 @@ class AliHLTProcessor : public AliHLTComponent {
    * @param size         <i>input</i>: size of target buffer
    *                     <i>output</i>:size of produced data
    * @param outputBlocks  list to receive output block descriptors
+   * @return neg. error code if failed                                <br>
+   *         -ENOSPC      output buffer too small
    */
-  virtual int DoEvent( const AliHLTComponent_EventData& evtData,
-                      const AliHLTComponent_BlockData* blocks, 
-                      AliHLTComponent_TriggerData& trigData,
+  virtual int DoEvent( const AliHLTComponentEventData& evtData,
+                      const AliHLTComponentBlockData* blocks, 
+                      AliHLTComponentTriggerData& trigData,
                       AliHLTUInt8_t* outputPtr, 
                       AliHLTUInt32_t& size,
-                      vector<AliHLTComponent_BlockData>& outputBlocks ) = 0;
+                      AliHLTComponentBlockDataList& outputBlocks );
+
+  /**
+   * The high-level data processing method.
+   * This is the default processing method; the method is called
+   * if no low level @ref DoEvent method is overloaded by the component.
+   * @param evtData       event data structure
+   * @param trigData     trigger data structure
+   * @return neg. error code if failed
+   */
+  virtual int DoEvent( const AliHLTComponentEventData& evtData, AliHLTComponentTriggerData& trigData);
 
-  ClassDef(AliHLTProcessor, 0)
+  ClassDef(AliHLTProcessor, 1)
 };
 #endif