added optional component statistics functionality
[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 AliHLTDataSource 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 AliHLTDataSource 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 dump 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 to 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( AliHLTComponentEnvironment* 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   // Information member functions for registration.
406
407   /**
408    * Get the type of the component.
409    * The function is pure virtual and must be implemented by the child class.
410    * @return component type id
411    */
412   virtual TComponentType GetComponentType() = 0; // Source, sink, or processor
413
414   /**
415    * Get the id of the component.
416    * Each component is identified by a unique id.
417    * The function is pure virtual and must be implemented by the child class.
418    * @return component id (string)
419    */
420   virtual const char* GetComponentID() = 0;
421
422   /**
423    * Get the input data types of the component.
424    * The function is pure virtual and must be implemented by the child class.
425    * @return list of data types in the vector reference
426    */
427   virtual void GetInputDataTypes( AliHLTComponentDataTypeList& ) = 0;
428
429   /**
430    * Get the output data type of the component.
431    * The function is pure virtual and must be implemented by the child class.
432    * @return output data type
433    */
434   virtual AliHLTComponentDataType GetOutputDataType() = 0;
435
436   /**
437    * Get the output data types of the component.
438    * The function can be implemented to indicate multiple output data types
439    * in the target array.
440    * @ref GetOutputDataType must return @ref kAliHLTMultipleDataType in order
441    * to invoke this method.
442    * @param tgtList          list to receive the data types
443    * @return no of output data types, data types in the target list
444    */
445   virtual int GetOutputDataTypes(AliHLTComponentDataTypeList& tgtList);
446
447   /**
448    * Get a ratio by how much the data volume is shrinked or enhanced.
449    * The function is pure virtual and must be implemented by the child class.
450    * @param constBase        <i>return</i>: additive part, independent of the
451    *                                   input data volume  
452    * @param inputMultiplier  <i>return</i>: multiplication ratio
453    * @return values in the reference variables
454    */
455   virtual void GetOutputDataSize( unsigned long& constBase, double& inputMultiplier ) = 0;
456
457   /**
458    * Spawn function.
459    * Each component must implement a spawn function to create a new instance of 
460    * the class. Basically the function must return <i>new <b>my_class_name</b></i>.
461    * @return new class instance
462    */
463   virtual AliHLTComponent* Spawn() = 0;
464
465   /**
466    * Find matching data types between this component and a consumer component.
467    * Currently, a component can produce only one type of data. This restriction is most
468    * likely to be abolished in the future.
469    * @param pConsumer a component and consumer of the data produced by this component
470    * @param tgtList   reference to a vector list to receive the matching data types.
471    * @return >= 0 success, neg. error code if failed
472    */ 
473   int FindMatchingDataTypes(AliHLTComponent* pConsumer, AliHLTComponentDataTypeList* tgtList);
474  
475   /**
476    * Set the global component handler.
477    * The static method is needed for the automatic registration of components. 
478    */
479   static int SetGlobalComponentHandler(AliHLTComponentHandler* pCH, int bOverwrite=0);
480
481   /**
482    * Clear the global component handler.
483    * The static method is needed for the automatic registration of components. 
484    */
485   static int UnsetGlobalComponentHandler();
486
487   /**
488    * Helper function to convert the data type to a string.
489    * @param type        data type structure
490    * @param mode        0 print string origin:type          <br>
491    *                    1 print chars                       <br>
492    *                    2 print numbers
493    */
494   static string DataType2Text( const AliHLTComponentDataType& type, int mode=0);
495
496   /**
497    * Helper function to print content of data type.
498    */
499   static void PrintDataTypeContent(AliHLTComponentDataType& dt, const char* format=NULL);
500
501   /**
502    * helper function to initialize AliHLTComponentEventData structure
503    */
504   static void FillEventData(AliHLTComponentEventData& evtData);
505
506   /**
507    * Print info on an AliHLTComponentDataType structure
508    * This is just a helper function to examine an @ref AliHLTComponentDataType
509    * structur.
510    */
511   static void PrintComponentDataTypeInfo(const AliHLTComponentDataType& dt);
512
513   /**
514    * Fill AliHLTComponentBlockData structure with default values.
515    * @param blockData   reference to data structure
516    */
517   static void FillBlockData( AliHLTComponentBlockData& blockData );
518
519   /**
520    * Fill AliHLTComponentShmData structure with default values.
521    * @param shmData   reference to data structure
522    */
523   static void FillShmData( AliHLTComponentShmData& shmData );
524
525   /**
526    * Fill AliHLTComponentDataType structure with default values.
527    * @param dataType   reference to data structure
528    */
529   static void FillDataType( AliHLTComponentDataType& dataType );
530   
531   /**
532    * Copy data type structure
533    * Copies the value an AliHLTComponentDataType structure to another one
534    * @param[out] tgtdt   target structure
535    * @param[in] srcdt   source structure
536    */
537   static void CopyDataType(AliHLTComponentDataType& tgtdt, const AliHLTComponentDataType& srcdt);
538
539   /**
540    * Set the ID and Origin of an AliHLTComponentDataType structure.
541    * The function sets the fStructureSize member and copies the strings
542    * to the ID and Origin. Only characters from the valid part of the string
543    * are copied, the rest is filled with 0's. <br>
544    * Please note that the fID and fOrigin members are not strings, just arrays of
545    * chars of size @ref kAliHLTComponentDataTypefIDsize and
546    * @ref kAliHLTComponentDataTypefOriginSize respectively and not necessarily with
547    * a terminating zero. <br>
548    * It is possible to pass NULL pointers as id or origin argument, in that case they
549    * are just ignored.
550    * @param tgtdt   target data type structure
551    * @param id      ID string
552    * @param origin  Origin string
553    */
554   static void SetDataType(AliHLTComponentDataType& tgtdt, const char* id, const char* origin);
555
556   /**
557    * Set the ID and Origin of an AliHLTComponentDataType structure.
558    * Given the fact that the data type ID is 64bit wide and origin 32, this helper
559    * function sets the data type from those two parameters.
560    * @param dt      target data type structure
561    * @param id      64bit id
562    * @param orig    32bit origin
563    */
564   static void SetDataType(AliHLTComponentDataType& dt, AliHLTUInt64_t id, AliHLTUInt32_t orig); 
565
566   /**
567    * Stopwatch type for benchmarking.
568    */
569   enum AliHLTStopwatchType {
570     /** total time for event processing */
571     kSWBase,
572     /** detector algorithm w/o interface callbacks */
573     kSWDA,
574     /** data sources */
575     kSWInput,
576     /** data sinks */
577     kSWOutput,
578     /** number of types */
579     kSWTypeCount
580   };
581
582   /**
583    * Helper class for starting and stopping a stopwatch.
584    * The guard can be used by instantiating an object in a function. The
585    * specified stopwatch is started and the previous stopwatch put on
586    * hold. When the function is terminated, the object is deleted automatically
587    * deleted, stopping the stopwatch and starting the one on hold.<br>
588    * \em IMPORTANT: never create dynamic objects from this guard as this violates
589    * the idea of a guard.
590    */
591   class AliHLTStopwatchGuard {
592   public:
593     /** standard constructor (not for use) */
594     AliHLTStopwatchGuard();
595     /** constructor */
596     AliHLTStopwatchGuard(TStopwatch* pStart);
597     /** copy constructor (not for use) */
598     AliHLTStopwatchGuard(const AliHLTStopwatchGuard&);
599     /** assignment operator (not for use) */
600     AliHLTStopwatchGuard& operator=(const AliHLTStopwatchGuard&);
601     /** destructor */
602     ~AliHLTStopwatchGuard();
603
604   private:
605     /**
606      * Hold the previous guard for the existence of this guard.
607      * Checks whether this guard controls a new stopwatch. In that case, the
608      * previous guard and its stopwatch are put on hold.
609      * @param pSucc        instance of the stopwatch of the new guard
610      * @return    1 if pSucc is a different stopwatch which should
611      *            be started<br>
612      *            0 if it controls the same stopwatch
613      */
614     int Hold(TStopwatch* pSucc);
615
616     /**
617      * Resume the previous guard.
618      * Checks whether the peceeding guard controls a different stopwatch. In that
619      * case, the its stopwatch is resumed.
620      * @param pSucc        instance of the stopwatch of the new guard
621      * @return    1 if pSucc is a different stopwatch which should
622      *            be stopped<br>
623      *            0 if it controls the same stopwatch
624      */
625     int Resume(TStopwatch* pSucc);
626
627     /** the stopwatch controlled by this guard */
628     TStopwatch* fpStopwatch;                                                //!transient
629
630     /** previous stopwatch guard, put on hold during existence of the guard */
631     AliHLTStopwatchGuard* fpPrec;                                           //!transient
632
633     /** active stopwatch guard */
634     static AliHLTStopwatchGuard* fgpCurrent;                                //!transient
635   };
636
637   /**
638    * Set a stopwatch for a given purpose.
639    * @param pSW         stopwatch object
640    * @param type        type of the stopwatch
641    */
642   int SetStopwatch(TObject* pSW, AliHLTStopwatchType type=kSWBase);
643
644   /**
645    * Init a set of stopwatches.
646    * @param pStopwatches object array of stopwatches
647    */
648   int SetStopwatches(TObjArray* pStopwatches);
649
650  protected:
651
652   /**
653    * Default method for the internal initialization.
654    * The method is called by @ref Init
655    */
656   virtual int DoInit( int argc, const char** argv );
657
658   /**
659    * Default method for the internal clean-up.
660    * The method is called by @ref Deinit
661    */
662   virtual int DoDeinit();
663
664   /**
665    * Reconfigure the component.
666    * The method is called when an event of type @ref kAliHLTDataTypeComConf
667    * {COM_CONF:PRIV} is received by the component. If the event is sent as
668    * part of a normal event, the component configuration is called first.
669    *
670    * The CDB path parameter specifies the path in the CDB, i.e. without
671    * leading absolute path of the CDB location. The framework might alse
672    * provide the id of the component in the analysis chain.
673    *
674    * \b Note: The CDB will be initialized by the framework, either already set
675    * from AliRoot or from the wrapper interface during initialization.
676    *
677    * @param cdbEntry     path of the cdbEntry
678    * @param chainId      the id of the component in the analysis chain
679    * @note both parameters can be NULL, check before usage
680    */
681   virtual int Reconfigure(const char* cdbEntry, const char* chainId);
682
683   /**
684    * Read the Preprocessor values.
685    * The function is invoked when the component is notified about available/
686    * updated data points from the detector Preprocessors. The 'modules'
687    * argument contains all detectors for which the Preprocessors have
688    * updated data points. The component has to implement the CDB access to
689    * get the desired data points.
690    * @param modules     detectors for which the Preprocessors have updated
691    *                    data points: TPC, TRD, ITS, PHOS, MUON, or ALL if
692    *                    no argument was received.
693    * @return neg. error code if failed
694    */
695   virtual int ReadPreprocessorValues(const char* modules);
696
697   /**
698    * Custom handler for the SOR event.
699    * Is invoked from the base class if an SOR event is in the block list.
700    * The handler is called before the processing function. The processing
701    * function is skipped if there are no other data blocks available.
702    *
703    * The SOR event is generated by the PubSub framework in response to
704    * the DAQ start of data (SOD - has been renamed after HLT interface
705    * was designed). The SOD event consists of 3 blocks:
706    * - ::kAliHLTDataTypeEvent block: spec ::gkAliEventTypeStartOfRun
707    * - SOD block of type ::kAliHLTDataTypeSOR, payload: AliHLTRunDesc struct
708    * - run type block ::kAliHLTDataTypeRunType, payload: run type string 
709    *
710    * Run properties can be retrieved by getters like GetRunNo().
711    * @return neg. error code if failed
712    */
713   virtual int StartOfRun();
714
715   /**
716    * Custom handler for the EOR event.
717    * Is invoked from the base class if an EOR event is in the block list.
718    * The handler is called before the processing function. The processing
719    * function is skipped if there are no other data blocks available.
720    *
721    * See StartOfRun() for mor ecomments of the sequence of steering events.
722    *
723    * @return neg. error code if failed
724    */
725   virtual int EndOfRun();
726
727   /**
728    * General memory allocation method.
729    * All memory which is going to be used 'outside' of the interface must
730    * be provided by the framework (online or offline).
731    * The method is redirected to a function provided by the current
732    * framework. Function pointers are transferred via the @ref
733    * AliHLTComponentEnvironment structure.
734    */
735   void* AllocMemory( unsigned long size );
736
737   /**
738    * Helper function to create a monolithic BlockData description block out
739    * of a list BlockData descriptors.
740    * For convenience, inside the interface vector lists are used, to make the
741    * interface pure C style, monilithic blocks must be exchanged. 
742    * The method is redirected to a function provided by the current
743    * framework. Function pointers are transferred via the @ref
744    * AliHLTComponentEnvironment structure.
745    */
746   int MakeOutputDataBlockList( const AliHLTComponentBlockDataList& blocks, AliHLTUInt32_t* blockCount,
747                                AliHLTComponentBlockData** outputBlocks );
748
749   /**
750    * Fill the EventDoneData structure.
751    * The method is redirected to a function provided by the current
752    * framework. Function pointers are transferred via the @ref
753    * AliHLTComponentEnvironment structure.
754    */
755   int GetEventDoneData( unsigned long size, AliHLTComponentEventDoneData** edd );
756
757   /**
758    * Helper function to convert the data type to a string.
759    */
760   void DataType2Text(const AliHLTComponentDataType& type, char output[kAliHLTComponentDataTypefIDsize+kAliHLTComponentDataTypefOriginSize+2]) const;
761
762   /**
763    * Get event number.
764    * @return value of the internal event counter
765    */
766   int GetEventCount() const;
767
768   /**
769    * Get the number of input blocks.
770    * @return number of input blocks
771    */
772   int GetNumberOfInputBlocks() const;
773
774   /**
775    * Get the first object of a specific data type from the input data.
776    * The hight-level methods provide functionality to transfer ROOT data
777    * structures which inherit from TObject.
778    *
779    * The method looks for the first ROOT object of type dt in the input stream.
780    * If also the class name is provided, the object is checked for the right
781    * class type. The input data block needs a certain structure, namely the 
782    * buffer size as first word. If the cross check fails, the retrieval is
783    * silently abondoned, unless the \em bForce parameter is set.<br>
784    * \b Note: THE OBJECT MUST NOT BE DELETED by the caller.
785    *
786    * If called without parameters, the function tries to create objects from
787    * all available input blocks, also the ones of data type kAliHLTVoidDataType
788    * which are not matched by kAliHLTAnyDataType.
789    *
790    * @param dt          data type of the object
791    * @param classname   class name of the object
792    * @param bForce      force the retrieval of an object, error messages
793    *                    are suppressed if \em bForce is not set
794    * @return pointer to @ref TObject, NULL if no objects of specified type
795    *         available
796    */
797   const TObject* GetFirstInputObject(const AliHLTComponentDataType& dt=kAliHLTAllDataTypes,
798                                      const char* classname=NULL,
799                                      int bForce=0);
800
801   /**
802    * Get the first object of a specific data type from the input data.
803    * The hight-level methods provide functionality to transfer ROOT data
804    * structures which inherit from TObject.
805    * The method looks for the first ROOT object of type specified by the ID and 
806    * Origin strings in the input stream.
807    * If also the class name is provided, the object is checked for the right
808    * class type. The input data block needs a certain structure, namely the 
809    * buffer size as first word. If the cross check fails, the retrieval is
810    * silently abondoned, unless the \em bForce parameter is set.<br>
811    * \em Note: THE OBJECT MUST NOT BE DELETED by the caller.
812    * @param dtID        data type ID of the object
813    * @param dtOrigin    data type origin of the object
814    * @param classname   class name of the object
815    * @param bForce      force the retrieval of an object, error messages
816    *                    are suppressed if \em bForce is not set
817    * @return pointer to @ref TObject, NULL if no objects of specified type
818    *         available
819    */
820   const TObject* GetFirstInputObject(const char* dtID, 
821                                      const char* dtOrigin,
822                                      const char* classname=NULL,
823                                      int bForce=0);
824
825   /**
826    * Get the next object of a specific data type from the input data.
827    * The hight-level methods provide functionality to transfer ROOT data
828    * structures which inherit from TObject.
829    * The method looks for the next ROOT object of type and class specified
830    * to the previous @ref GetFirstInputObject call.<br>
831    * \em Note: THE OBJECT MUST NOT BE DELETED by the caller.
832    * @param bForce      force the retrieval of an object, error messages
833    *                    are suppressed if \em bForce is not set
834    * @return pointer to @ref TObject, NULL if no more objects available
835    */
836   const TObject* GetNextInputObject(int bForce=0);
837
838   /**
839    * Get data type of an input block.
840    * Get data type of the object previously fetched via
841    * GetFirstInputObject/NextInputObject or the last one if no object
842    * specified.
843    * @param pObject     pointer to TObject
844    * @return data specification, kAliHLTVoidDataSpec if failed
845    */
846   AliHLTComponentDataType GetDataType(const TObject* pObject=NULL);
847
848   /**
849    * Get data specification of an input block.
850    * Get data specification of the object previously fetched via
851    * GetFirstInputObject/NextInputObject or the last one if no object
852    * specified.
853    * @param pObject     pointer to TObject
854    * @return data specification, kAliHLTVoidDataSpec if failed
855    */
856   AliHLTUInt32_t GetSpecification(const TObject* pObject=NULL);
857
858   /**
859    * Get the first block of a specific data type from the input data.
860    * The method looks for the first block of type dt in the input stream.
861    * It is intended to be used within the high-level interface.<br>
862    * \em Note: THE BLOCK DESCRIPTOR MUST NOT BE DELETED by the caller.
863    *
864    * If called without parameters, the function works on all input blocks,
865    * also the ones of data type kAliHLTVoidDataType which are not matched by
866    * kAliHLTAnyDataType.
867    *
868    * @param dt          data type of the block
869    * @return pointer to @ref AliHLTComponentBlockData
870    */
871   const AliHLTComponentBlockData* GetFirstInputBlock(const AliHLTComponentDataType& dt=kAliHLTAllDataTypes);
872
873   /**
874    * Get the first block of a specific data type from the input data.
875    * The method looks for the first block of type specified by the ID and 
876    * Origin strings in the input stream.  It is intended
877    * to be used within the high-level interface.<br>
878    * \em Note: THE BLOCK DESCRIPTOR MUST NOT BE DELETED by the caller.
879    * @param dtID        data type ID of the block
880    * @param dtOrigin    data type origin of the block
881    * @return pointer to @ref AliHLTComponentBlockData
882    */
883   const AliHLTComponentBlockData* GetFirstInputBlock(const char* dtID, 
884                                                       const char* dtOrigin);
885
886   /**
887    * Get input block by index.<br>
888    * \em Note: THE BLOCK DESCRIPTOR MUST NOT BE DELETED by the caller.
889    * @return pointer to AliHLTComponentBlockData, NULL if index out of range
890    */
891   const AliHLTComponentBlockData* GetInputBlock(int index);
892
893   /**
894    * Get the next block of a specific data type from the input data.
895    * The method looks for the next block  of type and class specified
896    * to the previous @ref GetFirstInputBlock call.
897    * To be used within the high-level interface.<br>
898    * \em Note: THE BLOCK DESCRIPTOR MUST NOT BE DELETED by the caller.
899    */
900   const AliHLTComponentBlockData* GetNextInputBlock();
901
902   /**
903    * Get data specification of an input block.
904    * Get data specification of the input bblock previously fetched via
905    * GetFirstInputObject/NextInputObject or the last one if no block
906    * specified.
907    * @param pBlock     pointer to input block
908    * @return data specification, kAliHLTVoidDataSpec if failed
909    */
910   AliHLTUInt32_t GetSpecification(const AliHLTComponentBlockData* pBlock=NULL);
911
912   /**
913    * Forward an input object to the output.
914    * Forward the input block of an object previously fetched via
915    * GetFirstInputObject/NextInputObject or the last one if no object
916    * specified.
917    * The block descriptor of the input block is forwarded to the
918    * output block list.
919    * @param pObject     pointer to TObject
920    * @return neg. error code if failed
921    */
922   int Forward(const TObject* pObject);
923
924   /**
925    * Forward an input block to the output.
926    * Forward the input block fetched via GetFirstInputObject/
927    * NextInputBlock or the last one if no block specified.
928    * The block descriptor of the input block is forwarded to the
929    * output block list.
930    * @param pBlock     pointer to input block
931    * @return neg. error code if failed
932    */
933   int Forward(const AliHLTComponentBlockData* pBlock=NULL);
934
935   /**
936    * Insert an object into the output.
937    * If header is specified, it will be inserted before the root object,
938    * default is no header.
939    * @param pObject     pointer to root object
940    * @param dt          data type of the object
941    * @param spec        data specification
942    * @param pHeader     pointer to header
943    * @param headerSize  size of Header
944    * @return neg. error code if failed 
945    */
946   int PushBack(TObject* pObject, const AliHLTComponentDataType& dt, 
947                AliHLTUInt32_t spec=kAliHLTVoidDataSpec, 
948                void* pHeader=NULL, int headerSize=0);
949
950   /**
951    * Insert an object into the output.
952    * If header is specified, it will be inserted before the root object,
953    * default is no header.
954    * @param pObject     pointer to root object
955    * @param dtID        data type ID of the object
956    * @param dtOrigin    data type origin of the object
957    * @param spec        data specification
958    * @param pHeader     pointer to header
959    * @param headerSize  size of Header
960    * @return neg. error code if failed 
961    */
962   int PushBack(TObject* pObject, const char* dtID, const char* dtOrigin,
963                AliHLTUInt32_t spec=kAliHLTVoidDataSpec,
964                void* pHeader=NULL, int headerSize=0);
965  
966   /**
967    * Insert an object into the output.
968    * @param pBuffer     pointer to buffer
969    * @param iSize       size of the buffer
970    * @param dt          data type of the object
971    * @param spec        data specification
972    * @param pHeader     pointer to header
973    * @param headerSize size of Header
974    * @return neg. error code if failed 
975    */
976   int PushBack(void* pBuffer, int iSize, const AliHLTComponentDataType& dt,
977                AliHLTUInt32_t spec=kAliHLTVoidDataSpec,
978                void* pHeader=NULL, int headerSize=0);
979
980   /**
981    * Insert an object into the output.
982    * @param pBuffer     pointer to buffer
983    * @param iSize       size of the buffer
984    * @param dtID        data type ID of the object
985    * @param dtOrigin    data type origin of the object
986    * @param spec        data specification
987    * @param pHeader     pointer to header
988    * @param headerSize size of Header
989    * @return neg. error code if failed 
990    */
991   int PushBack(void* pBuffer, int iSize, const char* dtID, const char* dtOrigin,
992                AliHLTUInt32_t spec=kAliHLTVoidDataSpec,
993                void* pHeader=NULL, int headerSize=0);
994
995   /**
996    * Estimate size of a TObject
997    * @param pObject
998    * @return buffer size in byte
999    */
1000   int EstimateObjectSize(TObject* pObject) const;
1001
1002   /**
1003    * Create a memory file in the output stream.
1004    * This method creates a TFile object which stores all data in
1005    * memory instead of disk. The TFile object is published as binary data.
1006    * The instance can be used like a normal TFile object. The TFile::Close
1007    * or @ref CloseMemoryFile method has to be called in order to flush the
1008    * output stream.
1009    *
1010    * \b Note: The returned object is deleted by the framework.
1011    * @param capacity    total size reserved for the memory file
1012    * @param dtID        data type ID of the file
1013    * @param dtOrigin    data type origin of the file
1014    * @param spec        data specification
1015    * @return file handle, NULL if failed 
1016    */
1017   AliHLTMemoryFile* CreateMemoryFile(int capacity, const char* dtID, const char* dtOrigin,
1018                                      AliHLTUInt32_t spec=kAliHLTVoidDataSpec);
1019
1020   /**
1021    * Create a memory file in the output stream.
1022    * This method creates a TFile object which stores all data in
1023    * memory instead of disk. The TFile object is published as binary data.
1024    * The instance can be used like a normal TFile object. The TFile::Close
1025    * or @ref CloseMemoryFile method has to be called in order to flush the
1026    * output stream.
1027    *
1028    * \b Note: The returned object is deleted by the framework.
1029    * @param capacity    total size reserved for the memory file
1030    * @param dt          data type of the file
1031    * @param spec        data specification
1032    * @return file handle, NULL if failed 
1033    */
1034   AliHLTMemoryFile* CreateMemoryFile(int capacity, 
1035                                      const AliHLTComponentDataType& dt=kAliHLTAnyDataType,
1036                                      AliHLTUInt32_t spec=kAliHLTVoidDataSpec);
1037
1038   /**
1039    * Create a memory file in the output stream.
1040    * This method creates a TFile object which stores all data in
1041    * memory instead of disk. The TFile object is published as binary data.
1042    * The instance can be used like a normal TFile object. The TFile::Close
1043    * or @ref CloseMemoryFile method has to be called in order to flush the
1044    * output stream.
1045    *
1046    * \b Note: The returned object is deleted by the framework.
1047    * @param dtID        data type ID of the file
1048    * @param dtOrigin    data type origin of the file
1049    * @param spec        data specification
1050    * @param capacity    fraction of the available output buffer size
1051    * @return file handle, NULL if failed 
1052    */
1053   AliHLTMemoryFile* CreateMemoryFile(const char* dtID, const char* dtOrigin,
1054                                      AliHLTUInt32_t spec=kAliHLTVoidDataSpec,
1055                                      float capacity=1.0);
1056
1057   /**
1058    * Create a memory file in the output stream.
1059    * This method creates a TFile object which stores all data in
1060    * memory instead of disk. The TFile object is published as binary data.
1061    * The instance can be used like a normal TFile object. The TFile::Close
1062    * or @ref CloseMemoryFile method has to be called in order to flush the
1063    * output stream.
1064    *
1065    * \b Note: The returned object is deleted by the framework.
1066    * @param dt          data type of the file
1067    * @param spec        data specification
1068    * @param capacity    fraction of the available output buffer size
1069    * @return file handle, NULL if failed 
1070    */
1071   AliHLTMemoryFile* CreateMemoryFile(const AliHLTComponentDataType& dt=kAliHLTAnyDataType,
1072                                      AliHLTUInt32_t spec=kAliHLTVoidDataSpec,
1073                                      float capacity=1.0);
1074
1075   /**
1076    * Write an object to memory file in the output stream.
1077    * @param pFile       file handle
1078    * @param pObject     pointer to root object
1079    * @param key         key in ROOT file
1080    * @param option      options, see TObject::Write
1081    * @return neg. error code if failed
1082    *         - -ENOSPC    no space left
1083    */
1084   int Write(AliHLTMemoryFile* pFile, const TObject* pObject, const char* key=NULL, int option=TObject::kOverwrite);
1085
1086   /**
1087    * Close object memory file.
1088    * @param pFile       file handle
1089    * @return neg. error code if failed
1090    *         - -ENOSPC    buffer size too small
1091    */
1092   int CloseMemoryFile(AliHLTMemoryFile* pFile);
1093
1094   /**
1095    * Insert event-done data information into the output.
1096    * @param edd          event-done data information
1097    */
1098   int CreateEventDoneData(AliHLTComponentEventDoneData edd);
1099
1100   /**
1101    * Get current run number
1102    */
1103   AliHLTUInt32_t GetRunNo() const;
1104
1105   /**
1106    * Get the current run type.
1107    */
1108   AliHLTUInt32_t GetRunType() const;
1109
1110   /**
1111    * Set a bit to 1 in a readout list ( = AliHLTEventDDL )
1112    * -> enable DDL for readout
1113    * @param list        readout list
1114    * @param ddlId       DDL Id to be turned on ( Decimal )
1115    */
1116   void EnableDDLBit(AliHLTEventDDL &list, Int_t ddlId ) const {
1117     SetDDLBit( list, ddlId, kTRUE ); 
1118   }
1119
1120   /**
1121    * Set a bit to 0 in a readout list ( = AliHLTEventDDL )
1122    * -> disable DDL for readout
1123    * @param list        readout list
1124    * @param ddlId       DDL Id to be turned on ( Decimal )
1125    */
1126   void DisableDDLBit(AliHLTEventDDL &list, Int_t ddlId ) const { 
1127     SetDDLBit( list, ddlId, kFALSE );  
1128   }
1129   
1130   /**
1131    * Set or unset  bit a readout list ( = AliHLTEventDDL )
1132    * -> enable or disable DDL for readout
1133    * @param list        readout list
1134    * @param ddlId       DDL Id to be turned on ( Decimal )
1135    * @param state       kTRUE sets it, kFALSE unsets it
1136    */
1137   void SetDDLBit(AliHLTEventDDL &list, Int_t ddlId, Bool_t state ) const;
1138   
1139   /**
1140    * Get the first word of a detector, which has a set DDL bit. 
1141    * Beware, this only works if DDLs of 1 detector are set. In the 
1142    * case of the TPC and TOF, which use 8 and 3 words, the first 
1143    * word is returned.
1144    * @param list        readout list
1145    * @return            returns the detector index, -1 if no bit is set
1146    *                    at all or several detectors (=error)
1147    */
1148   Int_t GetFirstUsedDDLWord(AliHLTEventDDL &list) const;
1149
1150   /**
1151    * Copy a struct from block data.
1152    * The function checks for block size and struct size. The least common
1153    * size will be copied to the target struct, remaining fields are initialized
1154    * to zero.<br>
1155    * The target struct must have a 32bit struct size indicator as first member.
1156    * @param pStruct     target struct
1157    * @param iStructSize size of the struct
1158    * @param iBlockNo    index of input block
1159    * @param structname  name of the struct (log messages)
1160    * @param eventname   name of the event (log messages)
1161    * @return size copied, neg. error if failed
1162    */
1163   int CopyStruct(void* pStruct, unsigned int iStructSize, unsigned int iBlockNo,
1164                  const char* structname="", const char* eventname="");
1165
1166  private:
1167   /** copy constructor prohibited */
1168   AliHLTComponent(const AliHLTComponent&);
1169   /** assignment operator prohibited */
1170   AliHLTComponent& operator=(const AliHLTComponent&);
1171
1172   /**
1173    * Increment the internal event counter.
1174    * To be used by the friend classes AliHLTProcessor, AliHLTDataSource
1175    * and AliHLTDataSink.
1176    * @return new value of the internal event counter
1177    * @internal
1178    */
1179   int IncrementEventCounter();
1180
1181   /**
1182    * Find the first input block of specified data type beginning at index.
1183    * Input blocks containing a TObject have the size of the object as an
1184    * unsigned 32 bit number in the first 4 bytes. This has to match the block
1185    * size minus 4.
1186    *
1187    * kAliHLTAllDataTypes is a special data type which includes both 
1188    * kAliHLTVoidDataType and kAliHLTAnyDataType.
1189    *
1190    * @param dt          data type
1191    * @param startIdx    index to start the search
1192    * @param bObject     check if this is an object
1193    * @return index of the block, -ENOENT if no block found
1194    *
1195    * @internal
1196    */
1197   int FindInputBlock(const AliHLTComponentDataType& dt, int startIdx=-1, int bObject=0) const;
1198
1199   /**
1200    * Get index in the array of input bocks.
1201    * Calculate index and check integrety of a block data structure pointer.
1202    * @param pBlock      pointer to block data
1203    * @return index of the block, -ENOENT if no block found
1204    *
1205    * @internal
1206    */
1207   int FindInputBlock(const AliHLTComponentBlockData* pBlock) const;
1208
1209   /**
1210    * Create an object from a specified input block.
1211    * @param idx         index of the input block
1212    * @param bForce      force the retrieval of an object, error messages
1213    *                    are suppressed if \em bForce is not set
1214    * @return pointer to TObject, caller must delete the object after use
1215    *
1216    * @internal
1217    */
1218   TObject* CreateInputObject(int idx, int bForce=0);
1219
1220   /**
1221    * Get input object
1222    * Get object from the input block list. The methods first checks whether the
1223    * object was already created. If not, it is created by @ref CreateInputObject
1224    * and inserted into the list of objects.
1225    * @param idx         index in the input block list
1226    * @param classname   name of the class, object is checked for correct class
1227    *                    name if set
1228    * @param bForce      force the retrieval of an object, error messages
1229    *                    are suppressed if \em bForce is not set
1230    * @return pointer to TObject
1231    *
1232    * @internal
1233    */
1234   TObject* GetInputObject(int idx, const char* classname=NULL, int bForce=0);
1235
1236   /**
1237    * Clean the list of input objects.
1238    * Cleanup is done at the end of each event processing.
1239    */
1240   int CleanupInputObjects();
1241
1242   /**
1243    * Insert a buffer into the output block stream.
1244    * This is the only method to insert blocks into the output stream, called
1245    * from all types of the Pushback method. The actual data might have been
1246    * written to the output buffer already. In that case NULL can be provided
1247    * as buffer, only the block descriptor will be build. If a header is specified, 
1248    * it will be inserted before the buffer, default is no header.
1249    * @param pBuffer     pointer to buffer
1250    * @param iBufferSize size of the buffer in byte
1251    * @param dt          data type
1252    * @param spec        data specification
1253    * @param pHeader     pointer to header
1254    * @param iHeaderSize size of Header
1255    * @return neg. error code if failed
1256    */
1257   int InsertOutputBlock(void* pBuffer, int iBufferSize,
1258                         const AliHLTComponentDataType& dt,
1259                         AliHLTUInt32_t spec,
1260                         void* pHeader=NULL, int iHeaderSize=0);
1261
1262   /**
1263    * Add a component statistics block to the output.
1264    */
1265   int AddComponentStatistics(AliHLTComponentBlockDataList& blocks, 
1266                              AliHLTUInt8_t* buffer,
1267                              AliHLTUInt32_t bufferSize,
1268                              AliHLTUInt32_t offset,
1269                              AliHLTComponentStatisticsList& stats) const;
1270
1271   /** The global component handler instance */
1272   static AliHLTComponentHandler* fgpComponentHandler;              //! transient
1273
1274   /** The environment where the component is running in */
1275   AliHLTComponentEnvironment fEnvironment;                         // see above
1276
1277   /** Set by ProcessEvent before the processing starts */
1278   AliHLTEventID_t fCurrentEvent;                                   // see above
1279
1280   /** internal event no */
1281   int fEventCount;                                                 // see above
1282
1283   /** the number of failed events */
1284   int fFailedEvents;                                               // see above
1285
1286   /** event data struct of the current event under processing */
1287   AliHLTComponentEventData fCurrentEventData;                      // see above
1288
1289   /** array of input data blocks of the current event */
1290   const AliHLTComponentBlockData* fpInputBlocks;                   //! transient
1291
1292   /** index of the current input block */
1293   int fCurrentInputBlock;                                          // see above
1294
1295   /** data type of the last block search */
1296   AliHLTComponentDataType fSearchDataType;                         // see above
1297
1298   /** name of the class for the object to search for */
1299   string fClassName;                                               // see above
1300
1301   /** array of generated input objects */
1302   TObjArray* fpInputObjects;                                       //! transient
1303  
1304   /** the output buffer */
1305   AliHLTUInt8_t* fpOutputBuffer;                                   //! transient
1306
1307   /** size of the output buffer */
1308   AliHLTUInt32_t fOutputBufferSize;                                // see above
1309
1310   /** size of data written to output buffer */
1311   AliHLTUInt32_t fOutputBufferFilled;                              // see above
1312
1313   /** list of ouput block data descriptors */
1314   AliHLTComponentBlockDataList fOutputBlocks;                      // see above
1315
1316   /** stopwatch array */
1317   TObjArray* fpStopwatches;                                        //! transient
1318
1319   /** array of memory files AliHLTMemoryFile */
1320   AliHLTMemoryFilePList fMemFiles;                                 //! transient
1321
1322   /** descriptor of the current run */
1323   AliHLTRunDesc* fpRunDesc;                                        //! transient
1324
1325   /** the current DDL list */
1326   AliHLTEventDDL* fpDDLList;                                       //! transient
1327
1328   /** external fct to set CDB run no, indicates external CDB initialization */
1329   void* fCDBSetRunNoFunc;                                          //! transient
1330
1331   /** id of the component in the analysis chain */
1332   string fChainId;                                                 //! transient
1333
1334   /** optional benchmarking for the component statistics */
1335   TStopwatch* fpBenchmark;                                         //! transient
1336
1337   /** component requires steering data blocks */
1338   bool fRequireSteeringBlocks;                                     //! transient
1339
1340   ClassDef(AliHLTComponent, 7)
1341 };
1342 #endif