- adding event type data block {EVENTTYP:PRIV} to component input blocks
[u/mrichter/AliRoot.git] / HLT / BASE / AliHLTComponent.h
1 //-*- Mode: C++ -*-
2 // $Id$
3
4 #ifndef ALIHLTCOMPONENT_H
5 #define ALIHLTCOMPONENT_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   AliHLTComponent.h
11     @author Matthias Richter, Timm Steinbeck
12     @date   
13     @brief  Base class declaration for HLT components. 
14     @note   The class is both used in Online (PubSub) and Offline (AliRoot)
15             context
16 */
17
18 /**
19  * @defgroup alihlt_component Component handling of the HLT module
20  * This section describes the the component base classes and handling for
21  * the HLT module.
22  *
23  * @section alihlt_component_intro General remarks
24  * HLT analysis is organized in so called components. Each component can
25  * subscribe to the data produced by other components and can from the
26  * analysis publish new data for the subsequent components. Only the
27  * input data blocks and entries from CDB are available for the analysis. 
28  *
29  * @section alihlt_component_intro Component implementation
30  * AliHLTComponent provides the interface for all components, see there
31  * for details. Three types are provided:
32  * - AliHLTProcessor
33  * - AliHLTDataSource
34  * - AliHLTDataSink
35  *
36  * The two last represent data sinks and sources for the HLT integration
37  * into AliRoot. When running only, only the processors are relevant,
38  * sources and sinks are provided by the HLT PubSub framework. Please check
39  * AliHLTComponent for detailed description.
40  *
41  * @section alihlt_component_registration Component registration
42  * Components need to be registered with the AliHLTComponentHandler in
43  * order to be used with the system. Registration is purely done from the
44  * module library. Two methods are possible:
45  * - the module library implements an AliHLTModuleAgent and overloads the
46  *   AliHLTModuleAgent::RegisterComponents() function
47  * - in the implementation file, one object is defined. The global object is
48  *   automatically instantiated when the library is loaded for the first
49  *   time and the object is used for registration.
50  *
51  * In both cases, the library must be loaded via the method
52  * <pre>
53  *  AliHLTComponentHandler::LoadComponentLibraries()
54  * </pre>
55  * For the global object approach it is important that the library is
56  * not loaded elsewhere before (e.g. a gSystem->Load operation in your
57  * rootlogon.C).
58  *
59  *
60  */
61
62 #include <vector>
63 #include <string>
64 #include "AliHLTLogging.h"
65 #include "AliHLTDataTypes.h"
66 #include "AliHLTCommonCDBEntries.h"
67
68 /* Matthias Dec 2006
69  * The names have been changed for Aliroot's coding conventions sake
70  * The old names are defined for backward compatibility with the 
71  * stand alone SampleLib package
72  */
73 typedef AliHLTComponentLogSeverity AliHLTComponent_LogSeverity;
74 typedef AliHLTComponentEventData AliHLTComponent_EventData;
75 typedef AliHLTComponentShmData AliHLTComponent_ShmData;
76 typedef AliHLTComponentDataType AliHLTComponent_DataType;
77 typedef AliHLTComponentBlockData AliHLTComponent_BlockData;
78 typedef AliHLTComponentTriggerData AliHLTComponent_TriggerData;
79 typedef AliHLTComponentEventDoneData AliHLTComponent_EventDoneData;
80
81 class AliHLTComponentHandler;
82 class TObjArray;
83 class TStopwatch;
84 class AliHLTComponent;
85 class AliHLTMemoryFile;
86
87 /** list of component data type structures */
88 typedef vector<AliHLTComponentDataType>   AliHLTComponentDataTypeList;
89 /** list of component block data structures */
90 typedef vector<AliHLTComponentBlockData>  AliHLTComponentBlockDataList;
91 /** list of component statistics struct */
92 typedef vector<AliHLTComponentStatistics> AliHLTComponentStatisticsList;
93 /** list of component pointers */
94 typedef vector<AliHLTComponent*>          AliHLTComponentPList;
95 /** list of memory file pointers */
96 typedef vector<AliHLTMemoryFile*>         AliHLTMemoryFilePList;
97
98 /**
99  * @class AliHLTComponent
100  * Base class of HLT data processing components.
101  * The class provides a common interface for HLT data processing components.
102  * The interface can be accessed from the online HLT framework or the AliRoot
103  * offline analysis framework.
104  * @section alihltcomponent-properties Component identification and properties
105  * Each component must provide a unique ID, input and output data type indications,
106  * and a spawn function.
107  * @subsection alihltcomponent-req-methods Required property methods
108  * - @ref GetComponentID
109  * - @ref GetInputDataTypes (see @ref alihltcomponent-type for default
110  *   implementations.)
111  * - @ref GetOutputDataType (see @ref alihltcomponent-type for default
112  *   implementations.)
113  * - @ref GetOutputDataSize (see @ref alihltcomponent-type for default
114  *   implementations.)
115  * - @ref Spawn
116  *
117  * @subsection alihltcomponent-opt-mehods Optional handlers
118  * - @ref DoInit
119  * - @ref DoDeinit
120  * - @ref GetOutputDataTypes
121  *   If the component has multiple output data types @ref GetOutputDataType
122  *   should return @ref kAliHLTMultipleDataType. The framework will invoke
123  *   @ref GetOutputDataTypes, a list can be filled.
124  *
125  * @subsection alihltcomponent-processing-mehods Data processing
126  * 
127  * 
128  * @subsection alihltcomponent-type Component type
129  * Components can be of type
130  * - @ref kSource     components which only produce data 
131  * - @ref kProcessor  components which consume and produce data
132  * - @ref kSink       components which only consume data
133  *
134  * where data production and consumption refer to the analysis data stream. In
135  * order to indicate the type, a child component can overload the
136  * @ref GetComponentType function.
137  * @subsubsection alihltcomponent-type-std Standard implementations
138  * Components in general do not need to implement this function, standard
139  * implementations of the 3 types are available:
140  * - AliHLTDataSource for components of type @ref kSource <br>
141  *   All types of data sources can inherit from AliHLTDataSource and must
142  *   implement the @ref AliHLTDataSource::GetEvent method. The class
143  *   also implements a standard method for @ref GetInputDataTypes.
144  *   
145  * - AliHLTProcessor for components of type @ref kProcessor <br>
146  *   All types of data processors can inherit from AliHLTProcessor and must
147  *   implement the @ref AliHLTProcessor::DoEvent method.
148  *
149  * - AliHLTDataSink for components of type @ref kSink <br>
150  *   All types of data processors can inherit from AliHLTDataSink and must
151  *   implement the @ref AliHLTDataSink::DumpEvent method. The class
152  *   also implements a standard method for @ref GetOutputDataType and @ref
153  *   GetOutputDataSize.
154  *
155  * @subsection alihltcomponent-environment Running environment
156  *
157  * In order to adapt to different environments (on-line/off-line), the component
158  * gets an environment structure with function pointers. The base class provides
159  * member functions for those environment dependend functions. The member 
160  * functions are used by the component implementation and are re-mapped to the
161  * corresponding functions.
162  *
163  * @section alihltcomponent-interfaces Component interfaces
164  * Each of the 3 standard component base classes AliHLTProcessor, AliHLTDataSource
165  * and AliHLTDataSink provides it's own processing method (see
166  * @ref alihltcomponent-type-std), which splits into a high and a low-level
167  * method. For the @ref alihltcomponent-low-level-interface, all parameters are
168  * shipped as function arguments, the component is supposed to write data to the
169  * output buffer and handle all block descriptors. 
170  * The @ref alihltcomponent-high-level-interface is the standard processing
171  * method and will be used whenever the low-level method is not overloaded.
172  *
173  * In both cases it is necessary to calculate/estimate the size of the output
174  * buffer before the processing. Output buffers can never be allocated inside
175  * the component because of the push-architecture of the HLT.
176  * For that reason the @ref GetOutputDataSize function should return a rough
177  * estimatian of the data to be produced by the component. The component is
178  * responsible for checking the memory size and must return -ENOSPC if the
179  * available buffer is too small, and update the estimator respectively. The
180  * framework will allocate a buffer of appropriate size and call the processing
181  * again.
182  *
183  * @subsection alihltcomponent-error-codes Data processing
184  * For return codes, the following scheme applies:
185  * - The data processing methods have to indicate error conditions by a negative
186  * error/return code. Preferably the system error codes are used like
187  * e.g. -EINVAL. This requires to include the header
188  * <pre>
189  * \#include \<cerrno\>
190  * </pre>
191  * - If no suitable input block could be found (e.g. no clusters for the TPC cluster
192  * finder) set size to 0, block list is empty, return 0
193  * - If no ususable or significant signal could be found in the input blocks
194  * return an empty output block, set size accordingly, and return 0. An empty output
195  * block here could be either a real empty one of size 0 (in which case size also
196  * would have to be set to zero) or a block filled with just the minimum necessary
197  * accounting/meta-structures. E.g. in the TPC
198  *
199  * @subsection alihltcomponent-high-level-interface High-level interface
200  * The high-level component interface provides functionality to exchange ROOT
201  * structures between components. In contrast to the 
202  * @ref alihltcomponent-low-level-interface, a couple of functions can be used
203  * to access data blocks of the input stream
204  * and send data blocks or ROOT TObject's to the output stream. The functionality
205  * is hidden from the user and is implemented by using ROOT's TMessage class.
206  *
207  * @subsubsection alihltcomponent-high-level-int-methods Interface methods
208  * The interface provides a couple of methods in order to get objects from the
209  * input, data blocks (non TObject) from the input, and to push back objects and
210  * data blocks to the output. For convenience there are several functions of 
211  * identical name (and similar behavior) with different parameters defined.
212  * Please refer to the function documentation.
213  * - @ref GetNumberOfInputBlocks <br>
214  *        return the number of data blocks in the input stream
215  * - @ref GetFirstInputObject <br>
216  *        get the first object of a specific data type
217  * - @ref GetNextInputObject <br>
218  *        get the next object of same data type as last GetFirstInputObject/Block call
219  * - @ref GetFirstInputBlock <br>
220  *        get the first block of a specific data type
221  * - @ref GetNextInputBlock <br>
222  *        get the next block of same data type as last GetFirstInputBlock/Block call
223  * - @ref PushBack <br>
224  *        insert an object or data buffer into the output
225  * - @ref CreateEventDoneData <br>
226  *        add event information to the output
227  * 
228  * In addition, the processing methods are simplified a bit by cutting out most of
229  * the parameters.
230  * @see 
231  * - @ref AliHLTProcessor::DoEvent
232  * - @ref AliHLTDataSource::GetEvent
233  * - @ref AliHLTDataSink::DumpEvent
234  *
235  * \em IMPORTANT: objects and block descriptors provided by the high-level interface
236  *  <b>MUST NOT BE DELETED</b> by the caller.
237  *
238  * @subsubsection alihltcomponent-high-level-int-guidelines High-level interface guidelines
239  * - Structures must inherit from the ROOT object base class TObject in order be 
240  * transported by the transportation framework.
241  * - all pointer members must be transient (marked <tt>//!</tt> behind the member
242  * definition), i.e. will not be stored/transported, or properly marked
243  * (<tt>//-></tt>) in order to call the streamer of the object the member is pointing
244  * to. The latter is not recomended. Structures to be transported between components
245  * should be streamlined.
246  * - no use of stl vectors/strings, use appropriate ROOT classes instead 
247  * 
248  * @subsection alihltcomponent-low-level-interface Low-level interface
249  * The low-level component interface consists of the specific data processing
250  * methods for @ref AliHLTProcessor, @ref AliHLTDataSource, and @ref AliHLTDataSink.
251  * - @ref AliHLTProcessor::DoEvent
252  * - @ref AliHLTDataSource::GetEvent
253  * - @ref AliHLTDataSink::DumpEvent
254  * 
255  * 
256  * @section alihltcomponent-handling Component handling 
257  * The handling of HLT analysis components is carried out by the AliHLTComponentHandler.
258  * Component are registered automatically at load-time of the component shared library
259  * under the following suppositions:
260  * - the component library has to be loaded from the AliHLTComponentHandler using the
261  *   @ref AliHLTComponentHandler::LoadLibrary method.
262  * - the component implementation defines one global object (which is generated
263  *   when the library is loaded)
264  *
265  * @subsection alihltcomponent-design-rules General design considerations
266  * The analysis code should be implemented in one or more destict class(es). A 
267  * \em component should be implemented which interface the destict analysis code to the
268  * component interface. This component generates the analysis object dynamically. <br>
269  *
270  * Assume you have an implemetation <tt> AliHLTDetMyAnalysis </tt>, another class <tt>
271  * AliHLTDetMyAnalysisComponent </tt> contains:
272  * <pre>
273  * private:
274  *   AliHLTDetMyAnalysis* fMyAnalysis;  //!
275  * </pre>
276  * The object should then be instantiated in the DoInit handler of 
277  * <tt>AliHLTDetMyAnalysisComponent </tt>, and cleaned in the DoDeinit handler.
278  *
279  * Further rules:
280  * - avoid big static arrays in the component, allocate the memory at runtime
281  *
282  * @ingroup alihlt_component
283  * @section alihltcomponent-members Class members
284  */
285 class AliHLTComponent : public AliHLTLogging {
286  public:
287   /** standard constructor */
288   AliHLTComponent();
289   /** standard destructor */
290   virtual ~AliHLTComponent();
291
292   /** component type definitions */
293   enum TComponentType { kUnknown=0, kSource=1, kProcessor=2, kSink=3 };
294
295   /**
296    * Init function to prepare data processing.
297    * Initialization of common data structures for a sequence of events.
298    * The call is redirected to the internal method @ref DoInit which can be
299    * overridden by the child class.<br>
300    * During Init also the environment structure is passed to the component.
301    * @param environ        environment pointer with environment dependend function
302    *                       calls
303    * @param environParam   additionel parameter for function calls, the pointer
304    *                       is passed as it is
305    * @param argc           size of the argument array
306    * @param argv           agument array for component initialization
307    */
308   virtual int Init( const AliHLTAnalysisEnvironment* environ, void* environParam, int argc, const char** argv );
309
310   /**
311    * Clean-up function to terminate data processing.
312    * Clean-up of common data structures after data processing.
313    * The call is redirected to the internal method @ref DoDeinit which can be
314    * overridden by the child class.
315    */
316   virtual int Deinit();
317
318   /**
319    * Processing of one event.
320    * The method is the entrance of the event processing. The parameters are
321    * cached for uses with the high-level interface and the DoProcessing
322    * implementation is called.
323    *
324    * @param evtData
325    * @param blocks
326    * @param trigData
327    * @param outputPtr
328    * @param size
329    * @param outputBlockCnt  out: size of the output block array, set by the component
330    * @param outputBlocks    out: the output block array is allocated internally
331    * @param edd
332    * @return neg. error code if failed
333    */
334   int ProcessEvent( const AliHLTComponentEventData& evtData, const AliHLTComponentBlockData* blocks, 
335                             AliHLTComponentTriggerData& trigData, AliHLTUInt8_t* outputPtr, 
336                             AliHLTUInt32_t& size, AliHLTUInt32_t& outputBlockCnt, 
337                             AliHLTComponentBlockData*& outputBlocks,
338                             AliHLTComponentEventDoneData*& edd );
339
340   /**
341    * Internal processing of one event.
342    * The method is pure virtual and implemented by the child classes 
343    * - @ref AliHLTProcessor
344    * - @ref AliHLTDataSource
345    * - @ref AliHLTDataSink
346    *
347    * @param evtData
348    * @param blocks
349    * @param trigData
350    * @param outputPtr
351    * @param size
352    * @param outputBlocks    out: the output block array is allocated internally
353    * @param edd
354    * @return neg. error code if failed
355    */
356   virtual int DoProcessing( const AliHLTComponentEventData& evtData, const AliHLTComponentBlockData* blocks, 
357                             AliHLTComponentTriggerData& trigData, AliHLTUInt8_t* outputPtr, 
358                             AliHLTUInt32_t& size,
359                             AliHLTComponentBlockDataList& outputBlocks,
360                             AliHLTComponentEventDoneData*& edd ) = 0;
361
362   /**
363    * Init the CDB.
364    * The function must not be called when running in AliRoot unless it it
365    * really wanted. The CDB path will be set to the specified path, which might
366    * override the path initialized at the beginning of the AliRoot reconstruction.
367    *
368    * The method is used from the external interface in order to set the correct
369    * path when running on-line. The function also initializes the function
370    * callback for setting the run no during operation.
371    *
372    * A separation of library and component handling is maybe appropriate in the
373    * future. Using the global component handler here is maybe not the cleanest
374    * solution.
375    * @param cdbPath      path of the CDB
376    * @param pHandler     the component handler used for llibrary handling.
377    */
378   int InitCDB(const char* cdbPath, AliHLTComponentHandler* pHandler);
379
380   /**
381    * Set the run no for the CDB.
382    * The function must not be called when running in AliRoot unless it it
383    * really wanted. The CDB path will be set to the specified path, which might
384    * override the run no initialized at the beginning of the AliRoot reconstruction.
385    * InitCDB() has to be called before in order to really change the CDB settings.
386    *
387    * The method is used from the external interface in order to set the correct
388    * path when running on-line.
389    */
390   int SetCDBRunNo(int runNo);
391
392   /**
393    * Set the run description.
394    * The run description is set before the call of Init() -> DoInit().
395    * @note: This functionality has been added in Juli 2008. The transmission of
396    * run properties by a special SOR (SOD event in DAQ terminalogy but this was
397    * changed after the HLT interface was designed) event is not sufficient because
398    * the data might be needed already in the DoInit handler of the component.
399    * @param desc    run descriptor, currently only the run no member is used
400    * @param runType originally, run type was supposed to be a number and part
401    *                of the run descriptor. But it was defined as string later
402    */
403   int SetRunDescription(const AliHLTRunDesc* desc, const char* runType);
404
405   /**
406    * Set the component description.
407    * The description string can contain tokens separated by blanks, a token
408    * consists of a key and an optional value separated by '='.
409    * Possible keys:
410    * \li -chainid=id        string id within the chain of the instance
411    *
412    * @param desc    component description
413    */
414   int SetComponentDescription(const char* desc);
415
416   // Information member functions for registration.
417
418   /**
419    * Get the type of the component.
420    * The function is pure virtual and must be implemented by the child class.
421    * @return component type id
422    */
423   virtual TComponentType GetComponentType() = 0; // Source, sink, or processor
424
425   /**
426    * Get the id of the component.
427    * Each component is identified by a unique id.
428    * The function is pure virtual and must be implemented by the child class.
429    * @return component id (string)
430    */
431   virtual const char* GetComponentID() = 0;
432
433   /**
434    * Get the input data types of the component.
435    * The function is pure virtual and must be implemented by the child class.
436    * @return list of data types in the vector reference
437    */
438   virtual void GetInputDataTypes( AliHLTComponentDataTypeList& ) = 0;
439
440   /**
441    * Get the output data type of the component.
442    * The function is pure virtual and must be implemented by the child class.
443    * @return output data type
444    */
445   virtual AliHLTComponentDataType GetOutputDataType() = 0;
446
447   /**
448    * Get the output data types of the component.
449    * The function can be implemented to indicate multiple output data types
450    * in the target array.
451    * @ref GetOutputDataType must return @ref kAliHLTMultipleDataType in order
452    * to invoke this method.
453    * @param tgtList          list to receive the data types
454    * @return no of output data types, data types in the target list
455    */
456   virtual int GetOutputDataTypes(AliHLTComponentDataTypeList& tgtList);
457
458   /**
459    * Get a ratio by how much the data volume is shrinked or enhanced.
460    * The function is pure virtual and must be implemented by the child class.
461    * @param constBase        <i>return</i>: additive part, independent of the
462    *                                   input data volume  
463    * @param inputMultiplier  <i>return</i>: multiplication ratio
464    * @return values in the reference variables
465    */
466   virtual void GetOutputDataSize( unsigned long& constBase, double& inputMultiplier ) = 0;
467
468   /**
469    * Spawn function.
470    * Each component must implement a spawn function to create a new instance of 
471    * the class. Basically the function must return <i>new <b>my_class_name</b></i>.
472    * @return new class instance
473    */
474   virtual AliHLTComponent* Spawn() = 0;
475
476   /**
477    * Find matching data types between this component and a consumer component.
478    * Currently, a component can produce only one type of data. This restriction is most
479    * likely to be abolished in the future.
480    * @param pConsumer a component and consumer of the data produced by this component
481    * @param tgtList   reference to a vector list to receive the matching data types.
482    * @return >= 0 success, neg. error code if failed
483    */ 
484   int FindMatchingDataTypes(AliHLTComponent* pConsumer, AliHLTComponentDataTypeList* tgtList);
485  
486   /**
487    * Set the global component handler.
488    * The static method is needed for the automatic registration of components. 
489    */
490   static int SetGlobalComponentHandler(AliHLTComponentHandler* pCH, int bOverwrite=0);
491
492   /**
493    * Clear the global component handler.
494    * The static method is needed for the automatic registration of components. 
495    */
496   static int UnsetGlobalComponentHandler();
497
498   /**
499    * Helper function to convert the data type to a string.
500    * @param type        data type structure
501    * @param mode        0 print string origin:type          <br>
502    *                    1 print chars                       <br>
503    *                    2 print numbers
504    */
505   static string DataType2Text( const AliHLTComponentDataType& type, int mode=0);
506
507   /**
508    * Calculate a CRC checksum of a data buffer.
509    * Polynomial for the calculation is 0xD8.
510    */
511   static AliHLTUInt32_t CalculateChecksum(const AliHLTUInt8_t* buffer, int size);
512
513   /**
514    * Helper function to print content of data type.
515    */
516   static void PrintDataTypeContent(AliHLTComponentDataType& dt, const char* format=NULL);
517
518   /**
519    * helper function to initialize AliHLTComponentEventData structure
520    */
521   static void FillEventData(AliHLTComponentEventData& evtData);
522
523   /**
524    * Print info on an AliHLTComponentDataType structure
525    * This is just a helper function to examine an @ref AliHLTComponentDataType
526    * structur.
527    */
528   static void PrintComponentDataTypeInfo(const AliHLTComponentDataType& dt);
529
530   /**
531    * Fill AliHLTComponentBlockData structure with default values.
532    * @param blockData   reference to data structure
533    */
534   static void FillBlockData( AliHLTComponentBlockData& blockData );
535
536   /**
537    * Fill AliHLTComponentShmData structure with default values.
538    * @param shmData   reference to data structure
539    */
540   static void FillShmData( AliHLTComponentShmData& shmData );
541
542   /**
543    * Fill AliHLTComponentDataType structure with default values.
544    * @param dataType   reference to data structure
545    */
546   static void FillDataType( AliHLTComponentDataType& dataType );
547   
548   /**
549    * Copy data type structure
550    * Copies the value an AliHLTComponentDataType structure to another one
551    * @param[out] tgtdt   target structure
552    * @param[in] srcdt   source structure
553    */
554   static void CopyDataType(AliHLTComponentDataType& tgtdt, const AliHLTComponentDataType& srcdt);
555
556   /**
557    * Set the ID and Origin of an AliHLTComponentDataType structure.
558    * The function sets the fStructureSize member and copies the strings
559    * to the ID and Origin. Only characters from the valid part of the string
560    * are copied, the rest is filled with 0's. <br>
561    * Please note that the fID and fOrigin members are not strings, just arrays of
562    * chars of size @ref kAliHLTComponentDataTypefIDsize and
563    * @ref kAliHLTComponentDataTypefOriginSize respectively and not necessarily with
564    * a terminating zero. <br>
565    * It is possible to pass NULL pointers as id or origin argument, in that case they
566    * are just ignored.
567    * @param tgtdt   target data type structure
568    * @param id      ID string
569    * @param origin  Origin string
570    */
571   static void SetDataType(AliHLTComponentDataType& tgtdt, const char* id, const char* origin);
572
573   /**
574    * Set the ID and Origin of an AliHLTComponentDataType structure.
575    * Given the fact that the data type ID is 64bit wide and origin 32, this helper
576    * function sets the data type from those two parameters.
577    * @param dt      target data type structure
578    * @param id      64bit id
579    * @param orig    32bit origin
580    */
581   static void SetDataType(AliHLTComponentDataType& dt, AliHLTUInt64_t id, AliHLTUInt32_t orig); 
582
583   /**
584    * Stopwatch type for benchmarking.
585    */
586   enum AliHLTStopwatchType {
587     /** total time for event processing */
588     kSWBase,
589     /** detector algorithm w/o interface callbacks */
590     kSWDA,
591     /** data sources */
592     kSWInput,
593     /** data sinks */
594     kSWOutput,
595     /** number of types */
596     kSWTypeCount
597   };
598
599   /**
600    * Helper class for starting and stopping a stopwatch.
601    * The guard can be used by instantiating an object in a function. The
602    * specified stopwatch is started and the previous stopwatch put on
603    * hold. When the function is terminated, the object is deleted automatically
604    * deleted, stopping the stopwatch and starting the one on hold.<br>
605    * \em IMPORTANT: never create dynamic objects from this guard as this violates
606    * the idea of a guard.
607    */
608   class AliHLTStopwatchGuard {
609   public:
610     /** standard constructor (not for use) */
611     AliHLTStopwatchGuard();
612     /** constructor */
613     AliHLTStopwatchGuard(TStopwatch* pStart);
614     /** copy constructor (not for use) */
615     AliHLTStopwatchGuard(const AliHLTStopwatchGuard&);
616     /** assignment operator (not for use) */
617     AliHLTStopwatchGuard& operator=(const AliHLTStopwatchGuard&);
618     /** destructor */
619     ~AliHLTStopwatchGuard();
620
621   private:
622     /**
623      * Hold the previous guard for the existence of this guard.
624      * Checks whether this guard controls a new stopwatch. In that case, the
625      * previous guard and its stopwatch are put on hold.
626      * @param pSucc        instance of the stopwatch of the new guard
627      * @return    1 if pSucc is a different stopwatch which should
628      *            be started<br>
629      *            0 if it controls the same stopwatch
630      */
631     int Hold(TStopwatch* pSucc);
632
633     /**
634      * Resume the previous guard.
635      * Checks whether the peceeding guard controls a different stopwatch. In that
636      * case, the its stopwatch is resumed.
637      * @param pSucc        instance of the stopwatch of the new guard
638      * @return    1 if pSucc is a different stopwatch which should
639      *            be stopped<br>
640      *            0 if it controls the same stopwatch
641      */
642     int Resume(TStopwatch* pSucc);
643
644     /** the stopwatch controlled by this guard */
645     TStopwatch* fpStopwatch;                                                //!transient
646
647     /** previous stopwatch guard, put on hold during existence of the guard */
648     AliHLTStopwatchGuard* fpPrec;                                           //!transient
649
650     /** active stopwatch guard */
651     static AliHLTStopwatchGuard* fgpCurrent;                                //!transient
652   };
653
654   /**
655    * Set a stopwatch for a given purpose.
656    * @param pSW         stopwatch object
657    * @param type        type of the stopwatch
658    */
659   int SetStopwatch(TObject* pSW, AliHLTStopwatchType type=kSWBase);
660
661   /**
662    * Init a set of stopwatches.
663    * @param pStopwatches object array of stopwatches
664    */
665   int SetStopwatches(TObjArray* pStopwatches);
666
667  protected:
668
669   /**
670    * Default method for the internal initialization.
671    * The method is called by @ref Init
672    */
673   virtual int DoInit( int argc, const char** argv );
674
675   /**
676    * Default method for the internal clean-up.
677    * The method is called by @ref Deinit
678    */
679   virtual int DoDeinit();
680
681   /**
682    * Reconfigure the component.
683    * The method is called when an event of type @ref kAliHLTDataTypeComConf
684    * {COM_CONF:PRIV} is received by the component. If the event is sent as
685    * part of a normal event, the component configuration is called first.
686    *
687    * The CDB path parameter specifies the path in the CDB, i.e. without
688    * leading absolute path of the CDB location. The framework might alse
689    * provide the id of the component in the analysis chain.
690    *
691    * \b Note: The CDB will be initialized by the framework, either already set
692    * from AliRoot or from the wrapper interface during initialization.
693    *
694    * @param cdbEntry     path of the cdbEntry
695    * @param chainId      the id/name of the component in the current analysis
696    *                     chain. This is not necessarily the same as what is
697    *                     returned by the GetComponentID() method.
698    * @note both parameters can be NULL, check before usage
699    */
700   virtual int Reconfigure(const char* cdbEntry, const char* chainId);
701
702   /**
703    * Read the Preprocessor values.
704    * The function is invoked when the component is notified about available/
705    * updated data points from the detector Preprocessors. The 'modules'
706    * argument contains all detectors for which the Preprocessors have
707    * updated data points. The component has to implement the CDB access to
708    * get the desired data points.
709    * @param modules     detectors for which the Preprocessors have updated
710    *                    data points: TPC, TRD, ITS, PHOS, MUON, or ALL if
711    *                    no argument was received.
712    * @return neg. error code if failed
713    */
714   virtual int ReadPreprocessorValues(const char* modules);
715
716   /**
717    * Custom handler for the SOR event.
718    * Is invoked from the base class if an SOR event is in the block list.
719    * The handler is called before the processing function. The processing
720    * function is skipped if there are no other data blocks available.
721    *
722    * The SOR event is generated by the PubSub framework in response to
723    * the DAQ start of data (SOD - has been renamed after HLT interface
724    * was designed). The SOD event consists of 3 blocks:
725    * - ::kAliHLTDataTypeEvent block: spec ::gkAliEventTypeStartOfRun
726    * - SOD block of type ::kAliHLTDataTypeSOR, payload: AliHLTRunDesc struct
727    * - run type block ::kAliHLTDataTypeRunType, payload: run type string 
728    *
729    * Run properties can be retrieved by getters like GetRunNo().
730    * @return neg. error code if failed
731    */
732   virtual int StartOfRun();
733
734   /**
735    * Custom handler for the EOR event.
736    * Is invoked from the base class if an EOR event is in the block list.
737    * The handler is called before the processing function. The processing
738    * function is skipped if there are no other data blocks available.
739    *
740    * See StartOfRun() for mor ecomments of the sequence of steering events.
741    *
742    * @return neg. error code if failed
743    */
744   virtual int EndOfRun();
745
746   /**
747    * Check whether a component requires all steering blocks.
748    * Childs can overload in order to indicate that they want to
749    * receive also the steering data blocks. There is also the
750    * possibility to add the required data types to the input
751    * data type list in GetInputDataTypes().
752    */
753   virtual bool RequireSteeringBlocks() const {return false;}
754
755   /**
756    * General memory allocation method.
757    * All memory which is going to be used 'outside' of the interface must
758    * be provided by the framework (online or offline).
759    * The method is redirected to a function provided by the current
760    * framework. Function pointers are transferred via the @ref
761    * AliHLTAnalysisEnvironment structure.
762    */
763   void* AllocMemory( unsigned long size );
764
765   /**
766    * Helper function to create a monolithic BlockData description block out
767    * of a list BlockData descriptors.
768    * For convenience, inside the interface vector lists are used, to make the
769    * interface pure C style, monilithic blocks must be exchanged. 
770    * The method is redirected to a function provided by the current
771    * framework. Function pointers are transferred via the @ref
772    * AliHLTAnalysisEnvironment structure.
773    */
774   int MakeOutputDataBlockList( const AliHLTComponentBlockDataList& blocks, AliHLTUInt32_t* blockCount,
775                                AliHLTComponentBlockData** outputBlocks );
776
777   /**
778    * Fill the EventDoneData structure.
779    * The method is redirected to a function provided by the current
780    * framework. Function pointers are transferred via the @ref
781    * AliHLTAnalysisEnvironment structure.
782    */
783   int GetEventDoneData( unsigned long size, AliHLTComponentEventDoneData** edd );
784
785   /**
786    * Helper function to convert the data type to a string.
787    */
788   void DataType2Text(const AliHLTComponentDataType& type, char output[kAliHLTComponentDataTypefIDsize+kAliHLTComponentDataTypefOriginSize+2]) const;
789
790   /**
791    * Get event number.
792    * @return value of the internal event counter
793    */
794   int GetEventCount() const;
795
796   /**
797    * Get the number of input blocks.
798    * @return number of input blocks
799    */
800   int GetNumberOfInputBlocks() const;
801
802   /**
803    * Get the first object of a specific data type from the input data.
804    * The hight-level methods provide functionality to transfer ROOT data
805    * structures which inherit from TObject.
806    *
807    * The method looks for the first ROOT object of type dt in the input stream.
808    * If also the class name is provided, the object is checked for the right
809    * class type. The input data block needs a certain structure, namely the 
810    * buffer size as first word. If the cross check fails, the retrieval is
811    * silently abondoned, unless the \em bForce parameter is set.<br>
812    * \b Note: THE OBJECT MUST NOT BE DELETED by the caller.
813    *
814    * If called without parameters, the function tries to create objects from
815    * all available input blocks, also the ones of data type kAliHLTVoidDataType
816    * which are not matched by kAliHLTAnyDataType.
817    *
818    * @param dt          data type of the object
819    * @param classname   class name of the object
820    * @param bForce      force the retrieval of an object, error messages
821    *                    are suppressed if \em bForce is not set
822    * @return pointer to @ref TObject, NULL if no objects of specified type
823    *         available
824    */
825   const TObject* GetFirstInputObject(const AliHLTComponentDataType& dt=kAliHLTAllDataTypes,
826                                      const char* classname=NULL,
827                                      int bForce=0);
828
829   /**
830    * Get the first object of a specific data type from the input data.
831    * The hight-level methods provide functionality to transfer ROOT data
832    * structures which inherit from TObject.
833    * The method looks for the first ROOT object of type specified by the ID and 
834    * Origin strings in the input stream.
835    * If also the class name is provided, the object is checked for the right
836    * class type. The input data block needs a certain structure, namely the 
837    * buffer size as first word. If the cross check fails, the retrieval is
838    * silently abondoned, unless the \em bForce parameter is set.<br>
839    * \em Note: THE OBJECT MUST NOT BE DELETED by the caller.
840    * @param dtID        data type ID of the object
841    * @param dtOrigin    data type origin of the object
842    * @param classname   class name of the object
843    * @param bForce      force the retrieval of an object, error messages
844    *                    are suppressed if \em bForce is not set
845    * @return pointer to @ref TObject, NULL if no objects of specified type
846    *         available
847    */
848   const TObject* GetFirstInputObject(const char* dtID, 
849                                      const char* dtOrigin,
850                                      const char* classname=NULL,
851                                      int bForce=0);
852
853   /**
854    * Get the next object of a specific data type from the input data.
855    * The hight-level methods provide functionality to transfer ROOT data
856    * structures which inherit from TObject.
857    * The method looks for the next ROOT object of type and class specified
858    * to the previous @ref GetFirstInputObject call.<br>
859    * \em Note: THE OBJECT MUST NOT BE DELETED by the caller.
860    * @param bForce      force the retrieval of an object, error messages
861    *                    are suppressed if \em bForce is not set
862    * @return pointer to @ref TObject, NULL if no more objects available
863    */
864   const TObject* GetNextInputObject(int bForce=0);
865
866   /**
867    * Get data type of an input block.
868    * Get data type of the object previously fetched via
869    * GetFirstInputObject/NextInputObject or the last one if no object
870    * specified.
871    * @param pObject     pointer to TObject
872    * @return data specification, kAliHLTVoidDataSpec if failed
873    */
874   AliHLTComponentDataType GetDataType(const TObject* pObject=NULL);
875
876   /**
877    * Get data specification of an input block.
878    * Get data specification of the object previously fetched via
879    * GetFirstInputObject/NextInputObject or the last one if no object
880    * specified.
881    * @param pObject     pointer to TObject
882    * @return data specification, kAliHLTVoidDataSpec if failed
883    */
884   AliHLTUInt32_t GetSpecification(const TObject* pObject=NULL);
885
886   /**
887    * Get the first block of a specific data type from the input data.
888    * The method looks for the first block of type dt in the input stream.
889    * It is intended to be used within the high-level interface.<br>
890    * \em Note: THE BLOCK DESCRIPTOR MUST NOT BE DELETED by the caller.
891    *
892    * If called without parameters, the function works on all input blocks,
893    * also the ones of data type kAliHLTVoidDataType which are not matched by
894    * kAliHLTAnyDataType.
895    *
896    * @param dt          data type of the block
897    * @return pointer to @ref AliHLTComponentBlockData
898    */
899   const AliHLTComponentBlockData* GetFirstInputBlock(const AliHLTComponentDataType& dt=kAliHLTAllDataTypes);
900
901   /**
902    * Get the first block of a specific data type from the input data.
903    * The method looks for the first block of type specified by the ID and 
904    * Origin strings in the input stream.  It is intended
905    * to be used within the high-level interface.<br>
906    * \em Note: THE BLOCK DESCRIPTOR MUST NOT BE DELETED by the caller.
907    * @param dtID        data type ID of the block
908    * @param dtOrigin    data type origin of the block
909    * @return pointer to @ref AliHLTComponentBlockData
910    */
911   const AliHLTComponentBlockData* GetFirstInputBlock(const char* dtID, 
912                                                       const char* dtOrigin);
913
914   /**
915    * Get input block by index.<br>
916    * \em Note: THE BLOCK DESCRIPTOR MUST NOT BE DELETED by the caller.
917    * @return pointer to AliHLTComponentBlockData, NULL if index out of range
918    */
919   const AliHLTComponentBlockData* GetInputBlock(int index) const;
920
921   /**
922    * Get the next block of a specific data type from the input data.
923    * The method looks for the next block  of type and class specified
924    * to the previous @ref GetFirstInputBlock call.
925    * To be used within the high-level interface.<br>
926    * \em Note: THE BLOCK DESCRIPTOR MUST NOT BE DELETED by the caller.
927    */
928   const AliHLTComponentBlockData* GetNextInputBlock();
929
930   /**
931    * Get data specification of an input block.
932    * Get data specification of the input bblock previously fetched via
933    * GetFirstInputObject/NextInputObject or the last one if no block
934    * specified.
935    * @param pBlock     pointer to input block
936    * @return data specification, kAliHLTVoidDataSpec if failed
937    */
938   AliHLTUInt32_t GetSpecification(const AliHLTComponentBlockData* pBlock=NULL);
939
940   /**
941    * Forward an input object to the output.
942    * Forward the input block of an object previously fetched via
943    * GetFirstInputObject/NextInputObject or the last one if no object
944    * specified.
945    * The block descriptor of the input block is forwarded to the
946    * output block list.
947    * @param pObject     pointer to TObject
948    * @return neg. error code if failed
949    */
950   int Forward(const TObject* pObject);
951
952   /**
953    * Forward an input block to the output.
954    * Forward the input block fetched via GetFirstInputObject/
955    * NextInputBlock or the last one if no block specified.
956    * The block descriptor of the input block is forwarded to the
957    * output block list.
958    * @param pBlock     pointer to input block
959    * @return neg. error code if failed
960    */
961   int Forward(const AliHLTComponentBlockData* pBlock=NULL);
962
963   /**
964    * Insert an object into the output.
965    * If header is specified, it will be inserted before the root object,
966    * default is no header.
967    * @param pObject     pointer to root object
968    * @param dt          data type of the object
969    * @param spec        data specification
970    * @param pHeader     pointer to header
971    * @param headerSize  size of Header
972    * @return neg. error code if failed 
973    */
974   int PushBack(TObject* pObject, const AliHLTComponentDataType& dt, 
975                AliHLTUInt32_t spec=kAliHLTVoidDataSpec, 
976                void* pHeader=NULL, int headerSize=0);
977
978   /**
979    * Insert an object into the output.
980    * If header is specified, it will be inserted before the root object,
981    * default is no header.
982    * @param pObject     pointer to root object
983    * @param dtID        data type ID of the object
984    * @param dtOrigin    data type origin of the object
985    * @param spec        data specification
986    * @param pHeader     pointer to header
987    * @param headerSize  size of Header
988    * @return neg. error code if failed 
989    */
990   int PushBack(TObject* pObject, const char* dtID, const char* dtOrigin,
991                AliHLTUInt32_t spec=kAliHLTVoidDataSpec,
992                void* pHeader=NULL, int headerSize=0);
993  
994   /**
995    * Insert an object into the output.
996    * @param pBuffer     pointer to buffer
997    * @param iSize       size of the buffer
998    * @param dt          data type of the object
999    * @param spec        data specification
1000    * @param pHeader     pointer to header
1001    * @param headerSize size of Header
1002    * @return neg. error code if failed 
1003    */
1004   int PushBack(void* pBuffer, int iSize, const AliHLTComponentDataType& dt,
1005                AliHLTUInt32_t spec=kAliHLTVoidDataSpec,
1006                void* pHeader=NULL, int headerSize=0);
1007
1008   /**
1009    * Insert an object into the output.
1010    * @param pBuffer     pointer to buffer
1011    * @param iSize       size of the buffer
1012    * @param dtID        data type ID of the object
1013    * @param dtOrigin    data type origin of the object
1014    * @param spec        data specification
1015    * @param pHeader     pointer to header
1016    * @param headerSize size of Header
1017    * @return neg. error code if failed 
1018    */
1019   int PushBack(void* pBuffer, int iSize, const char* dtID, const char* dtOrigin,
1020                AliHLTUInt32_t spec=kAliHLTVoidDataSpec,
1021                void* pHeader=NULL, int headerSize=0);
1022
1023   /**
1024    * Estimate size of a TObject
1025    * @param pObject
1026    * @return buffer size in byte
1027    */
1028   int EstimateObjectSize(TObject* pObject) const;
1029
1030   /**
1031    * Create a memory file in the output stream.
1032    * This method creates a TFile object which stores all data in
1033    * memory instead of disk. The TFile object is published as binary data.
1034    * The instance can be used like a normal TFile object. The TFile::Close
1035    * or @ref CloseMemoryFile method has to be called in order to flush the
1036    * output stream.
1037    *
1038    * \b Note: The returned object is deleted by the framework.
1039    * @param capacity    total size reserved for the memory file
1040    * @param dtID        data type ID of the file
1041    * @param dtOrigin    data type origin of the file
1042    * @param spec        data specification
1043    * @return file handle, NULL if failed 
1044    */
1045   AliHLTMemoryFile* CreateMemoryFile(int capacity, const char* dtID, const char* dtOrigin,
1046                                      AliHLTUInt32_t spec=kAliHLTVoidDataSpec);
1047
1048   /**
1049    * Create a memory file in the output stream.
1050    * This method creates a TFile object which stores all data in
1051    * memory instead of disk. The TFile object is published as binary data.
1052    * The instance can be used like a normal TFile object. The TFile::Close
1053    * or @ref CloseMemoryFile method has to be called in order to flush the
1054    * output stream.
1055    *
1056    * \b Note: The returned object is deleted by the framework.
1057    * @param capacity    total size reserved for the memory file
1058    * @param dt          data type of the file
1059    * @param spec        data specification
1060    * @return file handle, NULL if failed 
1061    */
1062   AliHLTMemoryFile* CreateMemoryFile(int capacity, 
1063                                      const AliHLTComponentDataType& dt=kAliHLTAnyDataType,
1064                                      AliHLTUInt32_t spec=kAliHLTVoidDataSpec);
1065
1066   /**
1067    * Create a memory file in the output stream.
1068    * This method creates a TFile object which stores all data in
1069    * memory instead of disk. The TFile object is published as binary data.
1070    * The instance can be used like a normal TFile object. The TFile::Close
1071    * or @ref CloseMemoryFile method has to be called in order to flush the
1072    * output stream.
1073    *
1074    * \b Note: The returned object is deleted by the framework.
1075    * @param dtID        data type ID of the file
1076    * @param dtOrigin    data type origin of the file
1077    * @param spec        data specification
1078    * @param capacity    fraction of the available output buffer size
1079    * @return file handle, NULL if failed 
1080    */
1081   AliHLTMemoryFile* CreateMemoryFile(const char* dtID, const char* dtOrigin,
1082                                      AliHLTUInt32_t spec=kAliHLTVoidDataSpec,
1083                                      float capacity=1.0);
1084
1085   /**
1086    * Create a memory file in the output stream.
1087    * This method creates a TFile object which stores all data in
1088    * memory instead of disk. The TFile object is published as binary data.
1089    * The instance can be used like a normal TFile object. The TFile::Close
1090    * or @ref CloseMemoryFile method has to be called in order to flush the
1091    * output stream.
1092    *
1093    * \b Note: The returned object is deleted by the framework.
1094    * @param dt          data type of the file
1095    * @param spec        data specification
1096    * @param capacity    fraction of the available output buffer size
1097    * @return file handle, NULL if failed 
1098    */
1099   AliHLTMemoryFile* CreateMemoryFile(const AliHLTComponentDataType& dt=kAliHLTAnyDataType,
1100                                      AliHLTUInt32_t spec=kAliHLTVoidDataSpec,
1101                                      float capacity=1.0);
1102
1103   /**
1104    * Write an object to memory file in the output stream.
1105    * @param pFile       file handle
1106    * @param pObject     pointer to root object
1107    * @param key         key in ROOT file
1108    * @param option      options, see TObject::Write
1109    * @return neg. error code if failed
1110    *         - -ENOSPC    no space left
1111    */
1112   int Write(AliHLTMemoryFile* pFile, const TObject* pObject, const char* key=NULL, int option=TObject::kOverwrite);
1113
1114   /**
1115    * Close object memory file.
1116    * @param pFile       file handle
1117    * @return neg. error code if failed
1118    *         - -ENOSPC    buffer size too small
1119    */
1120   int CloseMemoryFile(AliHLTMemoryFile* pFile);
1121
1122   /**
1123    * Insert event-done data information into the output.
1124    * @param edd          event-done data information
1125    */
1126   int CreateEventDoneData(AliHLTComponentEventDoneData edd);
1127
1128   /**
1129    * Get current run number
1130    */
1131   AliHLTUInt32_t GetRunNo() const;
1132
1133   /**
1134    * Get the current run type.
1135    */
1136   AliHLTUInt32_t GetRunType() const;
1137
1138   /**
1139    * Get the chain id of the component.
1140    */
1141   const char* GetChainId() const {return fChainId.c_str();}
1142
1143   /**
1144    * Check whether the current event is a valid data event.
1145    * @param pTgt    optional pointer to get the event type
1146    * @return true if the current event is a real data event
1147    */
1148   bool IsDataEvent(AliHLTUInt32_t* pTgt=NULL);
1149
1150   /**
1151    * Set a bit to 1 in a readout list ( = AliHLTEventDDL )
1152    * -> enable DDL for readout
1153    * @param list        readout list
1154    * @param ddlId       DDL Id to be turned on ( Decimal )
1155    */
1156   void EnableDDLBit(AliHLTEventDDL &list, Int_t ddlId ) const {
1157     SetDDLBit( list, ddlId, kTRUE ); 
1158   }
1159
1160   /**
1161    * Set a bit to 0 in a readout list ( = AliHLTEventDDL )
1162    * -> disable DDL for readout
1163    * @param list        readout list
1164    * @param ddlId       DDL Id to be turned on ( Decimal )
1165    */
1166   void DisableDDLBit(AliHLTEventDDL &list, Int_t ddlId ) const { 
1167     SetDDLBit( list, ddlId, kFALSE );  
1168   }
1169   
1170   /**
1171    * Set or unset  bit a readout list ( = AliHLTEventDDL )
1172    * -> enable or disable DDL for readout
1173    * @param list        readout list
1174    * @param ddlId       DDL Id to be turned on ( Decimal )
1175    * @param state       kTRUE sets it, kFALSE unsets it
1176    */
1177   void SetDDLBit(AliHLTEventDDL &list, Int_t ddlId, Bool_t state ) const;
1178   
1179   /**
1180    * Get the first word of a detector, which has a set DDL bit. 
1181    * Beware, this only works if DDLs of 1 detector are set. In the 
1182    * case of the TPC and TOF, which use 8 and 3 words, the first 
1183    * word is returned.
1184    * @param list        readout list
1185    * @return            returns the detector index, -1 if no bit is set
1186    *                    at all or several detectors (=error)
1187    */
1188   Int_t GetFirstUsedDDLWord(AliHLTEventDDL &list) const;
1189
1190   /**
1191    * Copy a struct from block data.
1192    * The function checks for block size and struct size. The least common
1193    * size will be copied to the target struct, remaining fields are initialized
1194    * to zero.<br>
1195    * The target struct must have a 32bit struct size indicator as first member.
1196    * @param pStruct     target struct
1197    * @param iStructSize size of the struct
1198    * @param iBlockNo    index of input block
1199    * @param structname  name of the struct (log messages)
1200    * @param eventname   name of the event (log messages)
1201    * @return size copied, neg. error if failed
1202    */
1203   int CopyStruct(void* pStruct, unsigned int iStructSize, unsigned int iBlockNo,
1204                  const char* structname="", const char* eventname="");
1205
1206  private:
1207   /** copy constructor prohibited */
1208   AliHLTComponent(const AliHLTComponent&);
1209   /** assignment operator prohibited */
1210   AliHLTComponent& operator=(const AliHLTComponent&);
1211
1212   /**
1213    * Increment the internal event counter.
1214    * To be used by the friend classes AliHLTProcessor, AliHLTDataSource
1215    * and AliHLTDataSink.
1216    * @return new value of the internal event counter
1217    * @internal
1218    */
1219   int IncrementEventCounter();
1220
1221   /**
1222    * Find the first input block of specified data type beginning at index.
1223    * Input blocks containing a TObject have the size of the object as an
1224    * unsigned 32 bit number in the first 4 bytes. This has to match the block
1225    * size minus 4.
1226    *
1227    * kAliHLTAllDataTypes is a special data type which includes both 
1228    * kAliHLTVoidDataType and kAliHLTAnyDataType.
1229    *
1230    * @param dt          data type
1231    * @param startIdx    index to start the search
1232    * @param bObject     check if this is an object
1233    * @return index of the block, -ENOENT if no block found
1234    *
1235    * @internal
1236    */
1237   int FindInputBlock(const AliHLTComponentDataType& dt, int startIdx=-1, int bObject=0) const;
1238
1239   /**
1240    * Get index in the array of input bocks.
1241    * Calculate index and check integrety of a block data structure pointer.
1242    * @param pBlock      pointer to block data
1243    * @return index of the block, -ENOENT if no block found
1244    *
1245    * @internal
1246    */
1247   int FindInputBlock(const AliHLTComponentBlockData* pBlock) const;
1248
1249   /**
1250    * Create an object from a specified input block.
1251    * @param idx         index of the input block
1252    * @param bForce      force the retrieval of an object, error messages
1253    *                    are suppressed if \em bForce is not set
1254    * @return pointer to TObject, caller must delete the object after use
1255    *
1256    * @internal
1257    */
1258   TObject* CreateInputObject(int idx, int bForce=0);
1259
1260   /**
1261    * Get input object
1262    * Get object from the input block list. The methods first checks whether the
1263    * object was already created. If not, it is created by @ref CreateInputObject
1264    * and inserted into the list of objects.
1265    * @param idx         index in the input block list
1266    * @param classname   name of the class, object is checked for correct class
1267    *                    name if set
1268    * @param bForce      force the retrieval of an object, error messages
1269    *                    are suppressed if \em bForce is not set
1270    * @return pointer to TObject
1271    *
1272    * @internal
1273    */
1274   TObject* GetInputObject(int idx, const char* classname=NULL, int bForce=0);
1275
1276   /**
1277    * Clean the list of input objects.
1278    * Cleanup is done at the end of each event processing.
1279    */
1280   int CleanupInputObjects();
1281
1282   /**
1283    * Insert a buffer into the output block stream.
1284    * This is the only method to insert blocks into the output stream, called
1285    * from all types of the Pushback method. The actual data might have been
1286    * written to the output buffer already. In that case NULL can be provided
1287    * as buffer, only the block descriptor will be build. If a header is specified, 
1288    * it will be inserted before the buffer, default is no header.
1289    * @param pBuffer     pointer to buffer
1290    * @param iBufferSize size of the buffer in byte
1291    * @param dt          data type
1292    * @param spec        data specification
1293    * @param pHeader     pointer to header
1294    * @param iHeaderSize size of Header
1295    * @return neg. error code if failed
1296    */
1297   int InsertOutputBlock(void* pBuffer, int iBufferSize,
1298                         const AliHLTComponentDataType& dt,
1299                         AliHLTUInt32_t spec,
1300                         void* pHeader=NULL, int iHeaderSize=0);
1301
1302   /**
1303    * Add a component statistics block to the output.
1304    */
1305   int AddComponentStatistics(AliHLTComponentBlockDataList& blocks, 
1306                              AliHLTUInt8_t* buffer,
1307                              AliHLTUInt32_t bufferSize,
1308                              AliHLTUInt32_t offset,
1309                              AliHLTComponentStatisticsList& stats) const;
1310
1311   /** The global component handler instance */
1312   static AliHLTComponentHandler* fgpComponentHandler;              //! transient
1313
1314   /** The environment where the component is running in */
1315   AliHLTAnalysisEnvironment fEnvironment;                         // see above
1316
1317   /** Set by ProcessEvent before the processing starts */
1318   AliHLTEventID_t fCurrentEvent;                                   // see above
1319
1320   /** internal event no */
1321   int fEventCount;                                                 // see above
1322
1323   /** the number of failed events */
1324   int fFailedEvents;                                               // see above
1325
1326   /** event data struct of the current event under processing */
1327   AliHLTComponentEventData fCurrentEventData;                      // see above
1328
1329   /** array of input data blocks of the current event */
1330   const AliHLTComponentBlockData* fpInputBlocks;                   //! transient
1331
1332   /** index of the current input block */
1333   int fCurrentInputBlock;                                          // see above
1334
1335   /** data type of the last block search */
1336   AliHLTComponentDataType fSearchDataType;                         // see above
1337
1338   /** name of the class for the object to search for */
1339   string fClassName;                                               // see above
1340
1341   /** array of generated input objects */
1342   TObjArray* fpInputObjects;                                       //! transient
1343  
1344   /** the output buffer */
1345   AliHLTUInt8_t* fpOutputBuffer;                                   //! transient
1346
1347   /** size of the output buffer */
1348   AliHLTUInt32_t fOutputBufferSize;                                // see above
1349
1350   /** size of data written to output buffer */
1351   AliHLTUInt32_t fOutputBufferFilled;                              // see above
1352
1353   /** list of ouput block data descriptors */
1354   AliHLTComponentBlockDataList fOutputBlocks;                      // see above
1355
1356   /** stopwatch array */
1357   TObjArray* fpStopwatches;                                        //! transient
1358
1359   /** array of memory files AliHLTMemoryFile */
1360   AliHLTMemoryFilePList fMemFiles;                                 //! transient
1361
1362   /** descriptor of the current run */
1363   AliHLTRunDesc* fpRunDesc;                                        //! transient
1364
1365   /** the current DDL list */
1366   AliHLTEventDDL* fpDDLList;                                       //! transient
1367
1368   /** external fct to set CDB run no, indicates external CDB initialization */
1369   void* fCDBSetRunNoFunc;                                          //! transient
1370
1371   /** id of the component in the analysis chain */
1372   string fChainId;                                                 //! transient
1373
1374   /** crc value of the chainid, used as a 32bit id */
1375   AliHLTUInt32_t fChainIdCrc;                                      //! transient
1376
1377   /** optional benchmarking for the component statistics */
1378   TStopwatch* fpBenchmark;                                         //! transient
1379
1380   /** component requires steering data blocks */
1381   bool fRequireSteeringBlocks;                                     //! transient
1382
1383   /** current event type */
1384   AliHLTUInt32_t fEventType;                                       //! transient
1385
1386   ClassDef(AliHLTComponent, 8)
1387 };
1388 #endif