+//-*- Mode: C++ -*-
// @(#) $Id$
#ifndef ALIHLTSYSTEM_H
@note The class is used in Offline (AliRoot) context
*/
+// see below for class documentation
+// or
+// refer to README to build package
+// or
+// visit http://web.ift.uib.no/~kjeks/doc/alice-hlt
+
/**
* @defgroup alihlt_system HLT integration into AliRoot
* This section describes the HLT integration into AliRoot.
#include "AliHLTLogging.h"
#include <TList.h>
+#include <TString.h>
class AliHLTComponentHandler;
class AliHLTConfiguration;
class AliHLTTask;
class AliRunLoader;
class AliRawReader;
-class AliESD;
+class AliESDEvent;
class TObjArray;
class TStopwatch;
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();
int DeleteConfiguration(AliHLTConfiguration* pConf);
/**
- * Build a task list from a configuration object.
+ * Build a task list
* This method is used to build the tasks from the 'master' configuration
* objects which are added to the HLT system handler. This is an iterative
* process since the task might depend upon other configurations. For each
* method will be called iteratively. Finally, after building all tasks which
* the current one depends on have been created, the task is inserted to the
* list of tasks with the InsertTask method.
+ * @param pConf configuration name/id
+ */
+ int BuildTaskList(const char* pConf);
+
+ /**
+ * Build task list from a configuration object.
+ * This method is kept for backward compatibility. Use the version
+ * with the configuration name.
* @param pConf pointer to configuration to build the task list from
*/
int BuildTaskList(AliHLTConfiguration* pConf);
* 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.
*/
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
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
* 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.
* 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 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
+ */
+ int ScanOptions(const char* options);
+
/**
* Reset the HLT system.
* Reset is not possible while the system is in running state.
* 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 BuildTaskListsFromTopConfigurations(AliRawReader* rawReader,
+ AliRunLoader* runloader=NULL);
enum AliHLTSystemState_t {
kUninitialized = 0x0,
kConfigurationLoaded = 0x2,
kTaskListCreated = 0x4,
kReady = 0x7,
- kRunning = 0x8,
+ kStarted = 0x8,
+ kRunning = 0x10,
kError = 0x1000
};
protected:
private:
+ /** copy constructor prohibited */
+ AliHLTSystem(const AliHLTSystem&);
+ /** assignment operator prohibited */
+ AliHLTSystem& operator=(const AliHLTSystem&);
+
/**
* Set status flags.
*/
*/
int ClearStatusFlags(int flags);
+
/* TList fConfList; */
/* int fbListChanged; */
/** state of the object */
int fState; // see above
+ /** 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
+
private:
- ClassDef(AliHLTSystem, 2);
+ ClassDef(AliHLTSystem, 4);
};
-#endif
+#endif
git://git.uio.no / u / mrichter / AliRoot.git / blobdiff