Changeset 4564

Timestamp:

Jul 15, 2005, 11:56:47 AM (21 years ago)

Author:

Paul Price

Message:

Adding general concept lookup functions.

File:

• trunk/doc/modules/ModulesSDRS.tex (modified) (2 diffs)

trunk/doc/modules/ModulesSDRS.tex

@@ -1 @@
-%%% $Id: ModulesSDRS.tex,v 1.47 2005-07-15 21:42:13 price Exp $
+%%% $Id: ModulesSDRS.tex,v 1.48 2005-07-15 21:56:47 price Exp $
 \documentclass[panstarrs]{panstarrs}
 
@@ -676 +676 @@
 \subsubsection{Lookups}
 
-We here specify a series of ``one-stop shops'' for lookups of the
-concepts.  These will be what the user utilises, so the goal is to
+We first specify a general concept lookup function, which shall return the
+appropriate \code{psMetadataItem} for the value of the given \code{concept}
+for the specified \code{cell}, \code{chip} or \code{fpa}:
+\begin{prototype}
+psMetadataItem *pmCellGetConcept(pmCell *cell, const char *concept);
+psMetadataItem *pmChipGetConcept(pmChip *chip, const char *concept);
+psMetadataItem *pmFPAGetConcept(pmFPA *fpa, const char *concept);
+\end{prototype}
+
+We next specify a series of specific functions for concept lookups.
+These will generally be what the user utilises, so the goal is to
 provide a simple interface providing a single type back, so the user
-doesn't have to go to the trouble of checking types, etc.
+doesn't have to go to the trouble of checking types, etc.  These
+functions should employ the above three general lookup functions and
+deal with the result appropriately.
 
 \begin{prototype}