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