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

Timestamp:

Nov 11, 2005, 5:37:34 PM (20 years ago)

Author:

drobbin

Message:

Implemented PrecessionCorr function. Not verified, very possibly wrong.

File:

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

trunk/psLib/src/astro/psTime.h

@@ -11 +11 @@
  *  @author Ross Harman, MHPCC
  *
- *  @version $Revision: 1.42 $ $Name: not supported by cvs2svn $
- *  @date $Date: 2005-11-03 04:31:22 $
+ *  @version $Revision: 1.43 $ $Name: not supported by cvs2svn $
+ *  @date $Date: 2005-11-12 03:37:34 $
  *
  *  Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii
@@ -375 +375 @@
 char* p_psGetConfigFileName();
 
-/**
- *
- *
- *
+/** Searches the IERS time tables for a specified entry location.
+ *
+ *  Returns the interpolated double precision (arcsec) value at the specified entry
+ *  location.  Inputs to specify are the time index in mjd, the column number
+ *  corresponding to Xp, Yp, or Sp (UT1-UTC) in IERS A or B, the time table names,
+ *  and the number of time tables.
+ *
+ *  @return psF64:          Resulting table entry for specified parameters.
  */
 psF64 p_psTimeSearchTables(
-    psF64 index,                       ///<
-    psU64 column,                      ///<
-    char *metadataTableNames[],        ///<
-    psU32 nTables,                     ///<
-    psLookupStatusType* status         ///<
+    psF64 index,                       ///< time index for which to search
+    psU64 column,                      ///< column number of specified index
+    char *metadataTableNames[],        ///< names of IERS tables to search
+    psU32 nTables,                     ///< number of IERS tables to search
+    psLookupStatusType* status         ///< status of table search
 );