Changeset 895 in Sophya for trunk/SophyaLib/SysTools/ctimer.cc

Timestamp:

Apr 12, 2000, 7:49:54 PM (25 years ago)

Author:

ansari

Message:

Documentation de fichiers - Reza 12/4/2000

File:

• trunk/SophyaLib/SysTools/ctimer.cc (modified) (5 diffs)

trunk/SophyaLib/SysTools/ctimer.cc

@@ -1 +1 @@
 //
-// $Id: ctimer.cc,v 1.2 1999-04-21 13:11:59 ansari Exp $
+// $Id: ctimer.cc,v 1.3 2000-04-12 17:49:40 ansari Exp $
 //
 
@@ -8 +8 @@
 //++
 // Class        Timer
-// Lib          Outils++
+// Lib          SysTools
 // include      ctimer.h
 //
@@ -37 +37 @@
 //--
 
+/*!
+  \class SOPHYA::Timer
+  This class implements a simple chronometer which can be used for
+  measuring the CPU and elapsed time in functions. The constructor
+  keeps the start time (and CPU time) and an optional message. 
+  The \b Split method displays the partial time, and destructor 
+  displays the total CPU and elapsed time since timer creation.
+  The macro \b  TIMEF create a timer object with the function name.
+  The macro \b  SPLITTIME calls the split methode for the timer created
+  by TIMEF. A named timer can be created using the macro \b TIMEN(nom)
+*/
+
+/*! Constructor with the specification of a optional name or message */
 Timer::Timer(const char* name)
 : timerName(name)
@@ -53 +66 @@
 //--
 
-
+/*! Method which displays the partial CPU and elapsed time
+    An optional message can be passed to be used instead of the
+    timer name
+*/
 void Timer::Split(const char* comm)
 {
@@ -65 +81 @@
   int etmt = elapse - elapse0;
 
-  cout << "***Timing " << (comm ? comm : timerName) << endl;
+  cout << "***Timing " << (comm ? comm : timerName.c_str()) << endl;
 
 // Pour des formats comme ca, la syntaxe printf est plus agreable.