Add ZDC reconstruction to HLT
[u/mrichter/AliRoot.git] / HLT / ZDC / AliHLTZDCAgent.h
1 //-*- Mode: C++ -*-
2 // $Id: AliHLTZDCAgent.h $
3
4 #ifndef ALIHLTZDCAGENT_H
5 #define ALIHLTZDCAGENT_H
6
7 /* This file is property of and copyright by the ALICE HLT Project        * 
8  * ALICE Experiment at CERN, All rights reserved.                         *
9  * See cxx source for full Copyright notice                               */
10
11 /** @file    AliHLTZDCAgent.h
12     @author Chiara Oppedisano <Chiara.Oppedisano@to.infn.it>
13     @brief   Agent of the libAliHLTZDC library
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 "AliHLTModuleAgent.h"
23
24 /**
25  * @class AliHLTZDCAgent
26  * This is the agent for the AliHLTZDC library.<br>
27  *
28  * The sample agent implements all interface function provided by @ref
29  * AliHLTModuleAgent :
30  * - CreateConfigurations() <br>
31  *   The method gets an instance of the AliHLTConfigurationHanler to add
32  *   configurations, e.g. 
33  *   <pre>
34  *   handler->CreateConfiguration("my-puplisher"  , "FilePublisher", NULL , "data.bin");
35  *   ...
36  *   handler->CreateConfiguration("my-analysis-chain"  , "FileWriter", "my-processor" , "my arguments");
37  *   </pre>
38  * - GetReconstructionChains() <br>
39  *   returns a string of blank separated configurations to be run during
40  *   local event reconstruction.
41  *   <pre>
42  *   return "my-data-sink my-analysis-chain";
43  *   </pre>
44  * - GetRequiredComponentLibraries() <br>
45  *   returns a string of blank separated libraries which have to be loaded
46  *   in addition in order to load all required components. <br>
47  *   @note Not the right place for library dependencies.
48  *   <pre>
49  *   return "libAliHLTUtil.so";
50  *   </pre>
51  * - RegisterComponents() <br>
52  *   registers the components: AliHLTDummyComponent, AliHLTSampleComponent1,
53  *   AliHLTSampleComponent2, and AliHLTSampleMonitoringComponent<br>
54  * - GetHandlerDescription() <br>
55  *   Handles HLTOUT data blocks of type {DDL_RAW,SMPL}
56  *   <pre>
57  *   if (dt==(kAliHLTDataTypeDDLRaw|kAliHLTDataOriginSample)) {
58  *     desc=AliHLTOUTHandlerDesc(kRawReader, dt, GetModuleId());
59  *     return 1;
60  *   }
61  *   </pre>
62  * - GetOutputHandler() <br>
63  *   Returns handler AliHLTOUTHandlerEquId for HLTOUT data blocks of
64  *   type {DDL_RAW,SMPL}
65  *   <pre>
66  *   if (dt==(kAliHLTDataTypeDDLRaw|kAliHLTDataOriginSample)) {
67  *     return new AliHLTOUTHandlerEquId;
68  *   }
69  *   </pre>
70  * - DeleteOutputHandler() <br>
71  *   Deletes the output handler. In this case there is no special handling
72  *   needed.
73  *
74  * In order to hook the sample library up to the HLT system on global object
75  * @ref gAliHLTZDCAgent of the agent is defined in the source code.
76  * 
77  * @ingroup alihlt_system
78  */
79 class AliHLTZDCAgent : public AliHLTModuleAgent {
80  public:
81
82   /**
83    * standard constructor. The agent is automatically registered in the
84    * global agent manager
85    */
86   AliHLTZDCAgent();
87   
88 /** destructor */
89   virtual ~AliHLTZDCAgent();
90
91   /**
92    * Register all configurations belonging to the ZDC library with the
93    * AliHLTConfigurationHandler. 
94    * @param handler   [in] the configuration handler
95    * @param rawReader [in] AliRoot RawReader instance 
96    * @param runloader [in] AliRoot runloader
97    * @return neg. error code if failed
98    */
99   int CreateConfigurations(AliHLTConfigurationHandler* handler,
100                            AliRawReader* rawReader=NULL,
101                            AliRunLoader* runloader=NULL) const;
102
103   /**
104    * Get the top configurations for local event reconstruction.
105    * A top configuration describes a processing chain. It can simply be
106    * described by the last configuration(s) in the chain. 
107    * @param rawReader [in] AliRoot RawReader instance 
108    * @param runloader [in] AliRoot runloader
109    * @return string containing the top configurations separated by blanks
110    */
111   const char* GetReconstructionChains(AliRawReader* rawReader=NULL,
112                                       AliRunLoader* runloader=NULL) const;
113
114   /**
115    * Component libraries which the configurations of this agent depend on.
116    * @return list of component libraries as a blank-separated string.
117    */
118   const char* GetRequiredComponentLibraries() const;
119
120   /**
121    * Register components for the AliHLTZDC library.
122    * @param pHandler  [in] instance of the component handler          
123    */
124   int RegisterComponents(AliHLTComponentHandler* pHandler) const;
125   
126   /** interface function, see @ref AliHLTModuleAgent for description */
127   int GetHandlerDescription(AliHLTComponentDataType dt,
128                             AliHLTUInt32_t spec,
129                             AliHLTOUTHandlerDesc& desc) const;
130
131   /** interface function, see @ref AliHLTModuleAgent for description */
132   AliHLTOUTHandler* GetOutputHandler(AliHLTComponentDataType dt, AliHLTUInt32_t spec);
133   
134   /** interface function, see @ref AliHLTModuleAgent for description */                              
135   int DeleteOutputHandler(AliHLTOUTHandler* pInstance);
136
137   /** interface function, see @ref AliHLTModuleAgent for description */
138   AliHLTModulePreprocessor* GetPreprocessor();
139
140  private:
141   /** copy constructor prohibited */
142   AliHLTZDCAgent(const AliHLTZDCAgent&);
143
144   /** assignment operator prohibited */
145   AliHLTZDCAgent& operator=(const AliHLTZDCAgent&);
146
147   /** ROOT specific member definition */
148   ClassDef(AliHLTZDCAgent, 0);
149 };
150
151 #endif