correcting memory leaks on error conditions

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

diff --git a/HLT/TPCLib/AliHLTTPCDigitReader.h b/HLT/TPCLib/AliHLTTPCDigitReader.h
index 948993894b6ff438df289ce3be6ca3138ed16291..7f4bc714364f5f1a237531c821fa1b2d43519c03 100644 (file)
--- a/HLT/TPCLib/AliHLTTPCDigitReader.h
+++ b/HLT/TPCLib/AliHLTTPCDigitReader.h
@@ -4,9 +4,9 @@
 #ifndef ALIHLTTPCDIGITREADER_H
 #define ALIHLTTPCDIGITREADER_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   AliHLTTPCDigitReader.h
     @author Timm Steinbeck, Jochen Thaeder, Matthias Richter, Kenneth Aamodt
@@ -16,6 +16,7 @@
 
 #include "AliHLTLogging.h"
 #include "TObject.h"
+#include "AliHLTTPCDigitData.h"
 
 /**
  * @class AliHLTTPCDigitReader
@@ -67,20 +68,66 @@ public:
    */
   virtual int InitBlock(void* ptr,unsigned long size,Int_t firstrow,Int_t lastrow, Int_t patch, Int_t slice);
 
+  /**
+   * Reset digit reader and release internal structures.
+   */
+  virtual int Reset() {return 0;}
+
+  enum {
+    kNextSignal = 1,
+    kNextChannel,
+    kNextBunch,
+    kLastValidModifier
+  };
+
   /**
    * Set the reader position to the next value.
    * If the reader was not yet initialized, initialization is carried out and
    * the position set to the beginning of the stream (which is in essence the
    * end of the data block due to the back-linked list).
    *
+   * The modifiers determine the unit of the positioning:
+   * - @ref kNextSignal    set to the next signal value
+   * - @ref kNextChannel   set at the beginning of the next channel
+   * - @ref kNextBunch     set at the beginning of the next bunch within the
+   *                       current channel.
+   *
    * If the reader is locked for a pad/channel, Next operates only on the data
    * belonging to the current channel and returns false at the end of the
    * channel.
    * 
-   * The function does some basic stuff and forwards to @ref NextSignal.
+   * The function does some basic stuff and forwards to @ref NextSignal, @ref
+   * NextBunch or @ref NextChannel depending on the modifer. This function is
+   * also necessary if the common sorting is going to be used (not yet implemented)
+   * @return true if data is available, false if not
+   */
+  bool Next(int type=kNextSignal);
+
+  /**
+   * Set stream position to the next Pad (ALTRO channel).
+   * This is the direct entry to data access on a channel/bunch basis suited
+   * for fast data access.
    * @return true if data is available, false if not
    */
-  bool Next();
+  virtual bool NextChannel();
+
+  /**
+   * Set stream to the next ALTRO bunch within the current pad.
+   * This is the direct entry to data access on a channel/bunch basis suited
+   * for fast data access.
+   * @return bunch length, 0 if no data bunch available in the current pad
+   */
+  virtual int NextBunch();
+
+  /**
+   * Get current hardware address.
+   */
+  virtual AliHLTUInt32_t GetAltroBlockHWaddr() const;
+
+  /**
+   * Get current hardware address from row and pad number.
+   */
+  virtual AliHLTUInt32_t GetAltroBlockHWaddr(Int_t row, Int_t pad) const;
 
   /**
    * Get the row number of the current value.
@@ -97,8 +144,20 @@ public:
    */
   virtual int GetSignal()=0;
 
+  /**
+   * Get pointer to the the current ADC value.
+   */
+  virtual const UInt_t* GetSignals();
+
+  /**
+   * Get pointer to the the current ADC value. In UShort_t, used by the 32BitFormat decoder
+   */
+  virtual const UShort_t* GetSignalsShort();
+
   /**
    * Get the time bin of the current value.
+   * If @ref NextBunch has been used the function returns the
+   * first time bin of the bunch.
    */
   virtual int GetTime()=0;
 
@@ -130,6 +189,32 @@ public:
    */
   int RewindChannel();
 
+  /**
+   * Returns the bunch size. Used by the fast decoder. 
+   */
+  virtual int GetBunchSize();
+
+  /**
+   * Returns the row offset. Used by the fast decoder. 
+   */  
+  virtual int GetRowOffset() const;
+
+  /**
+   * Returns the trailer size.
+   */
+  virtual int GetRCUTrailerSize();
+
+  /**
+   * Returns the trailer data.
+   */
+  virtual bool GetRCUTrailerData(UChar_t*& trData);
+
+  /**
+   * Returns the digits
+   */
+  virtual const AliHLTTPCDigitData* GetBunchDigits(){return 0;}
+
+
   /**
    * Access operator to the data of a specific time bin.
    * Not clear if we can manage this.
@@ -158,6 +243,10 @@ public:
     kChannelOverwrap = 0x2,
     /** reader doe not allow channel rewind */
     kNoRewind = 0x4,
+    /** warning missing fast access methods */
+    kWarnMissFastAccess = 0x8,
+    /** warning on missing RCU trailer getters */
+    kWarnMissTrailerGetters = 0x10,
     /** channel caching enabled */
     kChannelCaching = 0x100
   };
@@ -165,6 +254,7 @@ protected:
   /**
    * Set the reader position to the next value.
    * This is the reader specific method called by @ref Next.
+   * @return true if data is available, false if not
    */
   virtual bool NextSignal()=0;
 
@@ -183,7 +273,7 @@ protected:
   /**
    * Check a status flag of the reader.
    */
-  inline int CheckFlag(unsigned int flag) {return (fFlags&flag)!=0;}
+  int CheckFlag(unsigned int flag) const {return (fFlags&flag)!=0;}
 
   /**
    * Rewind to the beginning.of the current channel.
@@ -196,6 +286,12 @@ protected:
   virtual int RewindToPrevChannel();
 
 private:
+  /**
+   * Print a warning once for missing functionality.
+   * Set corresponding flag to avoid repetitive warnings.
+   */
+  void PrintWarningOnce(int type, const char* message);
+
   /** pad/channel is locked */
   unsigned int fFlags;                                    //!transient