compilation warnings fixed (r42022)

[u/mrichter/AliRoot.git] / HLT / MUON / AliHLTMUONProcessor.h

diff --git a/HLT/MUON/AliHLTMUONProcessor.h b/HLT/MUON/AliHLTMUONProcessor.h
index 77b0a4df183612c122d63a09e2e6f7c695909c8d..3e3ca0c5b702281be3d82a626958fb81a7e9a60e 100644 (file)
--- a/HLT/MUON/AliHLTMUONProcessor.h
+++ b/HLT/MUON/AliHLTMUONProcessor.h
@@ -4,7 +4,7 @@
  * ALICE Experiment at CERN, All rights reserved.                         *
  * See cxx source for full Copyright notice                               */
 
-/* $Id: $ */
+// $Id: $
 
 ///
 /// @file   AliHLTMUONProcessor.h
@@ -26,6 +26,27 @@ class AliMUONRecoParam;
  * Some common methods useful to all dHLT specific components are implemented
  * by this class.
  *
+ * The following argument can be inherited by components derived from the
+ * AliHLTMUONProcessor class, as long as the protected methods provided are used
+ * properly and the argument evaluation is handled as indicated in DoInit.
+ * \li -cdbpath <i>path</i> <br>
+ *      This allows one to override the path to use for the CDB location.
+ *      <i>path</i> must be a valid CDB URI. By default the HLT system framework
+ *      sets the CDB path. <br>
+ * \li -run <i>number</i> <br>
+ *      This allows one to override the run number to use. <i>number</i> must be
+ *      a positive integer number. By default the HLT system framework sets the
+ *      run number. <br>
+ * \li -delaysetup <br>
+ *      If indicated then part of the initialisation of the component is forcefully
+ *      delayed to the first event received, i.e. the Start-of-Run event. <br>
+ * \li -dumponerror <br>
+ *      This flag will cause the component to dump the data blocks it received if
+ *      an error occurs during the processing of an event. <br>
+ * \li -dumppath <i>path</i> <br>
+ *      Allows one to specify the path in which to dump the received data blocks
+ *      if an error occurs. <br>
+ *
  * @ingroup alihlt_dimuon_component
  */
 class AliHLTMUONProcessor : public AliHLTProcessor
@@ -186,6 +207,15 @@ protected:
                return BlockStructureOk(block, "Manso track candidates", checkHeader);
        }
 
+       /// Checks the structure of a tracks data block.
+       bool BlockStructureOk(
+                       const AliHLTMUONTracksBlockReader& block,
+                       bool checkHeader = true
+               ) const
+       {
+               return BlockStructureOk(block, "tracks", checkHeader);
+       }
+
        /// Checks the structure of a single track trigger decision data block.
        bool BlockStructureOk(
                        const AliHLTMUONSinglesDecisionBlockReader& block,
@@ -208,7 +238,7 @@ protected:
         * Sets the CDB path and run number to read from.
         * \param cdbPath  The CDB path to use. If set to NULL and the path has
         *      not been set in the CDB manager then the default path
-        *      "local://$ALICE_ROOT" is used if the 'useDefault' flag is also true.
+        *      "local://$ALICE_ROOT/OCDB" is used if the 'useDefault' flag is also true.
         * \param run  The run number to use. If set to -1 and the run number has
         *      not been set in the CDB manager then a value of zero is used if
         *      the 'useDefault' flag is also true.
@@ -329,6 +359,17 @@ protected:
                        const char* pathToEntry = NULL, const char* prettyName = NULL
                ) const;
        
+       /**
+        * Loads the appropriate field integral from the CDB based on the currently
+        * loaded global magnetic field in TGeoGlobalMagField. If the global field is
+        * not loaded then we try load the GRP entry to figure out the correct integral.
+        * [out] \param bfieldintegral  Will be filled with the dipole magnetic field
+        *       integral value to use.
+        * \return Zero if the field integral could be found and is valid. Otherwise an
+        *       error code is returned, which is compatible with the HLT framework.
+        */
+       int FetchFieldIntegral(Double_t& bfieldintegral) const;
+       
        /**
         * Fetches the reconstruction parameters object from the CDB for MUON.
         * [out] \param params  This will be filled with the reconstruction