- support for event by event reconstruction added to AliHLTSystem
[u/mrichter/AliRoot.git] / HLT / SampleLib / AliHLTAgentSample.h
index 6c4879d..f3310e0 100644 (file)
@@ -30,7 +30,7 @@
  *   ...
  *   handler->CreateConfiguration("my-analysis-chain"  , "FileWriter", "my-processor" , "my arguments");
  *   </pre>
- * - @ref GetLocalRecConfigurations <br>
+ * - @ref GetReconstructionChains <br>
  *   returns a string of blank separated configurations to be run during
  *   local event reconstruction.
  *   <pre>
@@ -38,7 +38,8 @@
  *   </pre>
  * - @ref GetRequiredComponentLibraries <br>
  *   returns a string of blank separated libraries which have to be loaded
- *   in addition
+ *   in addition in order to load all required components. <br>
+ *   @note Not the right place for library dependencies.
  *   <pre>
  *   return "libAliHLTUtil.so";
  *   </pre>
@@ -66,11 +67,13 @@ class AliHLTAgentSample : public AliHLTModuleAgent {
    * AliHLTConfigurationHandler. The agent can adapt the configurations
    * to be registered to the current AliRoot setup by checking the
    * runloader.
-   * @param handler      the configuration handler
-   * @param runloader    AliRoot runloader
+   * @param handler   [in] the configuration handler
+   * @param rawReader [in] AliRoot RawReader instance 
+   * @param runloader [in] AliRoot runloader
    * @return neg. error code if failed
    */
   int CreateConfigurations(AliHLTConfigurationHandler* handler,
+                          AliRawReader* rawReader=NULL,
                           AliRunLoader* runloader=NULL) const;
 
   /**
@@ -79,10 +82,12 @@ class AliHLTAgentSample : public AliHLTModuleAgent {
    * 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
+   * @param rawReader [in] AliRoot RawReader instance 
+   * @param runloader [in] AliRoot runloader
    * @return string containing the top configurations separated by blanks
    */
-  const char* GetLocalRecConfigurations(AliRunLoader* runloader=NULL) const;
+  const char* GetReconstructionChains(AliRawReader* rawReader=NULL,
+                                     AliRunLoader* runloader=NULL) const;
 
   /**
    * Component libraries which the configurations of this agent depend on.