updated

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

diff --git a/HLT/BASE/AliHLTCalibrationProcessor.h b/HLT/BASE/AliHLTCalibrationProcessor.h
index 5987012dc3b42f9ee332b58f2880176942fc3ec5..960e968418be9ca12352f81f8181a604498d1fad 100644 (file)
--- a/HLT/BASE/AliHLTCalibrationProcessor.h
+++ b/HLT/BASE/AliHLTCalibrationProcessor.h
@@ -1,4 +1,5 @@
 //-*- Mode: C++ -*-
+// $Id$
 #ifndef ALIHLTCALIBRATIONPROCESSOR_H
 #define ALIHLTCALIBRATIONPROCESSOR_H
 /* This file is property of and copyright by the ALICE HLT Project        * 
@@ -19,6 +20,8 @@
 #include "AliHLTMessage.h"
 #include "AliHLTDataTypes.h"
 
+class AliHLTReadoutList;
+
 /**
  * @class AliHLTCalibrationProcessor
  * Base class of HLT calibration components.
@@ -59,13 +62,13 @@ class AliHLTCalibrationProcessor : public AliHLTProcessor {
    * @param pObject     pointer to root object
    * @param pDetector   4 byte Detector identifier
    * @param pFileID     name of the file to which the data shall be stored
-   * @param pDDLList    pointer to ReadoutList ( struct @ref AliHLTEventDDL) of
+   * @param pDDLList    pointer to ReadoutList ( class @ref AliHLTReadoutList) of
    *                    participating DDLs. Have to be set or unset with @ref
    *                    AliHLTComponent::EnableDDLBit() and @ref AliHLTComponent::DisableDDLBit(). 
    *                   Will be filled automatically if not supplied by the component.
    * @return neg. error code if failed 
    */
-  Int_t PushToFXS(TObject* pObject, const char* pDetector, const char* pFileID, AliHLTEventDDL* pDDLList);
+  Int_t PushToFXS(TObject* pObject, const char* pDetector, const char* pFileID, const AliHLTReadoutList* pDDLList);
 
   /**
    * Insert an object into the output. FXS header will be inserted before the root object.
@@ -73,13 +76,13 @@ class AliHLTCalibrationProcessor : public AliHLTProcessor {
    * @param iSize       size of the buffer
    * @param pDetector   4 byte Detector identifier
    * @param pFileID     name of the file to which the data shall be stored
-   * @param pDDLList    pointer to ReadoutList ( struct @ref AliHLTEventDDL) of
+   * @param pDDLList    pointer to ReadoutList ( class @ref AliHLTReadoutList) of
    *                    participating DDLs. Have to be set or unset with @ref
    *                    AliHLTComponent::EnableDDLBit() and @ref AliHLTComponent::DisableDDLBit().
    *                   Will be filled automatically if not supplied by the component.
    * @return neg. error code if failed 
    */
-   Int_t PushToFXS(void* pBuffer, int iSize, const char* pDetector, const char* pFileID, AliHLTEventDDL* pDDLList);
+   Int_t PushToFXS(void* pBuffer, int iSize, const char* pDetector, const char* pFileID, const AliHLTReadoutList* pDDLList);
 
   /** Constants  */ 
   static const AliHLTUInt32_t fgkFXSProtocolHeaderSize;
@@ -93,13 +96,13 @@ class AliHLTCalibrationProcessor : public AliHLTProcessor {
    * The low-level data processing method for the component,
    * called for every data event. This is the custom processing 
    * method and can be overloaded by the component.
-   * @param evtData       event data structure
-   * @param blocks        input data block descriptors
-   * @param trigData     trigger data structure
-   * @param outputPtr    pointer to target buffer
-   * @param size         <i>input</i>: size of target buffer
+   * @param [in] evtData       event data structure
+   * @param [in] blocks        input data block descriptors
+   * @param [in] trigData        trigger data structure
+   * @param [in] outputPtr       pointer to target buffer
+   * @param [in,out] size        <i>input</i>: size of target buffer
    *                     <i>output</i>:size of produced data
-   * @param outputBlocks  list to receive output block descriptors
+   * @param [in] outputBlocks  list to receive output block descriptors
    * @return neg. error code if failed
    */
   virtual Int_t ProcessCalibration(const AliHLTComponent_EventData& evtData,
@@ -128,13 +131,13 @@ class AliHLTCalibrationProcessor : public AliHLTProcessor {
    * The low-level data processing method for the component,
    * called for the END_OF_RUN event. This is the custom processing 
    * method and can be overloaded by the component.
-   * @param evtData       event data structure
-   * @param blocks        input data block descriptors
-   * @param trigData     trigger data structure
-   * @param outputPtr    pointer to target buffer
-   * @param size         <i>input</i>: size of target buffer
+   * @param [in] evtData       event data structure
+   * @param [in] blocks        input data block descriptors
+   * @param [in] trigData        trigger data structure
+   * @param [in] outputPtr       pointer to target buffer
+   * @param [in,out] size        <i>input</i>: size of target buffer
    *                     <i>output</i>:size of produced data
-   * @param outputBlocks  list to receive output block descriptors
+   * @param [in] outputBlocks  list to receive output block descriptors
    * @return neg. error code if failed
    */
   virtual Int_t ShipDataToFXS(const AliHLTComponent_EventData& evtData,
@@ -215,13 +218,13 @@ class AliHLTCalibrationProcessor : public AliHLTProcessor {
    * according to the event type - END_OF_RUN / DATA / CALIBRATION
    * If commandline paramater  "-eventmodulo x"is given and x > 0, data will 
    * be also shipped to the FXS with this modulo.
-   * @param evtData       event data structure
-   * @param blocks        input data block descriptors
-   * @param trigData     trigger data structure
-   * @param outputPtr    pointer to target buffer
-   * @param size         <i>input</i>: size of target buffer
+   * @param [in] evtData       event data structure
+   * @param [in] blocks        input data block descriptors
+   * @param [in] trigData        trigger data structure
+   * @param [in] outputPtr       pointer to target buffer
+   * @param [in,out] size        <i>input</i>: size of target buffer
    *                     <i>output</i>:size of produced data
-   * @param outputBlocks  list to receive output block descriptors
+   * @param [in] outputBlocks  list to receive output block descriptors
    * @return neg. error code if failed
    */
   Int_t DoEvent( const AliHLTComponentEventData& evtData,
@@ -242,12 +245,12 @@ class AliHLTCalibrationProcessor : public AliHLTProcessor {
    * @param pHeader     pointer to AliHLTFXSHeader
    * @param pDetector   4 byte Detector identifier
    * @param pFileID     name of the file to which the data shall be stored
-   * @param pDDLList    pointer to ReadoutList ( struct @ref AliHLTEventDDL) of
+   * @param pDDLList    pointer to ReadoutList ( class @ref AliHLTReadoutList) of
    *                    participating DDLs. Will be filled automatically if not 
    *                    supplied by the component.
    * @return neg. error code if failed 
    */
-  Int_t CreateFXSHeader( AliHLTFXSHeader &pHeader, const char* pDetector, const char* pFileID, AliHLTEventDDL* pDDLList );
+  Int_t CreateFXSHeader( AliHLTFXSHeader &pHeader, const char* pDetector, const char* pFileID, const AliHLTReadoutList* pDDLList );
 
   /*
    * ######################## Members #####################