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

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.cc (modified) (4 diffs)

trunk/SophyaLib/SysTools/resusage.cc

@@ -16 +16 @@
   The information should be updated through the call to the 
   Update() method. 
+  Note: The information is obtained through \c getrusage()   
+  and \c getrlimit() system calls, and depending on the OS, 
+  not all of the memory usage values are correctly filled.
+  \code
+  // How to check resource usage for a given part of the program
+  ResourceUsage res;
+  // --- Part of the program to be checked : Start
+  // ...
+  res.Update();
+  cout << " Memory size increase (KB):" << res.getDeltaMemorySize() << endl;
+  cout << " Resource usage info : \n" << res << endl;
+  \endcode
 */
-
+/*!
+  Constructor. the \b Update() method is called.
+*/
 ResourceUsage::ResourceUsage()
 {
@@ -47 +61 @@
   
 }
-
+/*!
+   Destructor.
+*/
 ResourceUsage::~ResourceUsage()
 {
@@ -58 +74 @@
 }
 
+/*!
+  Update the CPU and memory usage information.
+*/
 int ResourceUsage::Update()
 {
@@ -82 +101 @@
 }
 
+/*!
+   Prints the CPU and memory usage information.
+   \param os : The output stream
+   \param lp : The print level (0 .. 2)
+   \param upd : if \c true , the Update method is called.
+*/
 void ResourceUsage::Print(ostream& os, int lp, bool upd) 
 {