+//-*- Mode: C++ -*-
// @(#) $Id$
#ifndef ALIHLTMODULEAGENT_H
#define ALIHLTMODULEAGENT_H
-/* Copyright(c) 1998-1999, ALICE Experiment at CERN, All rights reserved. *
+/* This file is property of and copyright by the ALICE HLT Project *
+ * ALICE Experiment at CERN, All rights reserved. *
* See cxx source for full Copyright notice */
/** @file AliHLTModuleAgent.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
+
#include <TObject.h>
#include <TList.h>
#include "AliHLTLogging.h"
#include "AliHLTConfigurationHandler.h"
class AliRunLoader;
+class AliRawReader;
/**
* @class AliHLTModuleAgent
* @brief Agent helper class for HLT sub modules, e.g. PHOS, TPC, Trigger
*
- * This class describes
+ * This class implements the agent base class for the HLT sub modules.
+ * The agent of a library gives information on the features of the library/
+ * components, like the configurations to run and other component libraries
+ * it depends on.
+ * @note There must not be more than one agent per module/library.
+ *
+ * If a run loader is available, reconstruction is performed on simulated
+ * data as part of <tt>AliSimulation</tt>, if the raw reader is present on
+ * raw data as part of <tt>AliReconstruction</tt>. The configurations
+ * can adapt to the two cases.
+ *
+ * All HLT component libraries are loaded on demand through the HLT steering
+ * instance (@ref AliHLTSystem). A library can implement an agent derived
+ * from this base class, and has to define one global object of this agent
+ * in the code. The agent will be registered automatically, and the features
+ * can be queried when required.
+ *
+ * This is usually done during running the AliRoot reconstruction (see AliRoot
+ * documentation on <tt> AliSimulation </tt> and <tt> AliReconstruction <tt>).
+ * The HLT implemets the @ref AliHLTSimulation and @ref
+ * AliHLTReconstructor which hold the HLT steering object. Several flags can
+ * be specified as options via the <tt>SetRunHLT</tt> method of
+ * <tt>AliSimulation</tt> and the <tt>SetOption</tt> method of
+ * <tt>AliReconstruction</tt>, including the component libraries to be loaded.
+ *
+ * @section alihltmoduleagent_interface Agent interface
+ * The child can implement the following functions:
+ * - @ref CreateConfigurations <br>
+ * Create HLT configuration forming an HLT analysis chain. <br>
+ * Reconstruction of raw data or simulated data from digits needs
+ * usually different configurations. If a run loader is available,
+ * reconstruction is performed on simulated data, on raw data if the
+ * raw reader is present.
*
- * There must be only one agent per module/library.
+ * - @ref GetReconstructionChains <br>
+ * Configurations run during event reconstruction. <br>
+ * Define chains to be run during the recunstruction step,
+ * Depending on the availability of AliRoot run loader or raw reader
+ * <br>
+ *
+ * - @ref GetRequiredComponentLibraries <br>
+ * can indicate further libraries which are required for running the
+ * chains (e.g. if components of another library are used).
+ *
+ * - @ref RegisterComponents <br>
+ * register componens, this can be used to avoid the component
+ * registration via global objects
+ * @see @ref alihltcomponent-handling
+ * <br>
+ * @section alihltmoduleagent_references References
+ * @see @ref AliHLTReconstructor interface to the AliRoot reconstruction
+ * @see @ref AliHLTAgentSample agent for the libAliHLTSample library
*
* @ingroup alihlt_system
*/
* global agent manager
*/
AliHLTModuleAgent();
- /** not a valid copy constructor, defined according to effective C++ style */
- AliHLTModuleAgent(const AliHLTModuleAgent&);
- /** not a valid assignment op, but defined according to effective C++ style */
- AliHLTModuleAgent& operator=(const AliHLTModuleAgent&);
/** destructor */
virtual ~AliHLTModuleAgent();
/**
* Print status info.
- * Short summary on registered agents. This function acts globally on the list
- * of agents if no specific agent is specified.
+ * Short summary on registered agents. This function acts globally on the
+ * list of agents if no specific agent is specified.
*/
static void PrintStatus(const char* agent=NULL);
* Register all configurations belonging to this module with the
* AliHLTConfigurationHandler. The agent can adapt the configurations
* to be registered to the current AliRoot setup by checking the
- * runloader.
+ * runloader and the raw reader. <br>
+ * Run loader and raw reader are usually not present at the same time.
+ * If a run loader is available, reconstruction is performed on simulated
+ * data, if the raw reader is present on raw data. The configurations
+ * can adapt to the two cases.
+ *
* @param handler [in] the configuration handler
+ * @param rawReader [in] AliRoot RawReader instance
* @param runloader [in] AliRoot runloader
* @return neg. error code if failed
*/
virtual int CreateConfigurations(AliHLTConfigurationHandler* handler,
+ AliRawReader* rawReader=NULL,
AliRunLoader* runloader=NULL) const;
/**
- * Get the top configurations belonging to this module.
+ * Get the top configurations for event reconstruction.
* A top configuration describes a processing chain. It can simply be
* described by the last configuration(s) in the chain.
* The agent can adapt the configurations to be registered to the current
- * AliRoot setup by checking the runloader.
- * @param runloader [in] AliRoot runloader
+ * AliRoot setup by checking the run loader and the raw reader.
+ * @param rawReader [in] AliRoot RawReader instance
+ * @param runloader [in] AliRoot runloader
* @return string containing the top configurations separated by blanks
*/
- virtual const char* GetTopConfigurations(AliRunLoader* runloader=NULL) const;
+ virtual const char* GetReconstructionChains(AliRawReader* rawReader=NULL,
+ AliRunLoader* runloader=NULL) const;
/**
- * Component libraries which the configurations of this agent depend on.
+ * Component libraries which the configurations of this agent depend on. <br>
+ * @note This is not the right place to specify libraries which this component
+ * library depends. Dependencies must be linked or loaded before.
* @return list of component libraries as a blank-separated string.
*/
virtual const char* GetRequiredComponentLibraries() const;
* \em Note: The sample object is owned by the agent, make sure to delete
* it.
*/
- virtual int RegisterComponents(AliRunLoader* runloader=NULL) const;
+ virtual int RegisterComponents(AliRawReader* rawReader=NULL,
+ AliRunLoader* runloader=NULL) const;
+
+ /**
+ * Old method kept for backward compatibility, redirected to @ref
+ * GetReconstructionChains.
+ */
+ const char* GetTopConfigurations(AliRunLoader* runloader=NULL) const {
+ return GetReconstructionChains(NULL,runloader);
+ }
protected:
private:
+ /** copy constructor prohibited */
+ AliHLTModuleAgent(const AliHLTModuleAgent&);
+ /** assignment operator prohibited */
+ AliHLTModuleAgent& operator=(const AliHLTModuleAgent&);
+
/**
* Register agent in the global list.
* @return neg. error code if failed
static int Unregister(AliHLTModuleAgent* pAgent);
/** the list of active agents */
- static TList fgAgentList;
+ static AliHLTModuleAgent* fAnchor; //! transient
+
+ /** next element in the list */
+ AliHLTModuleAgent* fpNext; //! transient
/** the current object link (list position) */
- static TObjLink* fgCurrentLnk;
+ static AliHLTModuleAgent* fCurrent; //! transient
+
+ /** number of agents */
+ static int fCount; //! transient
- ClassDef(AliHLTModuleAgent, 0);
+ ClassDef(AliHLTModuleAgent, 1);
};
#endif
git://git.uio.no / u / mrichter / AliRoot.git / blobdiff