Changeset 3930

Timestamp:

May 13, 2005, 12:07:26 PM (21 years ago)

Author:

Paul Price

Message:

Using psMetadataIterator to iterate through metadata, not psListIterator.

File:

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

trunk/doc/pslib/psLibSDRS.tex

@@ -1 @@
-%%% $Id: psLibSDRS.tex,v 1.215 2005-05-13 21:48:05 price Exp $
+%%% $Id: psLibSDRS.tex,v 1.216 2005-05-13 22:07:26 price Exp $
 \documentclass[panstarrs,spec]{panstarrs}
 
@@ -1374 +1374 @@
 \begin{verbatim}
 psVector *psVectorAlloc(int nalloc, psElemType type);
-psVector *psVectorRealloc(const psVector *vector, int nalloc);
+psVector *psVectorRealloc(psVector *vector, int nalloc);
 \end{verbatim}
 %
@@ -3996 +3996 @@
 
 The metadata list component may be iterated over by using a
-\code{psListIterator} in a fashion equivalent to the usage for
-\code{psList}.  The iterator may be set to a location in the
-\code{psMetadata} list, and the user may get the previous or next item
-in the list relative to that location.  \code{psMetadataGetNext} has
-the ability to match the key using a POSIX regex, e.g., if the user
-only wants to iterate through \code{IPP.machines.sky} and doesn't want
-to bother with \code{IPP.machines.detector}.  The iterator should
-iterate over every item in the metadata list, even those that are
-contained in a \code{PS_META_LIST}.  The value \code{iterator}
-specifies the iterator to be used.  In setting the iterator, the
-position of the iterator is defined by \code{location}, which follows
-the conventions of the \code{psList} iterators.
-\begin{verbatim}
-psListIterator *psMetadataIteratorAlloc(psMetadata *md, int location, const char *regex);
-bool psMetadataIteratorSet(psListIterator *iterator, int location);
-psMetadataItem *psMetadataGetAndIncrement(psListIterator *iterator);
-psMetadataItem *psMetadataGetAndDecrement(psListIterator *iterator);
+\code{psMetadataIterator} in a fashion equivalent to the
+\code{psListIterator}:
+\begin{verbatim}
+typedef struct {
+    psListIterator* iter;              ///< iterator for the psMetadata's psList
+    regex_t* regex;                     ///< the subsetting regular expression
+} psMetadataIterator;
+\end{verbatim}
+
+The iterator may be set to a location in the \code{psMetadata} list,
+and the user may get the previous or next item in the list relative to
+that location.  \code{psMetadataGetNext} has the ability to match the
+key using a POSIX \code{regex}, e.g., if the user only wants to
+iterate through \code{IPP.machines.sky} and doesn't want to bother
+with \code{IPP.machines.detector}.  The iterator should iterate over
+every item in the metadata list, even those that are contained in a
+\code{PS_META_LIST}.  The value \code{iterator} specifies the iterator
+to be used.  In setting the iterator, the position of the iterator is
+defined by \code{location}, which follows the conventions of the
+\code{psList} iterators.
+\begin{verbatim}
+psMetadataIterator *psMetadataIteratorAlloc(psMetadata *md, int location, const char *regex);
+bool psMetadataIteratorSet(psMetadataIterator *iterator, int location);
+psMetadataItem *psMetadataGetAndIncrement(psMetadataIterator *iterator);
+psMetadataItem *psMetadataGetAndDecrement(psMetadataIterator *iterator);
 \end{verbatim}