Changes needed for new HLT output DDLs.

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

diff --git a/HLT/BASE/AliHLTOUTHomerBuffer.h b/HLT/BASE/AliHLTOUTHomerBuffer.h
index a1f52c0812132ae99a02b76b54155ae776dcdbe4..8130a9e0a5aba9828a3a47b301b158bf572a33c8 100644 (file)
--- a/HLT/BASE/AliHLTOUTHomerBuffer.h
+++ b/HLT/BASE/AliHLTOUTHomerBuffer.h
@@ -3,37 +3,52 @@
 
 #ifndef ALIHLTOUTHOMERBUFFER_H
 #define ALIHLTOUTHOMERBUFFER_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   AliHLTOUTHomerBuffer.h
     @author Matthias Richter
     @date   
     @brief  HLTOUT data wrapper for a data buffer.
+*/
 
-// see below for class documentation
-// or
-// refer to README to build package
-// or
-// visit http://web.ift.uib.no/~kjeks/doc/alice-hlt
-                                                                          */
 #include "AliHLTOUT.h"
+#include "AliHLTLogging.h"
 
-class HOMERReader;
+class AliHLTHOMERReader;
+class AliHLTMonitoringReader;
+class AliHLTHOMERLibManager;
 
 /**
  * @class AliHLTOUTHomerBuffer
  * Handler of HLTOUT data for buffer input.
+ *
+ * The class supports the AliHLTOUT interface in order to access the
+ * individual data blocks of a HOMER data collection. An AliHOMERReader
+ * is created to interpret the data. The class can serve as base for
+ * other HLTOUT implementations supporting different kinds of input like
+ * the AliHLTOUTHomerCollection and its childs AliHLTOUTRawReader and
+ * AliHLTOUTDigitReader.
+ *
+ * @note The buffer is expected to contain the HOMER data block only, no
+ * CDH and HLT headers.
  */
-class AliHLTOUTHomerBuffer : public AliHLTOUT {
+class AliHLTOUTHomerBuffer : public AliHLTOUT, public AliHLTLogging {
  public:
   /** constructor */
-  AliHLTOUTHomerBuffer(const AliHLTUInt8_t* pBuffer);
+  AliHLTOUTHomerBuffer(const AliHLTUInt8_t* pBuffer, int size);
   /** destructor */
   virtual ~AliHLTOUTHomerBuffer();
 
  protected:
+  /**
+   * Step trough data blocks of a HOMER reader and generate index.
+   */
+  int ScanReader(AliHLTMonitoringReader* pReader, AliHLTUInt32_t majorIndex=0);
+
+  /** dynamic loader manager for HOMER library */
+  AliHLTHOMERLibManager* fpManager; //!transient
 
  private:
   /** standard constructor prohibited */
@@ -50,18 +65,31 @@ class AliHLTOUTHomerBuffer : public AliHLTOUT {
 
   /**
    * Get the data buffer
-   * @param index   [in]  index of the block
-   * @param pBuffer [out] buffer of the selected data block
-   * @param size    [out] size of the selected data block
+   * @param [in]  index   index of the block
+   * @param [out] pBuffer buffer of the selected data block
+   * @param [out] size    size of the selected data block
    */
   virtual int GetDataBuffer(AliHLTUInt32_t index, const AliHLTUInt8_t* &pBuffer, 
                            AliHLTUInt32_t& size);
 
+  /**
+   * Check byte order of data block
+   */
+  virtual AliHLTOUTByteOrder CheckBlockByteOrder(AliHLTUInt32_t index);
+
+  /**
+   * Check alignment of data block
+   */
+  virtual int CheckBlockAlignment(AliHLTUInt32_t index, AliHLTOUT::AliHLTOUTDataType type);
+
   /** data buffer */
   const AliHLTUInt8_t* fpBuffer; //! transient
 
+  /** size of data buffer */
+  int fSize; //! transient
+
   /** instance of the HOMER reader */
-  HOMERReader* fpReader;  //!transient
+  AliHLTHOMERReader* fpReader;  //!transient
 
   ClassDef(AliHLTOUTHomerBuffer, 0)
 };