Changeset 9788 for trunk/ippdb/src/ippdb.h

Timestamp:

Oct 30, 2006, 11:55:36 AM (20 years ago)

Author:

jhoblitt

Message:

VERSION 0.0.53

File:

• trunk/ippdb/src/ippdb.h (modified) (7 diffs)

trunk/ippdb/src/ippdb.h

@@ -2985 +2985 @@
     psS32           p2_version;
     psS32           p3_version;
+    char            *label;
 } p3PendingExpRow;
 
@@ -2995 +2996 @@
     const char      *exp_tag,
     psS32           p2_version,
-    psS32           p3_version
+    psS32           p3_version,
+    const char      *label
 );
 
@@ -3027 +3029 @@
     const char      *exp_tag,
     psS32           p2_version,
-    psS32           p3_version
+    psS32           p3_version,
+    const char      *label
 );
 
@@ -3185 +3188 @@
     psS32           p2_version;
     psS32           p3_version;
+    char            *label;
 } p3ProcessedExpRow;
 
@@ -3207 +3211 @@
     psF32           zp_stdev,
     psS32           p2_version,
-    psS32           p3_version
+    psS32           p3_version,
+    const char      *label
 );
 
@@ -3251 +3256 @@
     psF32           zp_stdev,
     psS32           p2_version,
-    psS32           p3_version
+    psS32           p3_version,
+    const char      *label
 );
 
@@ -3386 +3392 @@
     FILE            *stream,            ///< a stream
     psArray         *objects,           ///< An array of p3ProcessedExpRow objects
+    bool            mdcf                ///< format as mdconfig or simple
+);
+/** p3MaskRow data structure
+ *
+ * Structure for representing a single row of p3Mask table data.
+ */
+
+typedef struct {
+    char            *label;
+} p3MaskRow;
+
+/** Creates a new p3MaskRow object
+ *
+ *  @return A new p3MaskRow object or NULL on failure.
+ */
+
+p3MaskRow *p3MaskRowAlloc(
+    const char      *label
+);
+
+/** Creates a new p3Mask table
+ *
+ * @return true on success
+ */
+
+bool p3MaskCreateTable(
+    psDB            *dbh                ///< Database handle
+);
+
+/** Deletes a p3Mask table
+ *
+ * @return true on success
+ */
+
+bool p3MaskDropTable(
+    psDB            *dbh                ///< Database handle
+);
+
+/** Insert a single row into a table
+ *
+ * This function constructs and inserts a single row based on it's parameters.
+ *
+ * @return true on success
+ */
+
+bool p3MaskInsert(
+    psDB            *dbh,               ///< Database handle
+    const char      *label
+);
+
+/** Deletes up to limit rows from the database and returns the number of rows actually deleted. 
+ *
+ * @return A The number of rows removed or a negative value on error
+ */
+
+long long p3MaskDelete(
+    psDB            *dbh,               ///< Database handle
+    const psMetadata *where,            ///< Row match criteria
+    unsigned long long limit            ///< Maximum number of elements to delete 
+);
+
+/** Insert a single p3MaskRow object into a table
+ *
+ * This function constructs and inserts a single row based on it's parameters.
+ *
+ * @return true on success
+ */
+
+bool p3MaskInsertObject(
+    psDB            *dbh,               ///< Database handle
+    p3MaskRow       *object             ///< p3MaskRow object
+);
+
+/** Insert an array of p3MaskRow object into a table
+ *
+ * This function constructs and inserts multiple rows based on it's parameters.
+ *
+ * @return true on success
+ */
+
+bool p3MaskInsertObjects(
+    psDB            *dbh,               ///< Database handle
+    psArray         *objects            ///< array of p3MaskRow objects
+);
+
+/** Insert data from a binary FITS table p3MaskRow into the database
+ *
+ * This function expects a psFits object with a FITS table as the first
+ * extension.  The table must have at least one row of data in it, that is of
+ * the appropriate format (number of columns and their type).  All other
+ * extensions are ignored.
+ *
+ * @return true on success
+ */
+
+bool p3MaskInsertFits(
+    psDB            *dbh,               ///< Database handle
+    const psFits    *fits               ///< psFits object
+);
+
+/** Selects up to limit from the database and returns them in a binary FITS table
+ *
+ * This function assumes an empty psFits object and will create a FITS table
+ * as the first extension.
+ *
+ *  See psDBSelectRows() for documentation on the format of where.
+ *
+ * @return true on success
+ */
+
+bool p3MaskSelectRowsFits(
+    psDB            *dbh,               ///< Database handle
+    psFits          *fits,              ///< psFits object
+    const psMetadata *where,            ///< Row match criteria
+    unsigned long long limit            ///< Maximum number of elements to return
+);
+
+/** Convert a p3MaskRow into an equivalent psMetadata
+ *
+ * @return A psMetadata pointer or NULL on error
+ */
+
+psMetadata *p3MaskMetadataFromObject(
+    const p3MaskRow *object             ///< fooRow to convert into a psMetadata
+);
+
+/** Convert a psMetadata into an equivalent fooRow
+ *
+ * @return A p3MaskRow pointer or NULL on error
+ */
+
+p3MaskRow *p3MaskObjectFromMetadata(
+    psMetadata      *md                 ///< psMetadata to convert into a fooRow
+);
+/** Selects up to limit rows from the database and returns as p3MaskRow objects in a psArray
+ *
+ *  See psDBSelectRows() for documentation on the format of where.
+ *
+ * @return A psArray pointer or NULL on error
+ */
+
+psArray *p3MaskSelectRowObjects(
+    psDB            *dbh,               ///< Database handle
+    const psMetadata *where,            ///< Row match criteria
+    unsigned long long limit            ///< Maximum number of elements to return
+);
+/** Deletes a row from the database coresponding to an p3Mask
+ *
+ *  Note that a 'where' search psMetadata is constructed from each object and
+ *  used to find rows to delete.
+ *
+ * @return A The number of rows removed or a negative value on error
+ */
+
+bool p3MaskDeleteObject(
+    psDB            *dbh,               ///< Database handle
+    const p3MaskRow *object    ///< Object to delete
+);
+/** Deletes up to limit rows from the database and returns the number of rows actually deleted. 
+ *
+ *  Note that a 'where' search psMetadata is constructed from each object and
+ *  used to find rows to delete.
+ *
+ * @return A The number of rows removed or a negative value on error
+ */
+
+long long p3MaskDeleteRowObjects(
+    psDB            *dbh,               ///< Database handle
+    const psArray   *objects,           ///< Array of objects to delete
+    unsigned long long limit            ///< Maximum number of elements to delete 
+);
+/** Formats and prints an array of p3MaskRow objects
+ *
+ * When mdcf is set the formated output is in psMetadataConfig
+ * format, otherwise it is in a simple tabular format.
+ *
+ * @return true on success
+ */
+
+bool p3MaskPrintObjects(
+    FILE            *stream,            ///< a stream
+    psArray         *objects,           ///< An array of p3MaskRow objects
     bool            mdcf                ///< format as mdconfig or simple
 );