adding pointer protection

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

diff --git a/HLT/TPCLib/AliHLTTPCDigitDumpComponent.h b/HLT/TPCLib/AliHLTTPCDigitDumpComponent.h
index 1700425001fe10267dcbddbf0639aefeaf59903c..15ae45f80f3a66b66ca889218dc38e845659ad51 100644 (file)
--- a/HLT/TPCLib/AliHLTTPCDigitDumpComponent.h
+++ b/HLT/TPCLib/AliHLTTPCDigitDumpComponent.h
@@ -3,9 +3,9 @@
 
 #ifndef ALIHLTTPCDIGITDUMPCOMPONENT_H
 #define ALIHLTTPCDIGITDUMPCOMPONENT_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   AliHLTTPCDigitDumpComponent.h
     @author Matthias Richter
@@ -13,29 +13,44 @@
     @brief  Special file writer converting TPC digit input to ASCII.
 */
 
-// see below for class documentation
-// or
-// refer to README to build package
-// or
-// visit http://web.ift.uib.no/~kjeks/doc/alice-hlt   
-
 #include "AliHLTFileWriter.h"
 
+class AliHLTTPCDigitReader;
+
 /**
  * @class AliHLTTPCDigitDumpComponent
  * A converter for digit data of the TPC input to ASCII output.
- * Data is written to file.
+ * Data blocks of type ::kAliHLTDataTypeDDLRaw and origin 'TPC ' is docoded
+ * written in readable ASCII format to a file.
  * 
+ * The component supports different types of readers in order to
+ * choose different data formats (raw/digits) and reading modes.
+ *
  * Component ID: \b TPCDigitDump <br>
  * Library: \b libAliHLTTPC
  *
  * See AliHLTFileWriter for arguments, further specific options
  * Mandatory arguments: <br>
- * <!-- NOTE: ignore the \li. <i> and </i>: it's just doxygen formating -->
+ * <!-- NOTE: ignore the \li. <i> and </i>: it's just doxygen formatting -->
  *
  * Optional arguments: <br>
- * <!-- NOTE: ignore the \li. <i> and </i>: it's just doxygen formating -->
+ * <!-- NOTE: ignore the \li. <i> and </i>: it's just doxygen formatting -->
+ * \li -digitreader    <i> reader   </i> <br>
+ *      type of the digit reader: <i>unpacked, packed, raw, decoder</i>
+ *      default 'decoder' 
+ * \li -rcutrailersize    <i> size   </i> <br>
+ *      size of the RCU trailer in 32bit words (default 2), if digitreader
+ *      'decoder' is used, the trailer size is determined automatically
+ * \li -unsorted <br>
+ *      unsorted mode of digit readers (default mode)
+ * \li -sorted <br>
+ *      sorted mode of digit readers (default is unsorted)
+ * \li -bulk <br>
+ *      bulk read mode: NextChannel/Bunch
+ * \li -stream <br>
+ *      stream read mode: Next
  *
+ * @ingroup alihlt_tpc_components
  */
 class AliHLTTPCDigitDumpComponent : public AliHLTFileWriter {
  public:
@@ -66,8 +81,41 @@ class AliHLTTPCDigitDumpComponent : public AliHLTFileWriter {
   /** assignment operator prohibited */
   AliHLTTPCDigitDumpComponent& operator=(const AliHLTTPCDigitDumpComponent&);
 
-  /** the mode for the DigitReaderRaw */
-  unsigned fRawreaderMode; //!transient
+  /**
+   * Print slice/partition/row/pad header if changed.
+   */
+  int PrintHeaders(int slice, int &iPrintedSlice,
+                  int part, int &iPrintedPart,
+                  AliHLTTPCDigitReader* pReader,
+                  int &iPrintedRow, int &iPrintedPad,
+                  ofstream &dump) const;
+
+  enum {
+    kDigitReaderInvalid,
+    kDigitReaderUnpacked,
+    kDigitReaderPacked,
+    kDigitReaderRaw, // deprecated but kept for backward compatiobility of macros
+    kDigitReaderDecoder,
+    kDigitReader32Bit
+  };
+
+  /** the digit reader to use */
+  short fDigitReaderType; //!transient
+
+  /** size of the RCU trailer in 32bit words */
+  short fRcuTrailerSize; //! transient
+
+  /** unsorted/sorted mode of digit readers */
+  bool fUnsorted; //!transient
+
+  /** bulk read mode */
+  bool fbBulkMode; //!transient
+
+  /** the digit reader */
+  AliHLTTPCDigitReader* fpReader; //!transient
+
+  /** flag if 32 bit format is used */
+  Bool_t f32BitFormat;
 
   ClassDef(AliHLTTPCDigitDumpComponent, 0);
 };