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

Timestamp:

Jan 18, 2006, 10:59:32 AM (20 years ago)

Author:

drobbin

Message:

Small update to TEO/polarTide. New fxn Time_TideUT1Corr done and tested.

File:

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

trunk/psLib/src/astro/psTime.h

@@ -11 +11 @@
  *  @author Ross Harman, MHPCC
  *
- *  @version $Revision: 1.43 $ $Name: not supported by cvs2svn $
- *  @date $Date: 2005-11-12 03:37:34 $
+ *  @version $Revision: 1.44 $ $Name: not supported by cvs2svn $
+ *  @date $Date: 2006-01-18 20:59:31 $
  *
  *  Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii
@@ -76 +76 @@
  * Reads config and data files associated with various time conversions.
  *
- * @return  bool: True for success, false for failure.
+ * @return bool:    True for success, false for failure.
  */
 psBool p_psTimeInit(
@@ -94 +94 @@
  * Frees time data to be held in memory until the end of successful program execution.
  *
- * @return  void: void.
+ * @return void:    void.
  */
 psBool p_psTimeFinalize(void);
@@ -110 +110 @@
  * of the struct are set to zero.
  *
- * @return  psTime*: Struct with empty time.
+ * @return psTime*:     Struct with empty time.
  */
 psTime* psTimeAlloc(
@@ -133 +133 @@
  * (PS_TIME_TAI or PS_TIME_UTC) in the argument.
  *
- *  @return  psTime*: Struct with current time.
+ *  @return psTime*:    Struct with current time.
  */
 psTime* psTimeGetNow(
@@ -143 +143 @@
  *  Converts psTime to UTC, TAI, UT1, or TT time based on the psTimeType argument.
  *
- *  @return  psTime*: Pointer to psTime.
+ *  @return psTime*:    Pointer to psTime.
  */
 psTime* psTimeConvert(
@@ -155 +155 @@
  *  in UTC format, then it is converted.
  *
- *  @return  double: LST Time.
+ *  @return double:     LST Time.
  */
 double psTimeToLMST(
@@ -166 +166 @@
  *  This function is necessary to for various SLALIB functions.
  *
- *  @return  double: Time difference.
+ *  @return double:     Time difference.
  */
 double psTimeGetUT1Delta(
@@ -173 +173 @@
 );
 
+/** Provides tidal corrections to UT1-UTC.
+ *
+ *  Uses the Ray model of Simon et al.
+ *
+ *  @return psTime*:    The corrected time in UT1.
+ */
+psTime *psTime_TideUT1Corr(
+    const psTime *time                 ///< psTime to be corrected.
+);
+
 /** Determine TAI - UTC from table lookup.
  *
  *  This function is necessary to for various psTime functions.
  *
- *  @return  psF64: Time difference.
+ *  @return psF64:      Time difference.
  */
 psF64 p_psTimeGetTAIDelta(
@@ -187 +197 @@
  *  Determines the orientation of the polar axis at the given time.
  *
- *  @return  psSphere*: Spherical coordinates of Earth's polar axias.
+ *  @return psSphere*:      Spherical coordinates of Earth's polar axias.
  */
 psSphere* p_psTimeGetPoleCoords(
@@ -197 +207 @@
  *  Calculates the number of leapseconds between two times.
  *
- *  @return  long: leapseconds added between given times
+ *  @return long:   leapseconds added between given times
  */
 long psTimeLeapSecondDelta(
@@ -208 +218 @@
  *  Determines if the specified UTC time is a valid leapsecond.
  *
- *  @return  bool: valid leap second
+ *  @return bool:   valid leap second
  */
 bool psTimeIsLeapSecond(
@@ -219 +229 @@
  *  subtract leapseconds.
  *
- *  @return  double: Julian Date (JD) time.
+ *  @return double:     Julian Date (JD) time.
  */
 double psTimeToJD(
@@ -229 +239 @@
  *  add or subtract leapseconds.
  *
- *  @return  double: Modified Julian Days (MJD) time.
+ *  @return double:     Modified Julian Days (MJD) time.
  */
 double psTimeToMJD(
@@ -240 +250 @@
  *  This function does not add or subtract leapseconds.
  *
- *  @return  psString:     Pointer null terminated array of chars in ISO time.
+ *  @return psString:     Pointer null terminated array of chars in ISO time.
  */
 psString psTimeToISO(
@@ -250 +260 @@
  *  Converts psTime to timeval time. This function does not add or subtract leapseconds.
  *
- *  @return  timeval*: timeval struct time.
+ *  @return timeval*:   timeval struct time.
  */
 struct timeval* psTimeToTimeval(