HLT/TPCLib/AliHLTTPCDigitDumpComponent.h

   1 //-*- Mode: C++ -*-
   2 // @(#) $Id$
   3
   4 #ifndef ALIHLTTPCDIGITDUMPCOMPONENT_H
   5 #define ALIHLTTPCDIGITDUMPCOMPONENT_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   AliHLTTPCDigitDumpComponent.h
  11     @author Matthias Richter
  12     @date
  13     @brief  Special file writer converting TPC digit input to ASCII.
  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 "AliHLTFileWriter.h"
  23
  24 /**
  25  * @class AliHLTTPCDigitDumpComponent
  26  * A converter for digit data of the TPC input to ASCII output.
  27  * Data is written to file.
  28  *
  29  * Component ID: \b TPCDigitDump <br>
  30  * Library: \b libAliHLTTPC
  31  *
  32  * See AliHLTFileWriter for arguments, further specific options
  33  * Mandatory arguments: <br>
  34  * <!-- NOTE: ignore the \li. <i> and </i>: it's just doxygen formating -->
  35  *
  36  * Optional arguments: <br>
  37  * <!-- NOTE: ignore the \li. <i> and </i>: it's just doxygen formating -->
  38  *
  39  */
  40 class AliHLTTPCDigitDumpComponent : public AliHLTFileWriter {
  41  public:
  42   /** default constructor */
  43   AliHLTTPCDigitDumpComponent();
  44   /** destructor */
  45   virtual ~AliHLTTPCDigitDumpComponent();
  46
  47   // interface functions: property getters
  48   virtual const char* GetComponentID();
  49   virtual void GetInputDataTypes(AliHLTComponentDataTypeList& list);
  50   virtual AliHLTComponent* Spawn();
  51
  52  protected:
  53   // interface functions: processing
  54   virtual int InitWriter();
  55   virtual int CloseWriter();
  56   virtual int DumpEvent( const AliHLTComponentEventData& evtData,
  57                          const AliHLTComponentBlockData* blocks,
  58                          AliHLTComponentTriggerData& trigData );
  59   virtual int ScanArgument(int argc, const char** argv);
  60
  61
  62  private:
  63   /** copy constructor prohibited */
  64   AliHLTTPCDigitDumpComponent(const AliHLTTPCDigitDumpComponent&);
  65   /** assignment operator prohibited */
  66   AliHLTTPCDigitDumpComponent& operator=(const AliHLTTPCDigitDumpComponent&);
  67
  68   ClassDef(AliHLTTPCDigitDumpComponent, 0);
  69 };
  70
  71 #endif