Changeset 2212 in Sophya for trunk/SophyaLib/SysTools/resusage.h

Timestamp:

Oct 15, 2002, 5:48:53 PM (23 years ago)

Author:

ansari

Message:

Mise a jour de la documentation SysTools, Reza 15/10/2002

File:

• trunk/SophyaLib/SysTools/resusage.h (modified) (2 diffs)

trunk/SophyaLib/SysTools/resusage.h

@@ -24 +24 @@
   // Memory usage in kilo-bytes  
   // NOTE: getDataSize() getStackSize() retournent des valeurs bizarres
+  //! Returns the current memory (Resident) size (in kilo-bytes) 
   inline uint_8 getMemorySize() { return cur_rss; }
+  //! Returns the maximum allowed memory size: Min( \c MaxResidentSize , \c MaxDataSize ))
   inline uint_8 getMaxMemorySize() 
     { return((getMaxResidentSize()<getMaxDataSize()) ? 
              getMaxResidentSize() :getMaxDataSize() ); }
+  //! Returns the increase in memory usage since the previous call to \b Update()
   inline uint_8 getDeltaMemorySize() { return delta_rss; }
 
+  //! Returns the maximum allowd data segment size (in kilo-bytes)
   inline uint_8 getMaxDataSize() { return((max_datasz>0)?max_datasz:1024); }
+  //! Returns the current data segment size (in kilo-bytes)
   inline uint_8 getDataSize() { return cur_datasz; }  
+  //! Returns the maximum allowed resident size (in kilo-bytes)
   inline uint_8 getMaxResidentSize() { return((max_rss>0)?max_rss:1024); }
+  //! Returns the current resident memory size (in kilo-bytes)
   inline uint_8 getResidentSize() { return cur_rss; }
+  //! Returns the maximum allowed stack size (in kilo-bytes)
   inline uint_8 getMaxStackSize() { return max_stack; }
+  //! Returns the current stack size (in kilo-bytes)
   inline uint_8 getStackSize() { return cur_stack; }
 
   
   // Time in milli-second
+  //! Returns the total CPU time used (in milli-second)
   inline uint_8 getCPUTime() { return cur_tottm; }
+  //! Returns the total elapsed time (in milli-second)
   inline uint_8 getElapsedTime() { return elapsed_time; }
+  //! Returns the average load ( CPU time / elapsed time)
   inline double  getAverageCPULoad() 
     { return ((elapsed_time>1) ? (double)cur_tottm/(double)elapsed_time: 1.);}
 
+  //! Returns the CPU time used since the previous call to \b Update() (in milli-second)
   inline uint_8 getDeltaCPUTime() { return delta_tottm; }
+  //! Returns the elapsed time since the previous call to \b Update() (in milli-second)
   inline uint_8 getDeltaElapsedTime() { return delta_elapsed_time; }
+  //! Returns the CPU load since the previous call to \b Update()
   inline double  getCPULoad() 
     { return ((delta_elapsed_time>1) ? (double)delta_tottm/(double)delta_elapsed_time: 1.);}
 
 
+  //! Returns the total CPU time (in milli-second)
   inline uint_8 getTotalCPUTime() { return cur_tottm; }
+  //! Returns the CPU time in user mode (in milli-second)
   inline uint_8 getUserCPUTime() { return cur_usrtm; }
+  //! Returns the CPU time in system mode (in milli-second)
   inline uint_8 getSysCPUTime() { return cur_systm; }
 
 
   void  Print(ostream& os, int lp=0, bool upd=true);
+  //! Alias for the \b Print() method. 
   inline void print(ostream& os, int lp=0, bool upd=true){ Print(os,lp,upd); }
 
@@ -81 +100 @@
 };
 
+//! Prints the resource usage information on the output stream 
 inline ostream& operator << (ostream& os, ResourceUsage& ru)
 { ru.Print(os,0,true); return(os); }