HLT/BASE/AliHLTOfflineDataSink.h

   1 // -*- Mode: C++ -*-
   2 // $Id$
   3
   4 #ifndef ALIHLTOFFLINEDATASINK_H
   5 #define ALIHLTOFFLINEDATASINK_H
   6 /* This file is property of and copyright by the ALICE HLT Project        *
   7  * ALICE Experiment at CERN, All rights reserved.                         *
   8  * See cxx source for full Copyright notice                               */
   9
  10 /** @file   AliHLTOfflineDataSink.h
  11     @author Matthias Richter
  12     @date
  13     @brief  AliRoot data sink component base class.
  14 */
  15
  16 // see below for class documentation
  17 // or
  18 // refer to README to build package
  19 // or
  20 // visit http://web.ift.uib.no/~kjeks/doc/alice-hlt
  21
  22 #include "AliHLTDataSink.h"
  23 #include "AliHLTOfflineInterface.h"
  24
  25 /******************************************************************************/
  26
  27 /**
  28  * @class AliHLTOfflineDataSink
  29  * The class implements a AliRoot data sink component base class.
  30  * The child class must implement the functions:
  31  * - @ref DoInit (optional)
  32  * - @ref DoDeinit (optional)
  33  * - @ref DumpEvent
  34  * - @ref GetComponentID
  35  * - @ref GetInputDataTypes
  36  * - @ref Spawn
  37  * - @ref FillESD
  38  *
  39  * @note This class is only used for the @ref alihlt_system.
  40  *
  41  * @note This class is very likely to be deprecated. According to the new
  42  * reconstruction scheme, the esd is no longer filled by components in the
  43  * reconstruction chain, but added to the HLTOUT data. The HLTOUT is
  44  * processed during AliReconstruction at the end of the HLT event processing,
  45  * literally during the FillESD method of the AliRoot reconstruction
  46  * interface. The HLT module must implement HLTOUT handlers and provide
  47  * those through the module agent.
  48  *
  49  * @ingroup alihlt_system
  50  */
  51 class AliHLTOfflineDataSink
  52 : public AliHLTDataSink, public AliHLTOfflineInterface
  53 {
  54  public:
  55   /** standard constructor */
  56   AliHLTOfflineDataSink();
  57   /** destructor */
  58   virtual ~AliHLTOfflineDataSink();
  59
  60  private:
  61   /** copy constructor prohibited */
  62   AliHLTOfflineDataSink(const AliHLTOfflineDataSink&);
  63   /** assignment operator prohibited */
  64   AliHLTOfflineDataSink& operator=(const AliHLTOfflineDataSink&);
  65
  66   ClassDef(AliHLTOfflineDataSink, 1);
  67 };
  68
  69 #endif