]> git.uio.no Git - u/mrichter/AliRoot.git/blobdiff - HLT/BASE/AliHLTSystem.h
reintroduced TPC CA tracker component
[u/mrichter/AliRoot.git] / HLT / BASE / AliHLTSystem.h
index 6478ef29a26fc0f0461880b7e830e71107cad4fe..530da6074e6e6263a6681ba362c71119de40d987 100644 (file)
@@ -26,6 +26,7 @@
 
 #include "AliHLTLogging.h"
 #include <TList.h>
+#include <TString.h>
 
 class AliHLTComponentHandler;
 class AliHLTConfiguration;
@@ -33,7 +34,7 @@ class AliHLTConfigurationHandler;
 class AliHLTTask;
 class AliRunLoader;
 class AliRawReader;
-class AliESD;
+class AliESDEvent;
 class TObjArray;
 class TStopwatch;
 
@@ -51,10 +52,6 @@ class AliHLTSystem : public AliHLTLogging {
  public:
   /** default constructor */
   AliHLTSystem();
-  /** not a valid copy constructor, defined according to effective C++ style */
-  AliHLTSystem(const AliHLTSystem&);
-  /** not a valid assignment op, but defined according to effective C++ style */
-  AliHLTSystem& operator=(const AliHLTSystem&);
   /** destructor */
   virtual ~AliHLTSystem();
 
@@ -139,12 +136,16 @@ class AliHLTSystem : public AliHLTLogging {
    * Run the task list.
    * The method checks whether the task list has already been build. If not,
    * or the configuration list has been changed, the @ref BuildTaskList
-   * method is scalled
+   * method is called.                                                    <br>
    * All tasks of the list will be subsequently processed for each event.
+   * The system can remain started if the \em bStop parameter is 0. In that
+   * case the system just waits for the next event. A specific call with
+   * nofEvents==0 is needed to execute the stop sequence.
    * @param iNofEvents number of events
+   * @param bStop      stop the chain after processing
    * @return number of reconstructed events, neg error code if failed
    */
-  int Run(Int_t iNofEvents=1);
+  int Run(Int_t iNofEvents=1, int bStop=1);
 
   /**
    * Init all tasks from the list.
@@ -162,6 +163,15 @@ class AliHLTSystem : public AliHLTLogging {
    */
   int InitBenchmarking(TObjArray* pStopwatches);
 
+  /**
+   * Print benchmarking summary.
+   * Optionak: clean up stop watches.
+   * @param pStopwatches    object array of stopwatches
+   * @param bClean          delete stop watches if 1
+   * @return neg error code if failed
+   */
+  int PrintBenchmarking(TObjArray* pStopwatches, int bClean=0);
+
   /**
    * Start task list.
    * The @ref AliHLTTask::StartRun method is called for each task, the
@@ -185,6 +195,14 @@ class AliHLTSystem : public AliHLTLogging {
    */
   int StopTasks();
 
+  /**
+   * Send a control event trough the chain.
+   * All data sources in the chain are switched to publish a control event like
+   * SOR or EOR. The event is propagated in the same way as a normal event.
+   * @param dt       type of the event
+   */
+  int SendControlEvent(AliHLTComponentDataType dt);
+
   /**
    * De-init all tasks from the list.
    * The @ref AliHLTTask::Deinit method is called for each task, the components
@@ -200,13 +218,23 @@ class AliHLTSystem : public AliHLTLogging {
   static void* AllocMemory( void* param, unsigned long size );
 
   /**
-   * Reconstruction inside AliRoot.
-   * To be called by the AliHLTReconstructor plugin during the
-   * LocalReconstruction step of the AliRoot reconstruction. The latter means
-   * that all events are reconstructed at once, the event loop is internally
-   * implemented. In contrast to that, the FillESD method is called event by
-   * event. This requires an 'ESD' recorder at the end of the HLT chain, in
-   * order to have the reconstructed events available for the FillESD loop.
+   * AliRoot embedded reconstruction.
+   * Main entry point to execute the HLT reconstruction from AliRoot. Called
+   * either by the AliHLTReconstructor plugin during AliRoot reconstruction
+   * of raw data, or AliHLTSimulation during simulation of data.
+   *
+   * The two cases are distinguished by the availablility of the run loader
+   * and raw reader.
+   * - AliRoot simulation: run loader is available and is propagated to the
+   *   module agents (AliHLTModuleAgent) to generate the corresponding
+   *   configurations and chains, and to the AliHLTOfflineSource components.
+   * - AliRoot reconstruction: raw reader is available and is propagated to
+   *   the agents and AliHLTOfflineSource components.
+   *
+   * The system remains started after the processing and just waits for the
+   * next event. A specific call with nofEvents==0 is needed to execute the
+   * stop sequence.
+   *
    * The 'runLoader' and 'rawReader' parameters are set to all active
    * AliHLTOfflineDataSource's and the HLT chain is processed for the given
    * number of events. If the rawReader is NULL, reconstruction is done on
@@ -230,10 +258,10 @@ class AliHLTSystem : public AliHLTLogging {
    *                      processing counter and is not related to the nature/
    *                      origin of the event
    * @param runLoader     the AliRoot runloader
-   * @param esd           an AliESD instance
+   * @param esd           an AliESDEvent instance
    * @return neg. error code if failed 
    */
-  int FillESD(int eventNo, AliRunLoader* runLoader, AliESD* esd);
+  int FillESD(int eventNo, AliRunLoader* runLoader, AliESDEvent* esd);
 
   /**
    * Load component libraries.
@@ -254,11 +282,44 @@ class AliHLTSystem : public AliHLTLogging {
    * Prepare the HLT system for running.
    * - module agents are requested to register configurations
    * - task lists are built from the top configurations of the modules
+   *
+   * @param rawReader    instance of the raw reader or NULL
+   * @param runloader    optional instance of the run loader
+   * @return neg. error code if failed <br>
+   *         -EBUSY      system is in kRunning state <br>
+   */
+  int Configure(AliRawReader* rawReader, AliRunLoader* runloader=NULL);
+
+  /**
+   * Old method kept for backward compatibilty.
+   *
+   * @param runloader    optional instance of the run loader
    * @return neg. error code if failed <br>
    *         -EBUSY      system is in kRunning state <br>
    */
   int Configure(AliRunLoader* runloader=NULL);
 
+  /**
+   * Scan options.
+   * Known options
+   * <!-- NOTE: ignore the \li. <i> and </i>: it's just doxygen formating -->
+   * \li loglevel=<i>level</i> <br>
+   *     logging level for this processing
+   * \li frameworklog=<i>level</i> <br>
+   *     logging level for framework classes
+   * \li alilog=off
+   *     disable redirection of log messages to AliLog class
+   * \li config=<i>macro</i>
+   *     configuration macro
+   * \li chains=<i>configuration</i>
+   *     comma separated list of configurations to be run during local
+   *     reconstruction
+   * \li libmode=<i>static,dynamic(default)</i>
+   *     libraries are persistent if loaded in mode <i>static</i>, i.e. they
+   *     can't be unloaded
+   */
+  int ScanOptions(const char* options);
+
   /**
    * Reset the HLT system.
    * Reset is not possible while the system is in running state.
@@ -272,42 +333,61 @@ class AliHLTSystem : public AliHLTLogging {
    * Load the configurations specified by the module agents.
    * The runLoader is passed to the agent and allows configuration
    * selection.
+   * @param rawReader    instance of the raw reader or NULL
+   * @param runloader    optional instance of the run loader
    * @return neg. error code if failed 
    */
-  int LoadConfigurations(AliRunLoader* runloader=NULL);
+  int LoadConfigurations(AliRawReader* rawReader, AliRunLoader* runloader=NULL);
 
   /**
    * Get the top configurations of all agents and build the task lists.
+   * @param rawReader    instance of the raw reader or NULL
+   * @param runloader    optional instance of the run loader
    * @return neg. error code if failed 
    */
-  int BuildTaskListsFromTopConfigurations(AliRunLoader* runloader=NULL);
+  int BuildTaskListsFromReconstructionChains(AliRawReader* rawReader, 
+                                            AliRunLoader* runloader=NULL);
 
-  enum AliHLTSystemState_t {
+  enum AliHLTSystemState {
     kUninitialized       = 0x0,
     kLibrariesLoaded     = 0x1,
     kConfigurationLoaded = 0x2,
     kTaskListCreated     = 0x4,
     kReady               = 0x7,
-    kRunning             = 0x8,
+    kStarted             = 0x8,
+    kRunning             = 0x10,
     kError               = 0x1000
   };
 
   /**
    * Check status of the system.
-   * @param flag          AliHLTSystemState_t value to check for
+   * @param flag          AliHLTSystemState value to check for
    * @return 1 if set, 0 if not
    */
   int CheckStatus(int flag);
 
   /**
    * Get the current status.
-   * @return status flags of @ref AliHLTSystemState_t
+   * @return status flags of @ref AliHLTSystemState
    */
   int GetStatusFlags();
 
+  /**
+   * Set logging level for framework classes.
+   * This sets the local logging level of this instance and all subsequent
+   * framework classes to \em level.
+   * @param level     local logging level for the framework classes
+   */
+  void SetFrameworkLog(AliHLTComponentLogSeverity level);
+
  protected:
  
  private:
+  /** copy constructor prohibited */
+  AliHLTSystem(const AliHLTSystem&);
+  /** assignment operator prohibited */
+  AliHLTSystem& operator=(const AliHLTSystem&);
+
   /**
    * Set status flags.
    */
@@ -330,8 +410,22 @@ class AliHLTSystem : public AliHLTLogging {
   /** state of the object */
   int fState;                                                      // see above
 
- private:
-  ClassDef(AliHLTSystem, 2);
+  /** chains to be run during reconstruction */
+  TString fChains;                                                 //!transient
+
+  /** array of stopwatches */
+  TObjArray* fStopwatches;                                         //!transient
+
+  /** number of events processed in total */                        
+  int fEventCount;                                                 //!transient
+
+  /** number of events processed successfully */
+  int fGoodEvents;                                                 //!transient
+
+  /** array of default libraries */
+  static const char* fgkHLTDefaultLibs[];                          //!transient
+
+  ClassDef(AliHLTSystem, 5);
 };
-#endif
 
+#endif