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