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

Timestamp:

Jun 21, 2007, 4:28:48 PM (19 years ago)

Author:

jhoblitt

Message:

change psLibInit() to return a boolean status
change psLibFinalize() to abort on error as psError() may not/should not be working after invoking this function
change psTimeInitialize() to return a bool status
change psTimeInitialize() to deffer the actual loading of the "time tables"
rename psTimeInitialize() -> psTimeInit()
rename p_psTimeConfigFileName() -> p_psTimeConfigFilename()
change p_psTimeConfigFilename() to accept a filename argument
p_psTimeConfigFilename() now either return's the current conf files name when passed NULL or sets it to the "filename" parameter that is passed in
change all psTime* functions to make sure that the "time tables" have been initalized before using them

File:

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

trunk/psLib/src/astro/psTime.h

@@ -11 +11 @@
  *  @author Ross Harman, MHPCC
  *
- *  @version $Revision: 1.55 $ $Name: not supported by cvs2svn $
- *  @date $Date: 2007-02-06 21:36:09 $
+ *  @version $Revision: 1.56 $ $Name: not supported by cvs2svn $
+ *  @date $Date: 2007-06-22 02:28:48 $
  *
  *  Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii
@@ -75 +75 @@
 
 
-// get the pslib.config filename by checking environment variable first, then original installation area.
-const char *p_psTimeConfigFileName();
-
-
 /** Initialize time data.
  *
- * Reads config and data files associated with various time conversions.
- *
- * @return bool:    True for success, false for failure.
- */
-bool p_psTimeInit(
-    const char *fileName               ///< File name containing config/data info
-);
-
-/** Initialize time data.
- *
- *  Reads the configuration file and sets up the appropriate psTimeTables and predictions.
- */
-void psTimeInitialize(
-    const char *timeConfig             ///< psTime configuration file
-);
-
-/** Free memory persistant time data.
- *
- * Frees time data to be held in memory until the end of successful program execution.
- *
- * @return void:    void.
- */
+ *  Sets the configuration file and sets up the appropriate psTimeTables and predictions.
+ */
+bool psTimeInit(
+    const char *filename                ///< psTime configuration file
+);
+
+
+/** Frees memory that was allocated by psTime functions.
+ *
+ *  Allows a subsequent search for leaked memory.
+ *
+ * @return true on sucess.
+*/
 bool p_psTimeFinalize(void);
 
@@ -476 +463 @@
 );
 
+// used by p_psEOCInit()
+const char *p_psTimeConfigFilename(const char *filename);
+
 /// @}