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

Timestamp:

Jun 28, 2005, 10:17:52 AM (21 years ago)

Author:

drobbin

Message:

updated files in accordance with requested revisions in apidelta-report-cycle6

File:

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

trunk/psLib/src/astro/psTime.h

@@ -11 +11 @@
  *  @author Ross Harman, MHPCC
  *
- *  @version $Revision: 1.32 $ $Name: not supported by cvs2svn $
- *  @date $Date: 2005-06-21 03:01:37 $
+ *  @version $Revision: 1.33 $ $Name: not supported by cvs2svn $
+ *  @date $Date: 2005-06-28 20:17:52 $
  *
  *  Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii
@@ -38 +38 @@
  */
 typedef enum {
-    PS_TIME_TAI,        ///< Temps Atomique International (TAI) time (time with leapseconds).
-    PS_TIME_UTC,        ///< Universal Time Coordinated (UTC) time (time without leapseconds).
-    PS_TIME_UT1,        ///< Universal Time corrected for polar motion
-    PS_TIME_TT,         ///< Terrestrial Time
+    PS_TIME_TAI,                       ///< Temps Atomique International (TAI) time (time with leapseconds)
+    PS_TIME_UTC,                       ///< Universal Time Coordinated (UTC) time (time without leapseconds)
+    PS_TIME_UT1,                       ///< Universal Time corrected for polar motion
+    PS_TIME_TT,                        ///< Terrestrial Time
 } psTimeType;
 
@@ -49 +49 @@
  */
 typedef enum {
-    PS_IERS_A,          ///< IERS Bulletin A
-    PS_IERS_B,          ///< IERS Bulletin B
+    PS_IERS_A,                         ///< IERS Bulletin A
+    PS_IERS_B,                         ///< IERS Bulletin B
 } psTimeBulletin;
 
@@ -62 +62 @@
 typedef struct psTime
 {
-    psS64 sec;          ///< Seconds since epoch, Jan 1, 1970.
-    psU32 nsec;         ///< Nanoseconds since last second.
-    psBool leapsecond;  ///< if time falls on UTC leapsecond
-    psTimeType type;    ///< Type of time.
+    psS64 sec;                         ///< Seconds since epoch, Jan 1, 1970.
+    psU32 nsec;                        ///< Nanoseconds since last second.
+    psBool leapsecond;                 ///< if time falls on UTC leapsecond
+    psTimeType type;                   ///< Type of time.
 }
 psTime;
@@ -97 +97 @@
  */
 psTime* psTimeAlloc(
-    psTimeType type                     ///< Type of time to create (UTC or TAI).
+    psTimeType type                    ///< Type of time to create (UTC or TAI).
 );
 
@@ -108 +108 @@
  */
 psTime* psTimeGetNow(
-    psTimeType type                     ///< Type of time to get (UTC or TAI).
+    psTimeType type                    ///< Type of time to get (UTC or TAI).
 );
 
@@ -118 +118 @@
  */
 psTime* psTimeConvert(
-    psTime *time,                       ///< Time to be converted.
-    psTimeType type                     ///< Type to be converted to.
+    psTime *time,                      ///< Time to be converted.
+    psTimeType type                    ///< Type to be converted to.
 );
 
@@ -131 +131 @@
 double psTimeToLMST(
     psTime *time,                      ///< psTime to be converted.
-    double longitude                    ///< Longitude.
+    double longitude                   ///< Longitude.
 );
 
@@ -141 +141 @@
  */
 double psTimeGetUT1Delta(
-    const psTime *time,                 ///< psTime to be looked up.
-    psTimeBulletin bulletin             ///< IERS bulletin to use
+    const psTime *time,                ///< psTime to be looked up.
+    psTimeBulletin bulletin            ///< IERS bulletin to use
 );
 
@@ -152 +152 @@
  */
 psF64 p_psTimeGetTAIDelta(
-    const psTime *time                  ///< psTime to be looked up.
+    const psTime *time                 ///< psTime to be looked up.
 );
 
@@ -212 +212 @@
  *  This function does not add or subtract leapseconds.
  *
- *  @return  char*: Pointer null terminated array of chars in ISO time.
- */
-char* psTimeToISO(
+ *  @return  psString:     Pointer null terminated array of chars in ISO time.
+ */
+psString psTimeToISO(
     const psTime* time                  ///< Input time to be converted.
 );
@@ -268 +268 @@
  */
 psTime* psTimeFromISO(
-    const char* time                   ///< Input time to be converted.
+    const char* input                  ///< Input time to be converted.
 );
 
@@ -278 +278 @@
  */
 psTime* psTimeFromTimeval(
-    const struct timeval *time         ///< Input time to be converted.
+    const struct timeval *input        ///< Input time to be converted.
 );
 
@@ -296 +296 @@
  *  Converts UTC time to psTime.  It will verify if time specified is a leapsecond.
  *
- *  @return psTime*: time (UTC)
+ *  @return psTime*: time (UTC)time
  */
 psTime* psTimeFromUTC(