Changeset 5087 for trunk/psLib/src/astro/psTime.h

Timestamp:

Sep 21, 2005, 11:37:21 AM (21 years ago)

Author:

drobbin

Message:

Updated/added psTimer fxns and psVectorCreate (and tests)

File:

• trunk/psLib/src/astro/psTime.h (modified) (2 diffs)

trunk/psLib/src/astro/psTime.h

@@ -11 +11 @@
  *  @author Ross Harman, MHPCC
  *
- *  @version $Revision: 1.40 $ $Name: not supported by cvs2svn $
- *  @date $Date: 2005-09-21 02:11:16 $
+ *  @version $Revision: 1.41 $ $Name: not supported by cvs2svn $
+ *  @date $Date: 2005-09-21 21:37:20 $
  *
  *  Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii
@@ -375 +375 @@
 char* p_psGetConfigFileName();
 
+/**
+ *
+ *
+ *
+ */
 psF64 p_psTimeSearchTables(
-    psF64 index,
-    psU64 column,
-    char *metadataTableNames[],
-    psU32 nTables,
-    psLookupStatusType* status
-);
-
+    psF64 index,                       ///<
+    psU64 column,                      ///<
+    char *metadataTableNames[],        ///<
+    psU32 nTables,                     ///<
+    psLookupStatusType* status         ///<
+);
+
+/** Stores the current time in a psHash of timers, under the supplied name.
+ *
+ *  @return bool:       True if successful, otherwise false.
+ */
 bool psTimerStart(
-    char *name
-);
-
+    char *name                         ///< timer name to start
+);
+
+/** Resets the named timer.
+ *
+ *  @return psF64:      The time elapsed since start.
+ */
 psF64 psTimerClear(
-    char *name
-);
-
+    char *name                         ///< timer name to clear
+);
+
+/** Returns the elapsed time, in seconds, for the timer specified by name.
+ *
+ *  @return psF64:      The elapsed time in seconds since timer start.
+ */
 psF64 psTimerMark(
-    char *name
-);
-
+    char *name                        ///< timer name to mark
+);
+
+/** Frees all memory associated with all timers and returns the expended time.
+ *
+ *  @return psF64:      The maximum time expended.
+ */
 psF64 psTimerStop(void);