Getting rid of warning.

[u/mrichter/AliRoot.git] / HLT / BASE / AliHLTConfiguration.h

diff --git a/HLT/BASE/AliHLTConfiguration.h b/HLT/BASE/AliHLTConfiguration.h
index 6bf284b48d2508f04ea96d56be1eff71073815c5..bf9055b0e7a1a5f411fe9a52ad5696cb7f740dd5 100644 (file)
--- a/HLT/BASE/AliHLTConfiguration.h
+++ b/HLT/BASE/AliHLTConfiguration.h
@@ -1,18 +1,17 @@
 //-*- Mode: C++ -*-
-// @(#) $Id$
+// $Id$
 
 #ifndef ALIHLTCONFIGURATION_H
 #define ALIHLTCONFIGURATION_H
-/* 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                               */
+//* 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   AliHLTConfiguration.h
-    @author Matthias Richter
-    @date   
-    @brief  Base class and handling of HLT configurations.
-    @note   The class is used in Offline (AliRoot) context
-*/
+//  @file   AliHLTConfiguration.h
+//  @author Matthias Richter
+//  @date   
+//  @brief  HLT configuration description for a single component.
+//  @note   The class is used in Offline (AliRoot) context
 
 // see below for class documentation
 // or
@@ -33,23 +32,39 @@ class AliHLTConfigurationHandler;
  * @class AliHLTConfiguration
  * @brief Description of HLT processing chains.
  *
- * This class describes a certain configuration af an HLT processing step
- * by the following parameters:
- * - a unique id string/name
- * - the id of the component
- * - the ids of the configurations it requires input from
- * - the arguments, which are passed to the component when it is initialized
+ * This class describes a configuration for an HLT component by means of
+ * the following parameters:
+ * - configuration id:      a unique id string/name
+ * - component id:          id returned by AliHLTComponent::GetComponentID()
+ * - parent configuartions: ids of configurations it requires input from
+ * - component arguments:   passed to the component when it is initialized
  *
- * The setup of a configuration requires simply the creation of a global object
- * of @ref AliHLTConfiguration. The Configuration is automatically registered
- * in the list of available configurations maintained by the @ref
- * AliHLTConfigurationHandler. The list is used by to resolve the dependencies
- * on other configurations. Hierarchies can be built up in an easy way.
+ * The definition of a configuration requires simply the creation of an object
+ * of type @ref AliHLTConfiguration. 
+ * <pre>
+ * AliHLTConfiguration myprocessor("MyProcessor", "Dummy", "publisher", "-output_percentage 80")
+ * </pre>
  *
- * A configuration is interpreted by the @ref AliHLTConfigurationHandler and
- * transformed into a Task List.
+ * The Configuration is automatically registered in the list of available
+ * configurations maintained by the @ref AliHLTConfigurationHandler.
+ * The list is used to resolve the dependencies on other configurations.
+ * Hierarchies can be built up by specifying the configuration id of parent
+ * configurations as input in the .
+ * A configuration entry is persistent and must be explicitly removed from
+ * the AliHLTConfigurationHandler if desired.
  *
- * @note This class is only used for the @ref alihlt_system.
+ * The registration mechanism requires the HLT system to be available. The
+ * global instance of AliHLTSystem is created and retrieved by
+ * <pre>
+ * // setup the HLT system
+ * AliHLTSystem* pHLT=AliHLTPluginBase::GetInstance();
+ * </pre>
+ *
+ * A configuration is transformed into a list of AliHLTTask objects by the
+ * function AliHLTSystem::BuildTaskList().
+ *
+ * This class is only used in the HLT offline environment, see @ref alihlt_system
+ * for more details.
  *
  * @ingroup alihlt_system
  */
@@ -113,6 +128,16 @@ class AliHLTConfiguration : public TObject, public AliHLTLogging {
    */
   const char* GetComponentID() const {return fComponent;}
 
+  /**
+   * Return the source string.
+   */
+  const char* GetSourceSettings() const {return fStringSources;}
+
+  /**
+   * Return the argument string.
+   */
+  const char* GetArgumentSettings() const {return fArguments;}
+
   /**
    * Print status info.
    * Short summary on id, component, sources and unresolved sources.
@@ -178,13 +203,33 @@ class AliHLTConfiguration : public TObject, public AliHLTLogging {
    * @param pArgv   pointer to receive argument array pointer
    * @return argc if succeeded, neg. error code if failed
    */
-  int GetArguments(const char*** pArgv);
+  int GetArguments(const char*** pArgv) const;
 
   /**
    * Get output buffer size.
    * @return size in byte or -1 if not specified
    */
   int GetOutputBufferSize() const {return fBufferSize;}
+
+  /**
+   * Two configurations are considered equal if all properties match
+   */
+  bool operator==(const AliHLTConfiguration& c) const {
+    return (fID==c.fID) && (fComponent==c.fComponent) && (fStringSources==c.fStringSources) && (fArguments==c.fArguments);
+  }
+  bool operator!=(const AliHLTConfiguration& c) const {
+    return !(*this==c);
+  }
+
+  /**
+   * Helper function to build a vector from an argument string.
+   * The function allocates memory for each token. The caller is responsible
+   * for cleaning the strings recursively.
+   * @param arg       pointer to argument string
+   * @param argList   target to receive the argument list
+   */
+  static int InterpreteString(const char* arg, vector<char*>& argList);
+
  protected:
   
 
@@ -197,13 +242,6 @@ class AliHLTConfiguration : public TObject, public AliHLTLogging {
    */
   int ExtractArguments();
 
-  /**
-   * Helper function to build a vector from an argument string
-   * @param arg       pointer to argument string
-   * @param argList   target to receive the argument list
-   */
-  int InterpreteString(const char* arg, vector<char*>& argList) const;
-
   /**
    * Convert buffer size string to number
    */