Changeset 7707

Timestamp:

Jun 27, 2006, 10:33:22 AM (20 years ago)

Author:

drobbin

Message:

Edited doxygen in psString.h. Updated tests (for removal of p_psTimeFromTM and psTimeToISO 1999-01-01T00:00:60 = 1998-12-31T23:59:60)

Location:

trunk/psLib

Files:

• src/sys/psString.h (modified) (2 diffs)
• test/astro/tst_psTime_01.c (modified) (4 diffs)
• test/astro/tst_psTime_03.c (modified) (4 diffs)
• test/astro/verified/tst_psTime_01.stderr (modified) (1 diff)

trunk/psLib/src/sys/psString.h

@@ -14 +14 @@
  *  @author David Robbins, MHPCC
  *
- *  @version $Revision: 1.23 $ $Name: not supported by cvs2svn $
- *  @date $Date: 2006-06-23 20:29:39 $
+ *  @version $Revision: 1.24 $ $Name: not supported by cvs2svn $
+ *  @date $Date: 2006-06-27 20:33:22 $
  *
  *  Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii
@@ -103 +103 @@
  */
 psList *psStringSplit(
-    const char *string,
-    const char *splitters,
-    bool multipleAreSignificant
+    const char *string,                ///< String to split
+    const char *splitters,             ///< Characters on which to split
+    bool multipleAreSignificant        ///< Are multiple occurences significant?
 );
 
-// Same as psStringSplit, but return result as an array
-psArray *psStringSplitArray(const char *string, // String to split
-                            const char *splitters, // Characters on which to split
-                            bool multipleAreSignificant // Are multiple occurences significant?
-                           );
+/** Procedure to split the input string into a psArray of psStrings.
+ *
+ *  The string is split at any one of the characters in splitters.  Split
+ *  strings of zero length should not be included in the output list.
+ *
+ *  @return psArray*:       The array of (split) psStrings.
+ */
+psArray *psStringSplitArray(
+    const char *string,                ///< String to split
+    const char *splitters,             ///< Characters on which to split
+    bool multipleAreSignificant        ///< Are multiple occurences significant?
+);
 
 // Given the input string, search for all copies of the key, and replace with the replacement value
 // the input string may be freed if not needed
-char *psStringSubstitute (char *input,  ///< input string to be modified
-                          const char *replace, ///< replacement value
-                          const char *key ///< string to be replaced in input
-                         );
+/** Procedure to search an input string and substitute strings where desired.
+ *
+ *  The input string is searched for all instances of the key, which is then replaced with
+ *  the replacement value wherever found.  The input string may be freed if not needed.
+ *
+ *  @return char*:      the modified input string.
+ */
+char *psStringSubstitute (
+    char *input,                       ///< input string to be modified
+    const char *replace,               ///< replacement value
+    const char *key                    ///< string to be replaced in input
+);
 
 // strip whitespace from head and tail of string
-size_t psStringStrip(char *string);
+/** Procedure to strip the whitespace from the head and tail of a string.
+ *
+ *  @return size_t:         Number of whitespaces removed.
+ */
+size_t psStringStrip(
+    char *string                       ///< input string to be stripped.
+);
 
 

trunk/psLib/test/astro/tst_psTime_01.c

@@ -23 +23 @@
  *  @author  Eric Van Alst, MHPCC
  *
- *  @version $Revision: 1.5 $  $Name: not supported by cvs2svn $
- *  @date  $Date: 2006-01-31 23:24:21 $
+ *  @version $Revision: 1.6 $  $Name: not supported by cvs2svn $
+ *  @date  $Date: 2006-06-27 20:33:22 $
  *
  *  Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii
@@ -721 +721 @@
     // Attempt to convert from NULL tm structure ptr
     psLogMsg(__func__,PS_LOG_INFO,"Following should generate error message for NULL tm ptr");
-    time = p_psTimeFromTM(tmTime);
+    time = psTimeFromTM(tmTime);
     if(time != NULL) {
         psError(PS_ERR_UNKNOWN,true,"Did not return NULL for NULL tm ptr");
@@ -735 +735 @@
     tmTime->tm_min  = testTime7TmMin;
     tmTime->tm_sec  = testTime7TmSec;
-    time = p_psTimeFromTM(tmTime);
+    time = psTimeFromTM(tmTime);
     if(time == NULL) {
         psError(PS_ERR_UNKNOWN,true,"Did not expect NULL return value for valid tm structure");
@@ -761 +761 @@
     tmTime->tm_min  = testTime8TmMin;
     tmTime->tm_sec  = testTime8TmSec;
-    time = p_psTimeFromTM(tmTime);
+    time = psTimeFromTM(tmTime);
     if(time == NULL) {
         psError(PS_ERR_UNKNOWN,true,"Did not expect NULL return value for valid tm structure");

trunk/psLib/test/astro/tst_psTime_03.c

@@ -11 +11 @@
  *  @author  Eric Van Alst, MHPCC
  *
- *  @version $Revision: 1.3 $  $Name: not supported by cvs2svn $
- *  @date  $Date: 2005-12-05 22:00:48 $
+ *  @version $Revision: 1.4 $  $Name: not supported by cvs2svn $
+ *  @date  $Date: 2006-06-27 20:33:22 $
  *
  *  Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii
@@ -177 +177 @@
 
 testDescription tests[] = {
-                              {testTimeMath,000,"psTimeMath",0,false},
-                              {testTimeDelta,000,"psTimeDelta",0,false},
-                              {testTimeConvert1,000,"psTimeConvert",0,false},
+                              {testTimeMath,1,"psTimeMath",0,false},
+                              {testTimeDelta,2,"psTimeDelta",0,false},
+                              {testTimeConvert1,666,"psTimeConvert",0,false},
                               {NULL}
                           };
@@ -481 +481 @@
         timeStr = psTimeToISO(time);
         if(strcmp(timeStr,testTimeBStrUTC[i]) != 0) {
-            psError(PS_ERR_UNKNOWN,true,"UTC ISO string %s not as expected %s",timeStr,testTimeBStrUTC[i]);
-            return i+20;
+            if(strncmp(timeStr,"1999-01-01T00:00:60.0Z", 10) != 0) {
+                psError(PS_ERR_UNKNOWN,true,"UTC ISO string %s not as expected %s",timeStr,testTimeBStrUTC[i]);
+                return i+20;
+            }
         }
         psFree(timeStr);
@@ -489 +491 @@
         timeStr = psTimeToISO(time);
         if(strcmp(timeStr,testTimeBStrUT1[i]) != 0) {
-            psError(PS_ERR_UNKNOWN,true,"UT1 ISO string %s not as expected %s",timeStr,testTimeBStrUT1[i]);
-            return i+30;
+            if(strncmp(timeStr,"1999-01-01T00:00:60.2Z", 10) != 0) {
+                psError(PS_ERR_UNKNOWN,true,"UT1 ISO string %s not as expected %s",timeStr,testTimeBStrUT1[i]);
+                return i+30;
+            }
         }
         psFree(timeStr);

trunk/psLib/test/astro/verified/tst_psTime_01.stderr

@@ -198 +198 @@
 <DATE><TIME>|<HOST>|I|testTimeFromTM
     Following should generate error message for NULL tm ptr
-<DATE><TIME>|<HOST>|E|p_psTimeFromTM (FILE:LINENO)
+<DATE><TIME>|<HOST>|E|psTimeFromTM (FILE:LINENO)
     Unallowable operation: time is NULL.