Changeset 5484

Timestamp:

Nov 7, 2005, 12:31:41 PM (21 years ago)

Author:

Paul Price

Message:

Added psMetadataCopy.

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.177 2005-11-04 19:04:32 price Exp $
+%%% $Id: ChangeLogSDRS.tex,v 1.178 2005-11-07 22:31:36 price Exp $
 
 \subsection{Changes from version 00 to version 01}
@@ -821 +821 @@
   The functionality will be handled by \code{psFitsWriteImage,
   psFitsWriteTable}.
-\end{itemize}
+\item Added \code{psMetadataCopy}.
+\end{itemize}

trunk/doc/pslib/psLibSDRS.tex

@@ -1 @@
-%%% $Id: psLibSDRS.tex,v 1.353 2005-11-04 19:04:36 price Exp $
+%%% $Id: psLibSDRS.tex,v 1.354 2005-11-07 22:31:41 price Exp $
 \documentclass[panstarrs,spec]{panstarrs}
 
@@ -2832 +2832 @@
 \end{prototype}
 
+There will be occasions when we want to perform a deep copy of a
+\code{psMetadata}, for example, to generate a new and independent FITS
+header.
+\begin{prototype}
+psMetadata *psMetadataCopy(psMetadata *out, const psMetadata *in);
+\end{prototype}
+\code{psMetadataCopy} shall create a new copy of all
+\code{psMetadataItem}s in the \code{in} metadata, and place them in
+the \code{out} metadata, or a new \code{psMetadata} if \code{out} is
+\code{NULL}.  Now, it is not feasible (at this time) to be able to
+copy every type that we might put on a \code{psMetadata}.  Therefore,
+\code{psMetadataCopy} shall copy only the numerical types and strings.
+Other pointer types may simply have the pointer copied (with the
+reference counter incremented appropriately), with the total number of
+such copies (if positive) reported in a warning at the end of the
+function.
+
 \subsubsection{Configuration files}
 \label{sec:configspec}