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