Changeset 23197 for branches/cnb_branches/cnb_branch_20090215/psLib/src/astro/psTime.h

Timestamp:

Mar 5, 2009, 11:13:29 AM (17 years ago)

Author:

beaumont

Message:

Finished ppStack visualization. Unified the way in which visualizations are invoked, plotting windows are closed, etc

Location:

branches/cnb_branches/cnb_branch_20090215

Files:

• . (modified) (1 prop)
• psLib/src/astro/psTime.h (modified) (4 diffs)

branches/cnb_branches/cnb_branch_20090215/psLib/src/astro/psTime.h

@@ -135 +135 @@
 /** Convert psTime to UTC, TAI, UT1, or TT time.
  *
- *  Converts psTime to UTC, TAI, UT1, or TT time based on the psTimeType argument.
- *
- *  @return psTime*:    Pointer to psTime.
- */
-psTime* psTimeConvert(
+ *  Converts psTime in-place to UTC, TAI, UT1, or TT time based on the psTimeType argument.
+ *
+ *  @return bool: Successful conversion?
+ */
+bool psTimeConvert(
     psTime *time,                      ///< Time to be converted.
     psTimeType type                    ///< Type to be converted to.
@@ -241 +241 @@
 /** Convert psTime to ISO8601 formatted string.
  *
- *  Converts psTime to a null terminated string in the form of YYYY-MM-DDThh:mm:ss.sss.
+ *  Converts psTime to a null terminated string in the form of YYYY-MM-DDThh:mm:ss.ssssss
  *  This function does not add or subtract leapseconds.
  *
@@ -249 +249 @@
     const psTime* time                  ///< Input time to be converted.
 );
+
+/** Set number of decimals printed by psTimeToISO
+ *
+ * @return int: Previous setting
+ */
+int psTimeSetISODecimals(
+    int num                             ///< Number of decimals to print
+    );
+
+/** Get number of decimals printed by psTimeToISO
+ *
+ * @return int: Current setting
+ */
+int psTimeGetISODecimals(void);
+
+/** Convert psTime to ISO8601 formatted string with limited decimal places
+ *
+ *  Converts psTime to a null terminated string in the form of YYYY-MM-DDThh:mm:ss.s, with as
+ *  many decimal places as specified.
+ *  This function does not add or subtract leapseconds.
+ *
+ *  @return psString:     Pointer null terminated array of chars in ISO time.
+ */
+psString psTimeToString(
+    const psTime *time,                 ///< Input time to be converted
+    int decimals                        ///< Number of decimals to use
+    );
+
 
 /** Convert psTime to struct tm time.
@@ -474 +502 @@
 );
 
-// used by p_psEOCInit()
-const char *p_psTimeConfigFilename(const char *filename);
+/// Return the name of the configuration file used for time
+///
+/// The name is derived first from the environment variable PS_CONFIG_FILE if set; next from a previously used
+/// configuration file if available; finally from the default which is set at install time.
+const char *p_psTimeConfigFilename(const char *filename // Filename to use, or NULL
+    );
 
 /// @}