update of AltroChannelSelector component by Jason: added monitoring histograms, make...

[u/mrichter/AliRoot.git] / HLT / RCU / AliHLTAltroGenerator.h

diff --git a/HLT/RCU/AliHLTAltroGenerator.h b/HLT/RCU/AliHLTAltroGenerator.h
index 261090fad8cf8bfcb383d78cfcbbd3460dd656be..35375305bce1e78cdd46dc0274bd84d6ac2c8640 100644 (file)
--- a/HLT/RCU/AliHLTAltroGenerator.h
+++ b/HLT/RCU/AliHLTAltroGenerator.h
@@ -31,6 +31,19 @@ class TRandom;
 
 /**
  * @class AliHLTAltroGenerator
+ * Helper class to generate data in the Altro format.
+ * 
+ * The class can be configured through the parameters of the
+ * AliHLTAltroGenerator(int, int, int, int, int) constructor.
+ * The data is generated by the Generate() method and stored internally 
+ * for subsequent use. The data is encoded into a buffer with the 
+ * GetData(AliHLTUInt8_t) or GetData(AliHLTUInt8_t, int) methods.
+ *
+ * A couple of functions provide access to the simulated data on a
+ * signal by signal basis (Next()) or a bunch by bunch basis
+ * (NextChannel() / NextBunch()).
+ *
+ * @ingroup alihlt_rcu
  */
 class AliHLTAltroGenerator : AliHLTLogging {
  public:
@@ -79,6 +92,7 @@ class AliHLTAltroGenerator : AliHLTLogging {
    * The provided buffer is filled with the encoded data from the
    * previous simulation.
    * @param pBuffer     target variable to receive the pointer
+   * @param size        size of the target buffer
    * @return size in byte, neg. error if failed
    */
   int GetData(AliHLTUInt8_t* pBuffer, int size);