HLT/BASE/AliHLTOfflineDataSource.h

   1 // -*- Mode: C++ -*-
   2 // $Id$
   3
   4 #ifndef ALIHLTOFFLINEDATASOURCE_H
   5 #define ALIHLTOFFLINEDATASOURCE_H
   6 /* Copyright(c) 1998-1999, ALICE Experiment at CERN, All rights reserved. *
   7  * See cxx source for full Copyright notice                               */
   8
   9 /** @file   AliHLTOfflineDataSource.h
  10     @author Matthias Richter
  11     @date
  12     @brief  AliRoot data sink component base class.
  13 */
  14
  15 #include "AliHLTDataSource.h"
  16 #include "AliHLTOfflineInterface.h"
  17
  18 /******************************************************************************/
  19
  20 /**
  21  * @class AliHLTOfflineDataSource
  22  * The class implements a AliRoot data source component base class.
  23  * The child class must implement the functions:
  24  * - @ref DoInit (optional)
  25  * - @ref DoDeinit (optional)
  26  * - @ref GetEvent
  27  * - @ref GetComponentID
  28  * - @ref GetOutputDataType
  29  * - @ref GetOutputDataSize
  30  * - @ref Spawn
  31  *
  32  * @note This class is only used for the @ref alihlt_system.
  33  *
  34  * @ingroup alihlt_system
  35  */
  36 class AliHLTOfflineDataSource
  37 : public AliHLTDataSource, public AliHLTOfflineInterface {
  38  public:
  39   /** standard constructor */
  40   AliHLTOfflineDataSource();
  41   /** not a valid copy constructor, defined according to effective C++ style */
  42   AliHLTOfflineDataSource(const AliHLTOfflineDataSource&);
  43   /** not a valid assignment op, but defined according to effective C++ style */
  44   AliHLTOfflineDataSource& operator=(const AliHLTOfflineDataSource&);
  45   /** destructor */
  46   virtual ~AliHLTOfflineDataSource();
  47
  48   /**
  49    * Default implementation as sources do not have a real FillESD method.
  50    */
  51   int FillESD(int eventNo, AliRunLoader* runLoader, AliESD* esd) {
  52     if (esd==NULL && runLoader==NULL) {
  53       // get rid of 'unused parameter' warning
  54     }
  55     return 0;
  56   }
  57
  58  private:
  59
  60   ClassDef(AliHLTOfflineDataSource, 1);
  61 };
  62
  63 #endif