Changeset 1247 for trunk/psLib/src/astronomy/psTime.h

Timestamp:

Jul 20, 2004, 3:29:33 PM (22 years ago)

Author:

harman

Message:

Added more time functions

File:

• trunk/psLib/src/astronomy/psTime.h (modified) (9 diffs)

trunk/psLib/src/astronomy/psTime.h

@@ -12 +12 @@
  *  @author Ross Harman, MHPCC
  *
- *  @version $Revision: 1.3 $ $Name: not supported by cvs2svn $
- *  @date $Date: 2004-07-15 19:02:13 $
+ *  @version $Revision: 1.4 $ $Name: not supported by cvs2svn $
+ *  @date $Date: 2004-07-21 01:29:22 $
  *
  *  Copyright 2004 Maui High Performance Computing Center, University of Hawaii
@@ -29 +29 @@
 /// @addtogroup Time
 /// @{
+
+/******************************************************************************/
+/*  DEFINE STATEMENTS                                                         */
+/******************************************************************************/
+
+/** Number of available leapsecond updates */
+#define NUM_LEAPSECOND_UPDATES 23
+
+/** Maximum length of time string */
+#define MAX_TIME_STRING_LENGTH 256
+
+/** Seconds per minute */
+#define  SEC_PER_MINUTE   60
+
+/** Seconds per hour */
+#define  SEC_PER_HOUR     60*SEC_PER_MINUTE
+
+/** Seconds per day */
+#define  SEC_PER_DAY      24*SEC_PER_HOUR
+
+/** Seconds per year */
+#define  SEC_PER_YEAR    365*SEC_PER_DAY
+
+/** Microseconds per day */
+#define USEC_PER_DAY 86400000000.0
 
 /******************************************************************************/
