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

Timestamp:

Oct 7, 2004, 10:21:29 AM (22 years ago)

Author:

eugene

Message:

mods to psMetadataType, psType, and psMetadataParseConfig

File:

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

trunk/doc/pslib/psLibSDRS.tex

@@ -1 @@
-%%% $Id: psLibSDRS.tex,v 1.129 2004-10-07 19:55:20 eugene Exp $
+%%% $Id: psLibSDRS.tex,v 1.130 2004-10-07 20:21:29 eugene Exp $
 \documentclass[panstarrs,spec]{panstarrs}
 
@@ -1232 +1232 @@
     PS_TYPE_C32,                        ///< Complex numbers consisting of floats
     PS_TYPE_C64,                        ///< Complex numbers consisting of doubles
-    PS_TYPE_STR,                        ///< String
-    PS_TYPE_BOOL,                       ///< Boolean
-    PS_TYPE_OTHER                       ///< Not supported for arithmetic
 } psElemType;
 \end{verbatim}
@@ -1259 +1256 @@
         psC64 C64;                      ///< double complex value entry
     } data;
-} p_psScalar;
+} psScalar;
 \end{verbatim}
 
@@ -3617 +3614 @@
         psF32 F32;                      ///< floating value
         psF64 F64;                      ///< double value
-        void *void;                     ///< other type
+        void *data;                     ///< other type
     } data;                             ///< value of metadata
     char *comment;                      ///< optional comment ("", not NULL)
@@ -3640 +3637 @@
     PS_META_F32,                        ///< float (.F32)
     PS_META_F64,                        ///< double (.F64)
-    PS_META_STR,                        ///< string (.void)
-    PS_META_IMG,                        ///< image (.void)
-    PS_META_JPEG,                       ///< JPEG (.void)
-    PS_META_PNG,                        ///< PNG (.void)
-    PS_META_ASTROM,                     ///< astrometric coefficients (.void)
-    PS_META_UNKNOWN,                    ///< other (.void)
+    PS_META_STR,                        ///< string (.data)
+    PS_META_MATH,                       ///< psScalar, psVector, psImage (.data)
+    PS_META_JPEG,                       ///< JPEG (.data)
+    PS_META_PNG,                        ///< PNG (.data)
+    PS_META_ASTROM,                     ///< astrometric coefficients (.data)
+    PS_META_UNKNOWN,                    ///< other (.data)
     PS_META_NTYPE                       ///< Number of types; must be last
 } psMetadataType;
@@ -3826 +3823 @@
 
 \begin{verbatim}
-int psMetadataParseConfig(psMetadata *md, const char *filename, bool overwrite);
+psMetadata *psMetadataParseConfig(psMetadata *md, int *nFail, const char *filename, bool overwrite);
 \end{verbatim}
 
@@ -3832 +3829 @@
 file, \code{filename}, \code{psMetadataParseConfig} shall parse the
 configuration file, placing the contained key/type/value/comment quads
-into the metadata, and returning the number of lines that failed to
-parse.  Multiple specifications of a key that haven't been declared
-(see below) are overwritten if and only if \code{overwrite} is
-\code{true}.
-
-If the metadata container is \code{NULL}, it shall be allocated.  If
-the file specified by \code{filename} is not readable, then the
-function shall generate an error and return \code{-1}.
+into the metadata, and returning a pointer to the metadata structure.
+The number of lines that failed to parse is returned in \code{nFail}.
+Multiple specifications of a key that haven't been declared (see
+below) are overwritten if and only if \code{overwrite} is \code{true}.
+If the metadata container is \code{NULL}, it shall be allocated.  
+
+On error, the function shall return \code{NULL}.
 
 The configuration file shall consist of plain text with
@@ -3893 +3889 @@
 by specifying the key at the start of the line (possibly preceded by
 whitespace) and specifying the type as a ``multiple symbol'', which we
-choose to be an asterisk, \code{*}.  Everything else on the line shall
-be ignored.  A warning shall be produced when a key which has not been
+choose to be an asterisk, \code{*}.  No other data may be provided on
+this line, though a comment, preceeded by the comment marker, is
+valid.  A warning shall be produced when a key which has not been
 specified to be non-unique is repeated; in this case, the former value
 shall be overwritten if \code{overwrite} is \code{true}, otherwise the
@@ -3904 +3901 @@
 (including those that were ignored because \code{overwrite} is
 \code{false}, and any other parsing problems, but not including blank
-lines and comment lines) shall be returned by the function.
+lines and comment lines) shall be returned by the function in the
+argument \code{nFail}.
 
 Here are some examples of lines of a valid configuration file:
@@ -3917 +3915 @@
 @primes U8  2,3 5 7,11,13 17 #   These are prime numbers
 
-comment * The rest of this line is ignored, but `comment' is set to be non-unique
+comment * # This is a comment in the ITEM_SET item
 comment STR This
 comment STR     is