Adding new documentation page on Tracking DA

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

diff --git a/HLT/BASE/AliHLTProcessor.cxx b/HLT/BASE/AliHLTProcessor.cxx
index a846e07bb95b7155f7d21bd5adab9deb01cd079f..0221f56e25d7e7d5793e5b3e3c20009118546098 100644 (file)
--- a/HLT/BASE/AliHLTProcessor.cxx
+++ b/HLT/BASE/AliHLTProcessor.cxx
@@ -1,11 +1,12 @@
 // $Id$
 
 /**************************************************************************
- * 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.                         *
  *                                                                        *
- * Authors: Matthias Richter <Matthias.Richter@ift.uib.no>                *
- *          Timm Steinbeck <timm@kip.uni-heidelberg.de>                   *
- *          for The ALICE Off-line Project.                               *
+ * Primary Authors: Matthias Richter <Matthias.Richter@ift.uib.no>        *
+ *                  Timm Steinbeck <timm@kip.uni-heidelberg.de>           *
+ *                  for The ALICE HLT Project.                            *
  *                                                                        *
  * Permission to use, copy, modify and distribute this software and its   *
  * documentation strictly for non-commercial purposes is hereby granted   *
@@ -33,38 +34,61 @@ ClassImp(AliHLTProcessor)
 
 AliHLTProcessor::AliHLTProcessor()
 { 
+  // see header file for class documentation
+  // or
+  // refer to README to build package
+  // or
+  // visit http://web.ift.uib.no/~kjeks/doc/alice-hlt
 }
 
 AliHLTProcessor::~AliHLTProcessor()
 { 
+  // see header file for class documentation
 }
 
-int AliHLTProcessor::Init( AliHLTComponentEnvironment* environ, void* environ_param, int argc, const char** argv )
+int AliHLTProcessor::Init( AliHLTComponentEnvironment* environ, void* environParam, int argc, const char** argv )
 {
+  // see header file for class documentation
   int iResult=0;
-  iResult=AliHLTComponent::Init(environ, environ_param, argc, argv);
+  iResult=AliHLTComponent::Init(environ, environParam, argc, argv);
   return iResult;
 }
 
 int AliHLTProcessor::Deinit()
 {
+  // see header file for class documentation
   int iResult=0;
   iResult=AliHLTComponent::Deinit();
   return iResult;
 }
 
-int AliHLTProcessor::ProcessEvent( const AliHLTComponent_EventData& evtData, const AliHLTComponent_BlockData* blocks, 
-                           AliHLTComponent_TriggerData& trigData, AliHLTUInt8_t* outputPtr, 
-                           AliHLTUInt32_t& size, AliHLTUInt32_t& outputBlockCnt, 
-                           AliHLTComponent_BlockData*& outputBlocks,
-                           AliHLTComponent_EventDoneData*& edd )
+int AliHLTProcessor::DoProcessing( const AliHLTComponentEventData& evtData, const AliHLTComponentBlockData* blocks, 
+                           AliHLTComponentTriggerData& trigData, AliHLTUInt8_t* outputPtr, 
+                           AliHLTUInt32_t& size,
+                           vector<AliHLTComponentBlockData>& outputBlocks,
+                           AliHLTComponentEventDoneData*& edd )
 {
+  // see header file for class documentation
   int iResult=0;
-  vector<AliHLTComponent_BlockData> blockData;
-  iResult=DoEvent(evtData, blocks, trigData, outputPtr, size, blockData);
-  if (iResult>=0) {
-    iResult=MakeOutputDataBlockList(blockData, &outputBlockCnt, &outputBlocks);
-  }
+  iResult=DoEvent(evtData, blocks, trigData, outputPtr, size, outputBlocks);
   edd = NULL;
   return iResult;
 }
+
+int AliHLTProcessor::DoEvent( const AliHLTComponentEventData& evtData,
+                             const AliHLTComponentBlockData* /*blocks*/, 
+                             AliHLTComponentTriggerData& trigData,
+                             AliHLTUInt8_t* /*outputPtr*/, 
+                             AliHLTUInt32_t& /*size*/,
+                             vector<AliHLTComponentBlockData>& /*outputBlocks*/ )
+{
+  // we just forward to the high level method, all other parameters already
+  // have been stored internally
+  return DoEvent(evtData, trigData);
+}
+
+int AliHLTProcessor::DoEvent( const AliHLTComponentEventData& /*evtData*/, AliHLTComponentTriggerData& /*trigData*/)
+{
+  HLTFatal("no processing method implemented");
+  return -ENOSYS;
+}