minor documentation changes
authorrichterm <richterm@f7af4fe6-9843-0410-8265-dc069ae4e863>
Fri, 19 Oct 2007 12:04:06 +0000 (12:04 +0000)
committerrichterm <richterm@f7af4fe6-9843-0410-8265-dc069ae4e863>
Fri, 19 Oct 2007 12:04:06 +0000 (12:04 +0000)
HLT/BASE/HOMER/AliHLTHOMERReader.cxx
HLT/BASE/HOMER/AliHLTHOMERReader.h
HLT/BASE/HOMER/AliHLTHOMERWriter.cxx

index 4577c07cfe89f1738f4facdd01b69d70e4771d07..15676c1e152d6a0cbce1af4e2cbce7e90ddcc646 100644 (file)
@@ -94,11 +94,11 @@ HOMERReader::HOMERReader()
   fErrorConnection(~(unsigned int)0),
   fEventRequestAdvanceTime(0)
     {
-// see header file for class documentation
-// or
-// refer to README to build package
-// or
-// visit http://web.ift.uib.no/~kjeks/doc/alice-hlt
+// Reader implementation of the HOMER interface.
+// The HLT Monitoring Environment including ROOT is
+// a native interface to ship out data from the HLT chain.
+// See pdf document shiped with the package
+// for class documentation and tutorial.
     Init();
     }
 #endif
index 8bcde0d1f4533df8dd1eb56697210a6a61bfc703..596337583432cd4640d28e9807b2387130c760c4 100644 (file)
@@ -122,6 +122,7 @@ class HOMERReader: public MonitoringReader
 
        void SetEventRequestAdvanceTime( unsigned long time )
                {
+               // advance time in us
                fEventRequestAdvanceTime = time;
                }
 
@@ -263,41 +264,41 @@ class HOMERReader: public MonitoringReader
                const char* fOriginatingNodeID; // node id from which the data originates
            };
 
-      /** type of the current event */
-      homer_uint64 fCurrentEventType;                             //!transient
-      /** ID of the current event */
-      homer_uint64 fCurrentEventID;                               //!transient
-      /** no of blocks currently used */
-      unsigned long fBlockCnt;                                    //!transient
-      /** available space in the block array */
-      unsigned long fMaxBlockCnt;                                 //!transient
-      /** block array */
-      DataBlock* fBlocks;                                         //!transient
-       
-      /** total no of data sources */
-      unsigned int fDataSourceCnt;                                //!transient
-      /** no of TCP data sources */
-      unsigned int fTCPDataSourceCnt;                             //!transient
-      /** no of Shm data sources */
-      unsigned int fShmDataSourceCnt;                             //!transient
-      /** available space in the sources array */
-      unsigned int fDataSourceMaxCnt;                             //!transient
-      /** array of data source descriptions */
-      DataSource* fDataSources;                                   //!transient
-
-      /** status of the connection */
-      int fConnectionStatus;                                      //!transient
-      /** flag an error for */
-      unsigned fErrorConnection;                                  //!transient
-
-      /** */
-      unsigned long fEventRequestAdvanceTime;                     //!transient
+        /** type of the current event */
+       homer_uint64 fCurrentEventType;                             //!transient
+       /** ID of the current event */
+       homer_uint64 fCurrentEventID;                               //!transient
+       /** no of blocks currently used */
+       unsigned long fBlockCnt;                                    //!transient
+       /** available space in the block array */
+       unsigned long fMaxBlockCnt;                                 //!transient
+       /** block array */
+       DataBlock* fBlocks;                                         //!transient
+               
+       /** total no of data sources */
+       unsigned int fDataSourceCnt;                                //!transient
+       /** no of TCP data sources */
+       unsigned int fTCPDataSourceCnt;                             //!transient
+       /** no of Shm data sources */
+       unsigned int fShmDataSourceCnt;                             //!transient
+       /** available space in the sources array */
+       unsigned int fDataSourceMaxCnt;                             //!transient
+       /** array of data source descriptions */
+       DataSource* fDataSources;                                   //!transient
+       
+       /** status of the connection */
+       int fConnectionStatus;                                      //!transient
+       /** flag an error for */
+       unsigned fErrorConnection;                                  //!transient
+       
+       /** */
+       unsigned long fEventRequestAdvanceTime;                     //!transient
     private:
-      /** copy constructor prohibited */
-      HOMERReader(const HOMERReader&);
-      /** assignment operator prohibited */
-      HOMERReader& operator=(const HOMERReader&);
-
+       /** copy constructor prohibited */
+       HOMERReader(const HOMERReader&);
+       /** assignment operator prohibited */
+       HOMERReader& operator=(const HOMERReader&);
+       
 #ifdef USE_ROOT
         ClassDef(HOMERReader,2);
 #endif
index 3e8adfb9c6e5c22c5097e753be7735d9c8380ff1..b279f02a530dcdfd3aadf458a6228d861ffabb61 100644 (file)
@@ -52,11 +52,11 @@ HOMERWriter::HOMERWriter()
   fDataOffset(0),
   fBlocks()
     {
-// see header file for class documentation
-// or
-// refer to README to build package
-// or
-// visit http://web.ift.uib.no/~kjeks/doc/alice-hlt
+// Writer implementation of the HOMER interface.
+// The HLT Monitoring Environment including ROOT is
+// a native interface to ship out data from the HLT chain.
+// See pdf document shiped with the package
+// for class documentation and tutorial.
     Clear();
     }