Changeset 4244

Timestamp:

Jun 13, 2005, 5:07:19 PM (21 years ago)

Author:

Paul Price

Message:

Changed some char* to psString to follow policy

Location:

trunk/doc/pslib

Files:

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

trunk/doc/pslib/ChangeLogSDRS.tex

@@ -1 @@
-%%% $Id: ChangeLogSDRS.tex,v 1.137 2005-06-14 02:19:36 price Exp $
+%%% $Id: ChangeLogSDRS.tex,v 1.138 2005-06-14 03:07:19 price Exp $
 
 \subsection{Changes from version 00 to version 01}
@@ -706 +706 @@
   include most psLib structures.  \code{PS_META_MULTI} changed to
   \code{PS_DATA_METADATA_MULTI}.
-\end{itemize}
+\item Changed some \code{char *} to \code{psString}, as appropriate.
+  Noted that metadata functions must copy strings in to a
+  \code{psMetadataItem}.
+\end{itemize}

trunk/doc/pslib/psLibSDRS.tex

@@ -1 @@
-%%% $Id: psLibSDRS.tex,v 1.276 2005-06-14 02:19:36 price Exp $
+%%% $Id: psLibSDRS.tex,v 1.277 2005-06-14 03:07:19 price Exp $
 \documentclass[panstarrs,spec]{panstarrs}
 
@@ -2024 +2024 @@
 psBitSet *psBitSetNot(psBitSet *outBitSet, const psBitSet *inBitSet);
 bool psBitSetTest(const psBitSet *bitSet, long bit);
-char *psBitSetToString(const psBitSet* bitSet);
+psString psBitSetToString(const psBitSet* bitSet);
 \end{prototype}
 
@@ -2168 +2168 @@
 typedef struct {
     const psS32 id;                     ///< unique ID for this item
-    char *name;                         ///< Name of item
+    psString name;                      ///< Name of item
     psDataType type;                    ///< type of this item
     const union {
@@ -2178 +2178 @@
         psPtr V;                        ///< other type
     } data;                             ///< value of metadata
-    char *comment;                      ///< optional comment ("", not NULL)
+    psString comment;                   ///< optional comment ("", not NULL)
 } psMetadataItem;
 \end{datatype}
@@ -2192 +2192 @@
 type of the data being represented, given by the enumerated type
 \code{psDataType}.
+
+Note that the \code{name} and \code{comment} must be allocated by the
+constructor using, e.g., \code{psStringCopy}.
 
 A collection of metadata is represented by the \code{psMetadata} structure:
@@ -2508 +2511 @@
 
 \begin{prototype}
-char *psMetadataConfigFormat(psMetadata *md);
+psString psMetadataConfigFormat(psMetadata *md);
 bool psMetadataConfigWrite(psMetadata *md, const char *filename);
 \end{prototype}
@@ -3183 +3186 @@
 psRegion psRegionSet(float x0, float x1, float y0, float y1);
 psRegion psRegionFromString(const char *region);
-char *psRegionToString(const psRegion region);
+psString psRegionToString(const psRegion region);
 \end{prototype}
 
@@ -3544 +3547 @@
 
 \begin{prototype}
-char *psFitsGetExtName(const psFits* fits);
+psString psFitsGetExtName(const psFits* fits);
 bool psFitsSetExtName(psFits* fits, const char* name);
 \end{prototype}
@@ -5510 +5513 @@
 double psTimeToJD(const psTime *time);
 double psTimeToMJD(const psTime *time);
-char *psTimeToISO(const psTime *time);
+psString psTimeToISO(const psTime *time);
 timeval *psTimeToTimeval(const psTime *time);
 \end{prototype}