@@ -63 +88 @@
 /** Convert psTime to ISO time in TAI units.
  *
- * Converts psTime to a null terminated string in the form of: YYYY/MM/DD,HH:MM:SS.SSS. The result from this
- * function is in TAI units.
- *
- *  @return  char*: Pointer null terminated array of chars in ISO/TAI time.
+ * Converts psTime to a null terminated string in the form of: YYYY/MM/DD,HH:MM:SS.SSS. This function assumes
+ * the input time already is in TAI time and does not add or subtract leapseconds.
+ *
+ *  @return  char*: Pointer null terminated array of chars in ISO time.
  */
 char* psTimeToISO(
@@ -74 +99 @@
 /** Convert psTime to UTC time.
  *
- * Converts psTime to UTC time in double precision floating point notation. The result from this function is
- * not in TAI units, but that of UTC, which does not contain leapseconds.
- *
- *  @return  double: UTC time in floating point notation.
- */
-double psTimeToUTC(
+ * Converts psTime to UTC time in double precision floating point notation. The input to this must already be
+ * int TAI time. The result from this function is not in TAI units, but that of UTC, which does not contain
+ * leapseconds.
+ *
+ *  @return  psTime: UTC time psTime format.
+ */
+psTime psTimeToUTC(
     psTime time    /** Input time to be converted. */
 );
@@ -85 +111 @@
 /** Convert psTime to modified Julian date time.
  *
- * Converts psTime to modified Julian date (MJD) time. The result from this function is in TAI units.
- *
- *  @return  double: MJD/TAI time in floating point notation.
+ * Converts psTime to modified Julian date (MJD) time. This function assumes the input time already is in TAI
+ * time and does not add or subtract leapseconds.
+ *
+ *  @return  double: Modified Julian Days (MJD) time.
  */
 double psTimeToMJD(
@@ -95 +122 @@
 /** Convert psTime to Julian date time.
  *
- * Converts psTime to Julian date (JD) time. The result from this function is in TAI units.
- *
- *  @return  double: JD/TAI time in floating point notation.
+ * Converts psTime to Julian date (JD) time. This function assumes the input time already is in TAI time and
+ * does not add or subtract leapseconds.
+ *
+ *  @return  double: Julian Date (JD) time.
  */
 double psTimeToJD(
@@ -105 +133 @@
 /** Convert psTime to timeval time.
  *
- * Converts psTime to timeval time. The result from this function is in TAI units.
- *
- *  @return  timeval: timeval/TAI time.
+ * Converts psTime to timeval time. This function assumes the input time already is in TAI time and does not
+ * add or subtract leapseconds.
+ *
+ *  @return  timeval: timeval struct time.
  */
 struct timeval psTimeToTimeval(
@@ -115 +144 @@
 /** Convert psTime to tm time.
  *
- * Converts psTime to tm time. The result from this function is in TAI units.
- *
- *  @return  tm: tm/TAI time.
+ * Converts psTime to tm time. This function assumes the input time already is in TAI time and does not add or
+ * subtract leapseconds.
+ *
+ *  @return  tm: tm struct time.
  */
 struct tm* psTimeToTM(
@@ -125 +155 @@
 /** Convert ISO to psTime.
  *
- * Converts ISO time to psTime. The result from this function is in TAI units.
+ * Converts ISO time to psTime. This function assumes the input time already is in TAI time and does not add
+ * or subtract leapseconds.
+ *
+ *  @return  psTime: time
+ */
+psTime psISOToTime(
+    char *time  /** Input time to be converted. */
+);
+
+/** Convert UTC to psTime.
+ *
+ * Converts UTC time to psTime. This function assumes the input time already is in TAI time and add or
+ * subtracts the necessary leapseconds.
  *
  *  @return  psTime: time in TAI units.
  */
-psTime psISOToTime(char *time);
-
-/** Convert UTC to psTime.
- *
- * Converts UTC time to psTime. The result from this function is in TAI units.
- *
- *  @return  psTime: time in TAI units.
- */
-psTime psUTCToTime(double time);
+psTime psUTCToTime(
+    psTime time /** Input time to be converted. */
+);
 
 /** Convert MJD to psTime.
  *
- * Converts MJD time to psTime. The result from this function is in TAI units.
- *
- *  @return  psTime: time in TAI units.
- */
-psTime psMJDToTime(double time);
+ * Converts MJD time to psTime. This function assumes the input time already is in TAI time and does not add
+ * or subtract leapseconds.
+ *
+ *  @return  psTime: time.
+ */
+psTime psMJDToTime(
+    double time /** Input time to be converted. */
+);
 
 /** Convert JD to psTime.
  *
- * Converts JD time to psTime. The result from this function is in TAI units.
- *
- *  @return  psTime: time in TAI units.
- */
-psTime psJDToTime(double time);
+ * Converts JD time to psTime. This function assumes the input time already is in TAI time and does not add
+ * or subtract leapseconds.
+ *
+ *  @return  psTime: time.
+ */
+psTime psJDToTime(
+    double time /** Input time to be converted. */
+);
 
 /** Convert timeval to psTime.
  *
- * Converts timeval time to psTime. The result from this function is in TAI units.
- *
- *  @return  psTime: time in TAI units.
- */
-psTime psTimevalToTime(struct timeval *time);
+ * Converts timeval time to psTime. This function assumes the input time already is in TAI time and does not
+ * add or subtract leapseconds.
+ *
+ *  @return  psTime: time.
+ */
+psTime psTimevalToTime(
+    struct timeval *time    /** Input time to be converted. */
+);
 
 /** Convert tm time to psTime.
  *
- * Converts tm time to psTime. The result from this function is in TAI units.
- *
- *  @return  psTime: time in TAI units.
- */
-psTime psTMToTime(struct tm *time);
+ * Converts tm time to psTime. This function assumes the input time already is in TAI time and does not add
+ * or subtract leapseconds.
+ *
+ *  @return  psTime: time.
+ */
+psTime psTMToTime(
+    struct tm *time /** Input time to be converted. */
+);
 /// @}