Changeset 2194

Timestamp:

Oct 25, 2004, 11:41:40 AM (22 years ago)

Author:

Paul Price

Message:

psTimeMath replaces psTime{Add,Subtract}. Specified that time
differences are SI --- not including leap seconds.

Location:

trunk/doc/pslib

Files:

• ChangeLogSDRS.tex (modified) (2 diffs)
• psLibSDRS.tex (modified) (2 diffs)

trunk/doc/pslib/ChangeLogSDRS.tex

@@ -1 @@
-%%% $Id: ChangeLogSDRS.tex,v 1.39 2004-10-25 20:59:03 price Exp $
+%%% $Id: ChangeLogSDRS.tex,v 1.40 2004-10-25 21:41:35 price Exp $
 
 \subsection{Changes from version 00 to version 01}
@@ -354 +354 @@
 \item Added \code{psLookupTable} section, and removed
   \code{psTimeTableInterpolate} (now redundant).
-\item Inputs to \code{psTimeAdd}, \code{psTimeSubtract},
-  \code{psTimeDelta} no longer need to be TAI --- the functions will
-  convert as required.  API and requirement changes.
+\item \code{psTimeAdd} and \code{psTimeSubtract} merged to
+  \code{psTimeMath}.  Specified that time differences are expressed in
+  SI seconds (i.e., not including leap seconds).  Inputs to
+  \code{psTimeMath} and \code{psTimeDelta} no longer need to be TAI
+  --- the functions will convert from and to UTC as required.
 \end{itemize}

trunk/doc/pslib/psLibSDRS.tex

@@ -1 @@
-%%% $Id: psLibSDRS.tex,v 1.143 2004-10-25 20:59:03 price Exp $
+%%% $Id: psLibSDRS.tex,v 1.144 2004-10-25 21:41:40 price Exp $
 \documentclass[panstarrs,spec]{panstarrs}
 
@@ -3443 +3443 @@
 
 \begin{verbatim}
-psTime *psTimeAdd(const psTime *time, psF64 delta);
-psF64 psTimeSubtract(const psTime *time, psF64 delta);
+psTime *psTimeMath(const psTime *time, psF64 delta);
 psF64 psTimeDelta(const psTime *time1, const psTime *time2);
 \end{verbatim}
-\code{psTimeAdd} adds some time to a \code{psTime}.
-\code{psTimeSubtract} subtracts two times.  \code{psTimeDelta} gives
+\code{psTimeMath} adds the \code{delta} (in seconds; may be negative)
+to a \code{psTime}.  \code{psTimeDelta} gives
 the difference between times \code{time1} and \code{time2} (which may
 be negative).
 
+Note that in both these, the difference between two times is to be
+expressed in \textit{SI} seconds, and not inclusive of leap seconds.
+For example, if we add 30 seconds to 1998-12-31T23:59:45Z, the result
+is 1999-01-01T00:00:14Z, since a leap second was introduced at
+1999-01-01T00:00:00Z.
+
 Time math may only be done on the \code{psTime} TAI type, and so the
 functions shall internally convert the \code{psTime} inputs to TAI
-before performing the math.  The type of the time returned by
-\code{psTimeAdd} and \code{psTimeSubtract} shall be the same as that
-of the input \code{time}.
+before performing the math; this is in order that leap seconds are
+accounted for.
+
+The type of the time returned by \code{psTimeMath} shall be the same
+as that of the input \code{time}.
+
 
 \subsubsection{Time Tables}