adding unit test for AliHLTDataBuffer class

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

diff --git a/HLT/BASE/AliHLTOUTHomerBuffer.h b/HLT/BASE/AliHLTOUTHomerBuffer.h
index 075325d3346c1a1d9be71baf012f83699c51eb30..c23aef3019d2296f48f807e34450d3badb182759 100644 (file)
--- a/HLT/BASE/AliHLTOUTHomerBuffer.h
+++ b/HLT/BASE/AliHLTOUTHomerBuffer.h
@@ -3,22 +3,18 @@
 
 #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 AliHLTHOMERReader;
 class AliHLTMonitoringReader;
@@ -27,8 +23,18 @@ 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, int size);
@@ -69,12 +75,12 @@ class AliHLTOUTHomerBuffer : public AliHLTOUT {
   /**
    * Check byte order of data block
    */
-  virtual AliHLTOUTByteOrder_t CheckBlockByteOrder(AliHLTUInt32_t index);
+  virtual AliHLTOUTByteOrder CheckBlockByteOrder(AliHLTUInt32_t index);
 
   /**
    * Check alignment of data block
    */
-  virtual int CheckBlockAlignment(AliHLTUInt32_t index, AliHLTOUT::AliHLTOUTDataType_t type);
+  virtual int CheckBlockAlignment(AliHLTUInt32_t index, AliHLTOUT::AliHLTOUTDataType type);
 
   /** data buffer */
   const AliHLTUInt8_t* fpBuffer; //! transient