code cleanup, documentation, placement of 'using' statements

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

diff --git a/HLT/BASE/AliHLTOUTHandler.cxx b/HLT/BASE/AliHLTOUTHandler.cxx
index 981fbe99f07c773f37cc75991e2a0b5d25d7486f..fa7f925804bb5c6847beff8cad22e1ab260a333a 100644 (file)
--- a/HLT/BASE/AliHLTOUTHandler.cxx
+++ b/HLT/BASE/AliHLTOUTHandler.cxx
@@ -1,31 +1,26 @@
 // $Id$
 
-/**************************************************************************
- * This file is property of and copyright by the ALICE HLT Project        * 
- * ALICE Experiment at CERN, All rights reserved.                         *
- *                                                                        *
- * Primary Authors: Matthias Richter <Matthias.Richter@ift.uib.no>        *
- *                  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   *
- * without fee, provided that the above copyright notice appears in all   *
- * copies and that both the copyright notice and this permission notice   *
- * appear in the supporting documentation. The authors make no claims     *
- * about the suitability of this software for any purpose. It is          *
- * provided "as is" without express or implied warranty.                  *
- **************************************************************************/
-
-/** @file   AliHLTOUTHandler.cxx
-    @author Matthias Richter
-    @date   
-    @brief  Base class implementation of HLTOUT handlers.                    */
-
-  // see header file for class documentation
-  // or
-  // refer to README to build package
-  // or
-  // visit http://web.ift.uib.no/~kjeks/doc/alice-hlt
+//**************************************************************************
+//* This file is property of and copyright by the                          * 
+//* ALICE Experiment at CERN, All rights reserved.                         *
+//*                                                                        *
+//* Primary Authors: Matthias Richter <Matthias.Richter@ift.uib.no>        *
+//*                  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   *
+//* without fee, provided that the above copyright notice appears in all   *
+//* copies and that both the copyright notice and this permission notice   *
+//* appear in the supporting documentation. The authors make no claims     *
+//* about the suitability of this software for any purpose. It is          *
+//* provided "as is" without express or implied warranty.                  *
+//**************************************************************************
+
+/// @file   AliHLTOUTHandler.cxx
+/// @author Matthias Richter
+/// @date   
+/// @brief  Base class implementation of HLTOUT handlers.
+///
 
 #include "AliHLTOUTHandler.h"
 
@@ -33,15 +28,36 @@
 ClassImp(AliHLTOUTHandler)
 
 AliHLTOUTHandler::AliHLTOUTHandler()
+  :
+  fState(kHandlerOK)
 { 
-  // see header file for class documentation
-  // or
-  // refer to README to build package
-  // or
-  // visit http://web.ift.uib.no/~kjeks/doc/alice-hlt
+  // Base class declaration of HLT output handlers.
+  // The library implementation of the AliHLTModuleAgent allows to generate
+  // handlers for data blocks of the HLT output. This can be the output of
+  // the real HLT coming from the HLTOUT nodes, or simulated HLT output.
+  // Note: The created instance of AliHLTOUTHandler is deleted by the framework.
 }
 
 AliHLTOUTHandler::~AliHLTOUTHandler()
-{ 
-  // see header file for class documentation
+{
+  // destructor
+}
+
+int AliHLTOUTHandler::GetProcessedData(const AliHLTUInt8_t* &pData)
+{
+  // get pointer to processed data
+  pData=NULL;
+  return 0;
+}
+
+int AliHLTOUTHandler::ReleaseProcessedData(const AliHLTUInt8_t* /*pData*/, int /*size*/)
+{
+  // release the data pointer previously retrieved by GetProcessedData
+  return 0;
+}
+
+int AliHLTOUTHandler::FinishEvent()
+{
+  // cleanup the current event processing.
+  return 0;
 }