minor update of documentation

[u/mrichter/AliRoot.git] / HLT / TPCLib / AliHLTTPCZeroSuppressionComponent.h

diff --git a/HLT/TPCLib/AliHLTTPCZeroSuppressionComponent.h b/HLT/TPCLib/AliHLTTPCZeroSuppressionComponent.h
index 27cd823d351f2a07b1a994ae41eb17245be0cec6..6d7790311de9ee81331d9714f4e6fd544f9dc9ca 100755 (executable)
--- a/HLT/TPCLib/AliHLTTPCZeroSuppressionComponent.h
+++ b/HLT/TPCLib/AliHLTTPCZeroSuppressionComponent.h
@@ -4,9 +4,9 @@
 #ifndef ALIHLTTPCZEROSUPPRESSIONCOMPONENT_H
 #define ALIHLTTPCZEROSUPPRESSIONCOMPONENT_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   AliHLTTPCZeroSuppressionComponent.h
     @author Kenneth Aamodt
@@ -14,12 +14,6 @@
     @brief  Component for ZeroSuppression
 */
 
-// see below for class documentation
-// or
-// refer to README to build package
-// or
-// visit http://web.ift.uib.no/~kjeks/doc/alice-hlt
-
 #include "AliHLTProcessor.h"
 #include "AliHLTTPCPad.h"
 #include "AliHLTDataTypes.h"
@@ -46,7 +40,7 @@ class AliHLTTPCDigitReader;
  *
  * - sort-pads Flag to switch on pad sorting(needed by the SORTED clusterfinder)
  *
- * @ingroup alihlt_tpc
+ * @ingroup alihlt_tpc_components
  */
 class AliHLTTPCZeroSuppressionComponent : public AliHLTProcessor
     {
@@ -59,17 +53,17 @@ class AliHLTTPCZeroSuppressionComponent : public AliHLTProcessor
        // Public functions to implement AliHLTComponent's interface.
        // These functions are required for the registration process
 
-  /** interface function, see @ref AliHLTComponent for description */
+  /** interface function, see AliHLTComponent for description */
   const char* GetComponentID();
-  /** interface function, see @ref AliHLTComponent for description */
+  /** interface function, see AliHLTComponent for description */
   void GetInputDataTypes( vector<AliHLTComponentDataType>& list);
-  /** interface function, see @ref AliHLTComponent for description */
+  /** interface function, see AliHLTComponent for description */
   AliHLTComponentDataType GetOutputDataType();
-  /** interface function, see @ref AliHLTComponent for description */
+  /** interface function, see AliHLTComponent for description */
   int GetOutputDataTypes(AliHLTComponentDataTypeList& tgtList);
-  /** interface function, see @ref AliHLTComponent for description */
+  /** interface function, see AliHLTComponent for description */
   virtual void GetOutputDataSize( unsigned long& constBase, double& inputMultiplier );
-  /** interface function, see @ref AliHLTComponent for description */
+  /** interface function, see AliHLTComponent for description */
   AliHLTComponent* Spawn();
 
       Int_t DeInitializePadArray();
@@ -82,10 +76,9 @@ class AliHLTTPCZeroSuppressionComponent : public AliHLTProcessor
 
        int DoInit( int argc, const char** argv );
        int DoDeinit();
-       int DoEvent( const AliHLTComponentEventData& evtData, const AliHLTComponentBlockData* blocks, 
+        int DoEvent( const AliHLTComponentEventData& evtData, const AliHLTComponentBlockData* blocks, 
                     AliHLTComponentTriggerData& trigData, AliHLTUInt8_t* outputPtr, 
                     AliHLTUInt32_t& size, vector<AliHLTComponentBlockData>& outputBlocks );
-       
        using AliHLTProcessor::DoEvent;
 
     private:
@@ -159,8 +152,14 @@ class AliHLTTPCZeroSuppressionComponent : public AliHLTProcessor
       /** Flag to switch on active pads selection */
       Bool_t fGetActivePads;                                           //! transient
 
+      /** Flag to switch off data being sent to output */
+      Bool_t fSkipSendingZSData;
+
+      /** Flag to switch off hw list being sent to output */
+      Bool_t fSendHWList;
+
       /** Vector of active pad hardware addresses */
-      vector<Int_t> fHwAddressList;                                    //! transient
+      vector<AliHLTUInt16_t> fHwAddressList;                  //! transient
 
       ClassDef(AliHLTTPCZeroSuppressionComponent, 0)  
     };