]> git.uio.no Git - u/mrichter/AliRoot.git/blob - HLT/SampleLib/AliHLTSamplePreprocessor.h
minor update on documentation
[u/mrichter/AliRoot.git] / HLT / SampleLib / AliHLTSamplePreprocessor.h
1 //-*- Mode: C++ -*-
2 // @(#) $Id: AliHLTSamplePreprocessor.h 23318 2008-01-14 12:43:28Z hristov $
3
4 #ifndef ALIHLTSAMPLEPREPROCESSOR_H
5 #define ALIHLTSAMPLEPREPROCESSOR_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 /**
11  * @file   AliHLTSamplePreprocessor.h
12  * @author Kenneth Aamodt, Sebastian Bablok
13  * @date   2007-12-06
14  * @brief  HLT Preprocessor plugin for the AliHLTSample library
15  */
16
17 // see below for class documentation
18 // or
19 // refer to README to build package
20 // or
21 // visit http://web.ift.uib.no/~kjeks/doc/alice-hlt
22
23 #include "AliHLTModulePreprocessor.h"
24
25 /**
26  * @class AliHLTSamplePreprocessor
27  * A sample HLT preprocessor.
28  *
29  * @date 2008-01-22
30  */
31 class AliHLTSamplePreprocessor : public AliHLTModulePreprocessor
32 {
33  public:
34         
35   /** Constructor */
36   AliHLTSamplePreprocessor();
37
38   /** Destructor */
39   ~AliHLTSamplePreprocessor();
40
41   /**
42    * Initialize the Preprocessor.
43    *
44    * @param run run number
45    * @param startTime start time of data
46    * @param endTime end time of data
47    */
48   void Initialize(Int_t run, UInt_t startTime, UInt_t endTime);
49
50   /**
51    * Function to process data. Inside the preparation and storing to OCDB
52    * should be handled.
53    *
54    * @param dcsAliasMap the map containing aliases and corresponding DCS
55    *                    values and timestamps
56    *
57    * @return 0 on success; error code otherwise
58    */
59   UInt_t Process(TMap* dcsAliasMap);
60
61   /** Define for Temperature Histogram filename */
62   static const char* fgkTempHistoFileName;              // see above
63
64   /** Define module id */
65   const char* GetModuleID() {return "AliHLTSamplePreprocessor";};
66
67   const Int_t GetModuleNumber() {return AliHLTModulePreprocessor::DetectorBitMask("TPC");};
68
69  protected:
70
71  private:
72   /** copy constructor prohibited */
73   AliHLTSamplePreprocessor(const AliHLTSamplePreprocessor& preproc);
74   /** assignment operator prohibited */
75   AliHLTSamplePreprocessor& operator=(const AliHLTSamplePreprocessor& rhs);
76
77   /**
78    * Function fetch and prepare a dummy temperature histogram from the 
79    * HLT FXS.
80    *
81    * @return 0 in case of success, else an error code
82    */
83   UInt_t GetTempHisto();
84                 
85   ClassDef(AliHLTSamplePreprocessor, 0);
86 };
87 #endif