HLT/BASE/AliHLTOfflineDataSource.h

   1 // -*- Mode: C++ -*-
   2 // $Id$
   3
   4 #ifndef ALIHLTOFFLINEDATASOURCE_H
   5 #define ALIHLTOFFLINEDATASOURCE_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   AliHLTOfflineDataSource.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 "AliHLTDataSource.h"
  23 #include "AliHLTOfflineInterface.h"
  24
  25 /******************************************************************************/
  26
  27 /**
  28  * @class AliHLTOfflineDataSource
  29  * The class implements a AliRoot data source component base class.
  30  * The child class must implement the functions:
  31  * - @ref DoInit (optional)
  32  * - @ref DoDeinit (optional)
  33  * - @ref GetEvent
  34  * - @ref GetComponentID
  35  * - @ref GetOutputDataType
  36  * - @ref GetOutputDataSize
  37  * - @ref Spawn
  38  *
  39  * @note This class is only used for the @ref alihlt_system.
  40  *
  41  * @ingroup alihlt_system
  42  */
  43 class AliHLTOfflineDataSource
  44 : public AliHLTDataSource, public AliHLTOfflineInterface {
  45  public:
  46   /** standard constructor */
  47   AliHLTOfflineDataSource();
  48   /** destructor */
  49   virtual ~AliHLTOfflineDataSource();
  50
  51   /**
  52    * Default implementation as sources do not have a real FillESD method.
  53    */
  54   int FillESD(int /*eventNo*/, AliRunLoader* /*runLoader*/, AliESDEvent* /*esd*/) {
  55     return 0;
  56   }
  57
  58  private:
  59   /** copy constructor prohibited */
  60   AliHLTOfflineDataSource(const AliHLTOfflineDataSource&);
  61   /** assignment operator prohibited */
  62   AliHLTOfflineDataSource& operator=(const AliHLTOfflineDataSource&);
  63
  64   ClassDef(AliHLTOfflineDataSource, 1);
  65 };
  66
  67 #endif