Changeset 4536 for trunk/doc/pslib/psLibSDRS.tex

Timestamp:

Jul 11, 2005, 12:54:39 PM (21 years ago)

Author:

eugene

Message:

psTimetoLMST, psImageCut, C++

File:

• trunk/doc/pslib/psLibSDRS.tex (modified) (7 diffs)

trunk/doc/pslib/psLibSDRS.tex

@@ -1 @@
-%%% $Id: psLibSDRS.tex,v 1.314 2005-07-11 21:49:58 jhoblitt Exp $
+%%% $Id: psLibSDRS.tex,v 1.315 2005-07-11 22:54:39 eugene Exp $
 \documentclass[panstarrs,spec]{panstarrs}
 
@@ -200 +200 @@
 convenience to the user.
 
+\subsection{C++ Compatibility}
+
+All PSLib ``public'' header files should comptable with \code{C++}.
+This primarily involves using \code{C} pre-processor directives to
+enable \code{C++}'s \code{extern "C"} linkage specification when a
+header file is being processed as part of a \code{C++} compilation.
+
+An example of wrapping a header file with an \code{extern "C"} block:
+
+\begin{verbatim}
+#ifndef FOO_H
+#define FOO_H 1
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+...
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif // FOO_H
+\end{verbatim}
+
+Other coding cautions include avoiding trailing commas in
+\code{enum}s, protection of the poison \code{pragma}s used for the
+memory system (below), and avoiding the qualifier \code{restrict}.
+
 \subsection{Use of {\tt restrict}}
 
@@ -214 +244 @@
 of \code{restrict} should be kept to a minimum; it should only be
 employed where necessary, and where the assumption will hold.
+Restricts should also be avoided because they are incompatible with
+\code{C++}.
 
 \subsection{Return values}
@@ -2271 +2303 @@
     const union {
         psBool B;                       ///< boolean value
+        psS8  S8;                       ///< integer data
+        psS16 S16;                      ///< integer data
         psS32 S32;                      ///< integer data
+        psU8  U8;                       ///< integer data
+        psU16 U16;                      ///< integer data
+        psU32 U32;                      ///< integer data
         psF32 F32;                      ///< floating-point data
         psF64 F64;                      ///< double-precision data
@@ -2285 +2322 @@
 experience shows that such tags are useful.  The entry \code{name}
 specifies the name of the metadata item.  The value of the metadata is
-given by the union \code{data}, and may be of type \code{psS32},
+given by the union \code{data}, and may be of type \code{psU8},
+\code{psU16}, \code{psU32}, \code{psS8}, \code{psS16}, \code{psS32},
 \code{psF32}, \code{psF64}, or an arbitrary rich structure pointed at
 by the \code{void} pointer \code{V}.  A character string comment
@@ -4795 +4833 @@
 \begin{prototype}
 psVector *psImageCut(psVector *out, 
-                     psVector *coords, 
+                     psVector *cutCols, 
+                     psVector *cutRows, 
                      const psImage *input, 
                      const psImage *mask, 
@@ -5717 +5756 @@
 
 The function may accept any of the \code{psTimeType} types with
-\emph{SI} length seconds.  The \code{time} is modified and returned.
-Note that this function requires the value $UT1-UTC$ (see
-\code{psTimeGetUT1Delta()}) and should use the UT1 values interpolated
-from IERS bulletin B.  
+\emph{SI} length seconds.  The \code{time} is modified (rationlized to
+TAI units) and returned.  Note that this function requires the value
+$UT1-UTC$ (see \code{psTimeGetUT1Delta()}) and should use the UT1
+values interpolated from IERS bulletin B.
 
 The following utility function encapsulates the PSLib mechanism to