Index: trunk/ippdb/src/ippdb.h =================================================================== --- trunk/ippdb/src/ippdb.h (revision 12426) +++ trunk/ippdb/src/ippdb.h (revision 12535) @@ -20,5 +20,5 @@ /* * - * This file was generated by glueforge 1.00 + * This file was generated by glueforge 1.01 * * Do NOT directly edit this file. @@ -4404,4 +4404,2077 @@ FILE *stream, ///< a stream camMaskRow *object, ///< an camMaskRow object + bool mdcf ///< format as mdconfig or simple +); +/** warpRunRow data structure + * + * Structure for representing a single row of warpRun table data. + */ + +typedef struct { + psS64 warp_id; + char *mode; + char *state; + char *workdir; + char *dvodb; + psTime* registered; +} warpRunRow; + +/** Creates a new warpRunRow object + * + * @return A new warpRunRow object or NULL on failure. + */ + +warpRunRow *warpRunRowAlloc( + psS64 warp_id, + const char *mode, + const char *state, + const char *workdir, + const char *dvodb, + psTime* registered +); + +/** Creates a new warpRun table + * + * @return true on success + */ + +bool warpRunCreateTable( + psDB *dbh ///< Database handle +); + +/** Deletes a warpRun table + * + * @return true on success + */ + +bool warpRunDropTable( + 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 warpRunInsert( + psDB *dbh, ///< Database handle + psS64 warp_id, + const char *mode, + const char *state, + const char *workdir, + const char *dvodb, + psTime* registered +); + +/** 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 warpRunDelete( + psDB *dbh, ///< Database handle + const psMetadata *where, ///< Row match criteria + unsigned long long limit ///< Maximum number of elements to delete +); + +/** Insert a single warpRunRow object into a table + * + * This function constructs and inserts a single row based on it's parameters. + * + * @return true on success + */ + +bool warpRunInsertObject( + psDB *dbh, ///< Database handle + warpRunRow *object ///< warpRunRow object +); + +/** Insert an array of warpRunRow object into a table + * + * This function constructs and inserts multiple rows based on it's parameters. + * + * @return true on success + */ + +bool warpRunInsertObjects( + psDB *dbh, ///< Database handle + psArray *objects ///< array of warpRunRow objects +); + +/** Insert data from a binary FITS table warpRunRow 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 warpRunInsertFits( + 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 warpRunSelectRowsFits( + 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 warpRunRow into an equivalent psMetadata + * + * @return A psMetadata pointer or NULL on error + */ + +psMetadata *warpRunMetadataFromObject( + const warpRunRow *object ///< fooRow to convert into a psMetadata +); + +/** Convert a psMetadata into an equivalent fooRow + * + * @return A warpRunRow pointer or NULL on error + */ + +warpRunRow *warpRunObjectFromMetadata( + psMetadata *md ///< psMetadata to convert into a fooRow +); +/** Selects up to limit rows from the database and returns as warpRunRow objects in a psArray + * + * See psDBSelectRows() for documentation on the format of where. + * + * @return A psArray pointer or NULL on error + */ + +psArray *warpRunSelectRowObjects( + 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 warpRun + * + * 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 warpRunDeleteObject( + psDB *dbh, ///< Database handle + const warpRunRow *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 warpRunDeleteRowObjects( + 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 warpRunRow 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 warpRunPrintObjects( + FILE *stream, ///< a stream + psArray *objects, ///< An array of warpRunRow objects + bool mdcf ///< format as mdconfig or simple +); +/** Formats and prints an warpRunRow object + * + * When mdcf is set the formated output is in psMetadataConfig + * format, otherwise it is in a simple tabular format. + * + * @return true on success + */ + +bool warpRunPrintObject( + FILE *stream, ///< a stream + warpRunRow *object, ///< an warpRunRow object + bool mdcf ///< format as mdconfig or simple +); +/** warpInputExpRow data structure + * + * Structure for representing a single row of warpInputExp table data. + */ + +typedef struct { + psS64 warp_id; + psS64 cam_id; + bool magiced; +} warpInputExpRow; + +/** Creates a new warpInputExpRow object + * + * @return A new warpInputExpRow object or NULL on failure. + */ + +warpInputExpRow *warpInputExpRowAlloc( + psS64 warp_id, + psS64 cam_id, + bool magiced +); + +/** Creates a new warpInputExp table + * + * @return true on success + */ + +bool warpInputExpCreateTable( + psDB *dbh ///< Database handle +); + +/** Deletes a warpInputExp table + * + * @return true on success + */ + +bool warpInputExpDropTable( + 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 warpInputExpInsert( + psDB *dbh, ///< Database handle + psS64 warp_id, + psS64 cam_id, + bool magiced +); + +/** 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 warpInputExpDelete( + psDB *dbh, ///< Database handle + const psMetadata *where, ///< Row match criteria + unsigned long long limit ///< Maximum number of elements to delete +); + +/** Insert a single warpInputExpRow object into a table + * + * This function constructs and inserts a single row based on it's parameters. + * + * @return true on success + */ + +bool warpInputExpInsertObject( + psDB *dbh, ///< Database handle + warpInputExpRow *object ///< warpInputExpRow object +); + +/** Insert an array of warpInputExpRow object into a table + * + * This function constructs and inserts multiple rows based on it's parameters. + * + * @return true on success + */ + +bool warpInputExpInsertObjects( + psDB *dbh, ///< Database handle + psArray *objects ///< array of warpInputExpRow objects +); + +/** Insert data from a binary FITS table warpInputExpRow 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 warpInputExpInsertFits( + 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 warpInputExpSelectRowsFits( + 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 warpInputExpRow into an equivalent psMetadata + * + * @return A psMetadata pointer or NULL on error + */ + +psMetadata *warpInputExpMetadataFromObject( + const warpInputExpRow *object ///< fooRow to convert into a psMetadata +); + +/** Convert a psMetadata into an equivalent fooRow + * + * @return A warpInputExpRow pointer or NULL on error + */ + +warpInputExpRow *warpInputExpObjectFromMetadata( + psMetadata *md ///< psMetadata to convert into a fooRow +); +/** Selects up to limit rows from the database and returns as warpInputExpRow objects in a psArray + * + * See psDBSelectRows() for documentation on the format of where. + * + * @return A psArray pointer or NULL on error + */ + +psArray *warpInputExpSelectRowObjects( + 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 warpInputExp + * + * 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 warpInputExpDeleteObject( + psDB *dbh, ///< Database handle + const warpInputExpRow *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 warpInputExpDeleteRowObjects( + 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 warpInputExpRow 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 warpInputExpPrintObjects( + FILE *stream, ///< a stream + psArray *objects, ///< An array of warpInputExpRow objects + bool mdcf ///< format as mdconfig or simple +); +/** Formats and prints an warpInputExpRow object + * + * When mdcf is set the formated output is in psMetadataConfig + * format, otherwise it is in a simple tabular format. + * + * @return true on success + */ + +bool warpInputExpPrintObject( + FILE *stream, ///< a stream + warpInputExpRow *object, ///< an warpInputExpRow object + bool mdcf ///< format as mdconfig or simple +); +/** warpSkyCellMapRow data structure + * + * Structure for representing a single row of warpSkyCellMap table data. + */ + +typedef struct { + psS64 warp_id; + char *skycell_id; + char *tess_id; + psS64 cam_id; + char *class_id; + psS16 fault; +} warpSkyCellMapRow; + +/** Creates a new warpSkyCellMapRow object + * + * @return A new warpSkyCellMapRow object or NULL on failure. + */ + +warpSkyCellMapRow *warpSkyCellMapRowAlloc( + psS64 warp_id, + const char *skycell_id, + const char *tess_id, + psS64 cam_id, + const char *class_id, + psS16 fault +); + +/** Creates a new warpSkyCellMap table + * + * @return true on success + */ + +bool warpSkyCellMapCreateTable( + psDB *dbh ///< Database handle +); + +/** Deletes a warpSkyCellMap table + * + * @return true on success + */ + +bool warpSkyCellMapDropTable( + 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 warpSkyCellMapInsert( + psDB *dbh, ///< Database handle + psS64 warp_id, + const char *skycell_id, + const char *tess_id, + psS64 cam_id, + const char *class_id, + psS16 fault +); + +/** 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 warpSkyCellMapDelete( + psDB *dbh, ///< Database handle + const psMetadata *where, ///< Row match criteria + unsigned long long limit ///< Maximum number of elements to delete +); + +/** Insert a single warpSkyCellMapRow object into a table + * + * This function constructs and inserts a single row based on it's parameters. + * + * @return true on success + */ + +bool warpSkyCellMapInsertObject( + psDB *dbh, ///< Database handle + warpSkyCellMapRow *object ///< warpSkyCellMapRow object +); + +/** Insert an array of warpSkyCellMapRow object into a table + * + * This function constructs and inserts multiple rows based on it's parameters. + * + * @return true on success + */ + +bool warpSkyCellMapInsertObjects( + psDB *dbh, ///< Database handle + psArray *objects ///< array of warpSkyCellMapRow objects +); + +/** Insert data from a binary FITS table warpSkyCellMapRow 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 warpSkyCellMapInsertFits( + 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 warpSkyCellMapSelectRowsFits( + 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 warpSkyCellMapRow into an equivalent psMetadata + * + * @return A psMetadata pointer or NULL on error + */ + +psMetadata *warpSkyCellMapMetadataFromObject( + const warpSkyCellMapRow *object ///< fooRow to convert into a psMetadata +); + +/** Convert a psMetadata into an equivalent fooRow + * + * @return A warpSkyCellMapRow pointer or NULL on error + */ + +warpSkyCellMapRow *warpSkyCellMapObjectFromMetadata( + psMetadata *md ///< psMetadata to convert into a fooRow +); +/** Selects up to limit rows from the database and returns as warpSkyCellMapRow objects in a psArray + * + * See psDBSelectRows() for documentation on the format of where. + * + * @return A psArray pointer or NULL on error + */ + +psArray *warpSkyCellMapSelectRowObjects( + 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 warpSkyCellMap + * + * 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 warpSkyCellMapDeleteObject( + psDB *dbh, ///< Database handle + const warpSkyCellMapRow *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 warpSkyCellMapDeleteRowObjects( + 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 warpSkyCellMapRow 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 warpSkyCellMapPrintObjects( + FILE *stream, ///< a stream + psArray *objects, ///< An array of warpSkyCellMapRow objects + bool mdcf ///< format as mdconfig or simple +); +/** Formats and prints an warpSkyCellMapRow object + * + * When mdcf is set the formated output is in psMetadataConfig + * format, otherwise it is in a simple tabular format. + * + * @return true on success + */ + +bool warpSkyCellMapPrintObject( + FILE *stream, ///< a stream + warpSkyCellMapRow *object, ///< an warpSkyCellMapRow object + bool mdcf ///< format as mdconfig or simple +); +/** warpSkyfileRow data structure + * + * Structure for representing a single row of warpSkyfile table data. + */ + +typedef struct { + psS64 warp_id; + char *skycell_id; + char *tess_id; + char *uri; + psF64 bg; + psF64 bg_stdev; +} warpSkyfileRow; + +/** Creates a new warpSkyfileRow object + * + * @return A new warpSkyfileRow object or NULL on failure. + */ + +warpSkyfileRow *warpSkyfileRowAlloc( + psS64 warp_id, + const char *skycell_id, + const char *tess_id, + const char *uri, + psF64 bg, + psF64 bg_stdev +); + +/** Creates a new warpSkyfile table + * + * @return true on success + */ + +bool warpSkyfileCreateTable( + psDB *dbh ///< Database handle +); + +/** Deletes a warpSkyfile table + * + * @return true on success + */ + +bool warpSkyfileDropTable( + 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 warpSkyfileInsert( + psDB *dbh, ///< Database handle + psS64 warp_id, + const char *skycell_id, + const char *tess_id, + const char *uri, + psF64 bg, + psF64 bg_stdev +); + +/** 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 warpSkyfileDelete( + psDB *dbh, ///< Database handle + const psMetadata *where, ///< Row match criteria + unsigned long long limit ///< Maximum number of elements to delete +); + +/** Insert a single warpSkyfileRow object into a table + * + * This function constructs and inserts a single row based on it's parameters. + * + * @return true on success + */ + +bool warpSkyfileInsertObject( + psDB *dbh, ///< Database handle + warpSkyfileRow *object ///< warpSkyfileRow object +); + +/** Insert an array of warpSkyfileRow object into a table + * + * This function constructs and inserts multiple rows based on it's parameters. + * + * @return true on success + */ + +bool warpSkyfileInsertObjects( + psDB *dbh, ///< Database handle + psArray *objects ///< array of warpSkyfileRow objects +); + +/** Insert data from a binary FITS table warpSkyfileRow 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 warpSkyfileInsertFits( + 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 warpSkyfileSelectRowsFits( + 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 warpSkyfileRow into an equivalent psMetadata + * + * @return A psMetadata pointer or NULL on error + */ + +psMetadata *warpSkyfileMetadataFromObject( + const warpSkyfileRow *object ///< fooRow to convert into a psMetadata +); + +/** Convert a psMetadata into an equivalent fooRow + * + * @return A warpSkyfileRow pointer or NULL on error + */ + +warpSkyfileRow *warpSkyfileObjectFromMetadata( + psMetadata *md ///< psMetadata to convert into a fooRow +); +/** Selects up to limit rows from the database and returns as warpSkyfileRow objects in a psArray + * + * See psDBSelectRows() for documentation on the format of where. + * + * @return A psArray pointer or NULL on error + */ + +psArray *warpSkyfileSelectRowObjects( + 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 warpSkyfile + * + * 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 warpSkyfileDeleteObject( + psDB *dbh, ///< Database handle + const warpSkyfileRow *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 warpSkyfileDeleteRowObjects( + 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 warpSkyfileRow 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 warpSkyfilePrintObjects( + FILE *stream, ///< a stream + psArray *objects, ///< An array of warpSkyfileRow objects + bool mdcf ///< format as mdconfig or simple +); +/** Formats and prints an warpSkyfileRow object + * + * When mdcf is set the formated output is in psMetadataConfig + * format, otherwise it is in a simple tabular format. + * + * @return true on success + */ + +bool warpSkyfilePrintObject( + FILE *stream, ///< a stream + warpSkyfileRow *object, ///< an warpSkyfileRow object + bool mdcf ///< format as mdconfig or simple +); +/** diffRunRow data structure + * + * Structure for representing a single row of diffRun table data. + */ + +typedef struct { + psS64 diff_id; + char *state; + char *workdir; + char *dvodb; + psTime* registered; + char *skycell_id; + char *tess_id; +} diffRunRow; + +/** Creates a new diffRunRow object + * + * @return A new diffRunRow object or NULL on failure. + */ + +diffRunRow *diffRunRowAlloc( + psS64 diff_id, + const char *state, + const char *workdir, + const char *dvodb, + psTime* registered, + const char *skycell_id, + const char *tess_id +); + +/** Creates a new diffRun table + * + * @return true on success + */ + +bool diffRunCreateTable( + psDB *dbh ///< Database handle +); + +/** Deletes a diffRun table + * + * @return true on success + */ + +bool diffRunDropTable( + 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 diffRunInsert( + psDB *dbh, ///< Database handle + psS64 diff_id, + const char *state, + const char *workdir, + const char *dvodb, + psTime* registered, + const char *skycell_id, + const char *tess_id +); + +/** 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 diffRunDelete( + psDB *dbh, ///< Database handle + const psMetadata *where, ///< Row match criteria + unsigned long long limit ///< Maximum number of elements to delete +); + +/** Insert a single diffRunRow object into a table + * + * This function constructs and inserts a single row based on it's parameters. + * + * @return true on success + */ + +bool diffRunInsertObject( + psDB *dbh, ///< Database handle + diffRunRow *object ///< diffRunRow object +); + +/** Insert an array of diffRunRow object into a table + * + * This function constructs and inserts multiple rows based on it's parameters. + * + * @return true on success + */ + +bool diffRunInsertObjects( + psDB *dbh, ///< Database handle + psArray *objects ///< array of diffRunRow objects +); + +/** Insert data from a binary FITS table diffRunRow 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 diffRunInsertFits( + 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 diffRunSelectRowsFits( + 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 diffRunRow into an equivalent psMetadata + * + * @return A psMetadata pointer or NULL on error + */ + +psMetadata *diffRunMetadataFromObject( + const diffRunRow *object ///< fooRow to convert into a psMetadata +); + +/** Convert a psMetadata into an equivalent fooRow + * + * @return A diffRunRow pointer or NULL on error + */ + +diffRunRow *diffRunObjectFromMetadata( + psMetadata *md ///< psMetadata to convert into a fooRow +); +/** Selects up to limit rows from the database and returns as diffRunRow objects in a psArray + * + * See psDBSelectRows() for documentation on the format of where. + * + * @return A psArray pointer or NULL on error + */ + +psArray *diffRunSelectRowObjects( + 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 diffRun + * + * 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 diffRunDeleteObject( + psDB *dbh, ///< Database handle + const diffRunRow *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 diffRunDeleteRowObjects( + 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 diffRunRow 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 diffRunPrintObjects( + FILE *stream, ///< a stream + psArray *objects, ///< An array of diffRunRow objects + bool mdcf ///< format as mdconfig or simple +); +/** Formats and prints an diffRunRow object + * + * When mdcf is set the formated output is in psMetadataConfig + * format, otherwise it is in a simple tabular format. + * + * @return true on success + */ + +bool diffRunPrintObject( + FILE *stream, ///< a stream + diffRunRow *object, ///< an diffRunRow object + bool mdcf ///< format as mdconfig or simple +); +/** diffInputSkyfileRow data structure + * + * Structure for representing a single row of diffInputSkyfile table data. + */ + +typedef struct { + psS64 diff_id; + psS64 warp_id; + char *skycell_id; + char *tess_id; + char *kind; + bool template; +} diffInputSkyfileRow; + +/** Creates a new diffInputSkyfileRow object + * + * @return A new diffInputSkyfileRow object or NULL on failure. + */ + +diffInputSkyfileRow *diffInputSkyfileRowAlloc( + psS64 diff_id, + psS64 warp_id, + const char *skycell_id, + const char *tess_id, + const char *kind, + bool template +); + +/** Creates a new diffInputSkyfile table + * + * @return true on success + */ + +bool diffInputSkyfileCreateTable( + psDB *dbh ///< Database handle +); + +/** Deletes a diffInputSkyfile table + * + * @return true on success + */ + +bool diffInputSkyfileDropTable( + 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 diffInputSkyfileInsert( + psDB *dbh, ///< Database handle + psS64 diff_id, + psS64 warp_id, + const char *skycell_id, + const char *tess_id, + const char *kind, + bool template +); + +/** 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 diffInputSkyfileDelete( + psDB *dbh, ///< Database handle + const psMetadata *where, ///< Row match criteria + unsigned long long limit ///< Maximum number of elements to delete +); + +/** Insert a single diffInputSkyfileRow object into a table + * + * This function constructs and inserts a single row based on it's parameters. + * + * @return true on success + */ + +bool diffInputSkyfileInsertObject( + psDB *dbh, ///< Database handle + diffInputSkyfileRow *object ///< diffInputSkyfileRow object +); + +/** Insert an array of diffInputSkyfileRow object into a table + * + * This function constructs and inserts multiple rows based on it's parameters. + * + * @return true on success + */ + +bool diffInputSkyfileInsertObjects( + psDB *dbh, ///< Database handle + psArray *objects ///< array of diffInputSkyfileRow objects +); + +/** Insert data from a binary FITS table diffInputSkyfileRow 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 diffInputSkyfileInsertFits( + 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 diffInputSkyfileSelectRowsFits( + 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 diffInputSkyfileRow into an equivalent psMetadata + * + * @return A psMetadata pointer or NULL on error + */ + +psMetadata *diffInputSkyfileMetadataFromObject( + const diffInputSkyfileRow *object ///< fooRow to convert into a psMetadata +); + +/** Convert a psMetadata into an equivalent fooRow + * + * @return A diffInputSkyfileRow pointer or NULL on error + */ + +diffInputSkyfileRow *diffInputSkyfileObjectFromMetadata( + psMetadata *md ///< psMetadata to convert into a fooRow +); +/** Selects up to limit rows from the database and returns as diffInputSkyfileRow objects in a psArray + * + * See psDBSelectRows() for documentation on the format of where. + * + * @return A psArray pointer or NULL on error + */ + +psArray *diffInputSkyfileSelectRowObjects( + 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 diffInputSkyfile + * + * 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 diffInputSkyfileDeleteObject( + psDB *dbh, ///< Database handle + const diffInputSkyfileRow *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 diffInputSkyfileDeleteRowObjects( + 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 diffInputSkyfileRow 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 diffInputSkyfilePrintObjects( + FILE *stream, ///< a stream + psArray *objects, ///< An array of diffInputSkyfileRow objects + bool mdcf ///< format as mdconfig or simple +); +/** Formats and prints an diffInputSkyfileRow object + * + * When mdcf is set the formated output is in psMetadataConfig + * format, otherwise it is in a simple tabular format. + * + * @return true on success + */ + +bool diffInputSkyfilePrintObject( + FILE *stream, ///< a stream + diffInputSkyfileRow *object, ///< an diffInputSkyfileRow object + bool mdcf ///< format as mdconfig or simple +); +/** diffSkyfileRow data structure + * + * Structure for representing a single row of diffSkyfile table data. + */ + +typedef struct { + psS64 diff_id; + char *uri; + psF64 bg; + psF64 bg_stdev; +} diffSkyfileRow; + +/** Creates a new diffSkyfileRow object + * + * @return A new diffSkyfileRow object or NULL on failure. + */ + +diffSkyfileRow *diffSkyfileRowAlloc( + psS64 diff_id, + const char *uri, + psF64 bg, + psF64 bg_stdev +); + +/** Creates a new diffSkyfile table + * + * @return true on success + */ + +bool diffSkyfileCreateTable( + psDB *dbh ///< Database handle +); + +/** Deletes a diffSkyfile table + * + * @return true on success + */ + +bool diffSkyfileDropTable( + 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 diffSkyfileInsert( + psDB *dbh, ///< Database handle + psS64 diff_id, + const char *uri, + psF64 bg, + psF64 bg_stdev +); + +/** 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 diffSkyfileDelete( + psDB *dbh, ///< Database handle + const psMetadata *where, ///< Row match criteria + unsigned long long limit ///< Maximum number of elements to delete +); + +/** Insert a single diffSkyfileRow object into a table + * + * This function constructs and inserts a single row based on it's parameters. + * + * @return true on success + */ + +bool diffSkyfileInsertObject( + psDB *dbh, ///< Database handle + diffSkyfileRow *object ///< diffSkyfileRow object +); + +/** Insert an array of diffSkyfileRow object into a table + * + * This function constructs and inserts multiple rows based on it's parameters. + * + * @return true on success + */ + +bool diffSkyfileInsertObjects( + psDB *dbh, ///< Database handle + psArray *objects ///< array of diffSkyfileRow objects +); + +/** Insert data from a binary FITS table diffSkyfileRow 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 diffSkyfileInsertFits( + 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 diffSkyfileSelectRowsFits( + 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 diffSkyfileRow into an equivalent psMetadata + * + * @return A psMetadata pointer or NULL on error + */ + +psMetadata *diffSkyfileMetadataFromObject( + const diffSkyfileRow *object ///< fooRow to convert into a psMetadata +); + +/** Convert a psMetadata into an equivalent fooRow + * + * @return A diffSkyfileRow pointer or NULL on error + */ + +diffSkyfileRow *diffSkyfileObjectFromMetadata( + psMetadata *md ///< psMetadata to convert into a fooRow +); +/** Selects up to limit rows from the database and returns as diffSkyfileRow objects in a psArray + * + * See psDBSelectRows() for documentation on the format of where. + * + * @return A psArray pointer or NULL on error + */ + +psArray *diffSkyfileSelectRowObjects( + 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 diffSkyfile + * + * 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 diffSkyfileDeleteObject( + psDB *dbh, ///< Database handle + const diffSkyfileRow *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 diffSkyfileDeleteRowObjects( + 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 diffSkyfileRow 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 diffSkyfilePrintObjects( + FILE *stream, ///< a stream + psArray *objects, ///< An array of diffSkyfileRow objects + bool mdcf ///< format as mdconfig or simple +); +/** Formats and prints an diffSkyfileRow object + * + * When mdcf is set the formated output is in psMetadataConfig + * format, otherwise it is in a simple tabular format. + * + * @return true on success + */ + +bool diffSkyfilePrintObject( + FILE *stream, ///< a stream + diffSkyfileRow *object, ///< an diffSkyfileRow object + bool mdcf ///< format as mdconfig or simple +); +/** stackRunRow data structure + * + * Structure for representing a single row of stackRun table data. + */ + +typedef struct { + psS64 stack_id; + char *state; + char *workdir; + char *dvodb; + psTime* registered; + char *skycell_id; + char *tess_id; +} stackRunRow; + +/** Creates a new stackRunRow object + * + * @return A new stackRunRow object or NULL on failure. + */ + +stackRunRow *stackRunRowAlloc( + psS64 stack_id, + const char *state, + const char *workdir, + const char *dvodb, + psTime* registered, + const char *skycell_id, + const char *tess_id +); + +/** Creates a new stackRun table + * + * @return true on success + */ + +bool stackRunCreateTable( + psDB *dbh ///< Database handle +); + +/** Deletes a stackRun table + * + * @return true on success + */ + +bool stackRunDropTable( + 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 stackRunInsert( + psDB *dbh, ///< Database handle + psS64 stack_id, + const char *state, + const char *workdir, + const char *dvodb, + psTime* registered, + const char *skycell_id, + const char *tess_id +); + +/** 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 stackRunDelete( + psDB *dbh, ///< Database handle + const psMetadata *where, ///< Row match criteria + unsigned long long limit ///< Maximum number of elements to delete +); + +/** Insert a single stackRunRow object into a table + * + * This function constructs and inserts a single row based on it's parameters. + * + * @return true on success + */ + +bool stackRunInsertObject( + psDB *dbh, ///< Database handle + stackRunRow *object ///< stackRunRow object +); + +/** Insert an array of stackRunRow object into a table + * + * This function constructs and inserts multiple rows based on it's parameters. + * + * @return true on success + */ + +bool stackRunInsertObjects( + psDB *dbh, ///< Database handle + psArray *objects ///< array of stackRunRow objects +); + +/** Insert data from a binary FITS table stackRunRow 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 stackRunInsertFits( + 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 stackRunSelectRowsFits( + 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 stackRunRow into an equivalent psMetadata + * + * @return A psMetadata pointer or NULL on error + */ + +psMetadata *stackRunMetadataFromObject( + const stackRunRow *object ///< fooRow to convert into a psMetadata +); + +/** Convert a psMetadata into an equivalent fooRow + * + * @return A stackRunRow pointer or NULL on error + */ + +stackRunRow *stackRunObjectFromMetadata( + psMetadata *md ///< psMetadata to convert into a fooRow +); +/** Selects up to limit rows from the database and returns as stackRunRow objects in a psArray + * + * See psDBSelectRows() for documentation on the format of where. + * + * @return A psArray pointer or NULL on error + */ + +psArray *stackRunSelectRowObjects( + 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 stackRun + * + * 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 stackRunDeleteObject( + psDB *dbh, ///< Database handle + const stackRunRow *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 stackRunDeleteRowObjects( + 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 stackRunRow 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 stackRunPrintObjects( + FILE *stream, ///< a stream + psArray *objects, ///< An array of stackRunRow objects + bool mdcf ///< format as mdconfig or simple +); +/** Formats and prints an stackRunRow object + * + * When mdcf is set the formated output is in psMetadataConfig + * format, otherwise it is in a simple tabular format. + * + * @return true on success + */ + +bool stackRunPrintObject( + FILE *stream, ///< a stream + stackRunRow *object, ///< an stackRunRow object + bool mdcf ///< format as mdconfig or simple +); +/** stackInputSkyfileRow data structure + * + * Structure for representing a single row of stackInputSkyfile table data. + */ + +typedef struct { + psS64 stack_id; + psS64 warp_id; +} stackInputSkyfileRow; + +/** Creates a new stackInputSkyfileRow object + * + * @return A new stackInputSkyfileRow object or NULL on failure. + */ + +stackInputSkyfileRow *stackInputSkyfileRowAlloc( + psS64 stack_id, + psS64 warp_id +); + +/** Creates a new stackInputSkyfile table + * + * @return true on success + */ + +bool stackInputSkyfileCreateTable( + psDB *dbh ///< Database handle +); + +/** Deletes a stackInputSkyfile table + * + * @return true on success + */ + +bool stackInputSkyfileDropTable( + 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 stackInputSkyfileInsert( + psDB *dbh, ///< Database handle + psS64 stack_id, + psS64 warp_id +); + +/** 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 stackInputSkyfileDelete( + psDB *dbh, ///< Database handle + const psMetadata *where, ///< Row match criteria + unsigned long long limit ///< Maximum number of elements to delete +); + +/** Insert a single stackInputSkyfileRow object into a table + * + * This function constructs and inserts a single row based on it's parameters. + * + * @return true on success + */ + +bool stackInputSkyfileInsertObject( + psDB *dbh, ///< Database handle + stackInputSkyfileRow *object ///< stackInputSkyfileRow object +); + +/** Insert an array of stackInputSkyfileRow object into a table + * + * This function constructs and inserts multiple rows based on it's parameters. + * + * @return true on success + */ + +bool stackInputSkyfileInsertObjects( + psDB *dbh, ///< Database handle + psArray *objects ///< array of stackInputSkyfileRow objects +); + +/** Insert data from a binary FITS table stackInputSkyfileRow 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 stackInputSkyfileInsertFits( + 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 stackInputSkyfileSelectRowsFits( + 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 stackInputSkyfileRow into an equivalent psMetadata + * + * @return A psMetadata pointer or NULL on error + */ + +psMetadata *stackInputSkyfileMetadataFromObject( + const stackInputSkyfileRow *object ///< fooRow to convert into a psMetadata +); + +/** Convert a psMetadata into an equivalent fooRow + * + * @return A stackInputSkyfileRow pointer or NULL on error + */ + +stackInputSkyfileRow *stackInputSkyfileObjectFromMetadata( + psMetadata *md ///< psMetadata to convert into a fooRow +); +/** Selects up to limit rows from the database and returns as stackInputSkyfileRow objects in a psArray + * + * See psDBSelectRows() for documentation on the format of where. + * + * @return A psArray pointer or NULL on error + */ + +psArray *stackInputSkyfileSelectRowObjects( + 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 stackInputSkyfile + * + * 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 stackInputSkyfileDeleteObject( + psDB *dbh, ///< Database handle + const stackInputSkyfileRow *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 stackInputSkyfileDeleteRowObjects( + 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 stackInputSkyfileRow 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 stackInputSkyfilePrintObjects( + FILE *stream, ///< a stream + psArray *objects, ///< An array of stackInputSkyfileRow objects + bool mdcf ///< format as mdconfig or simple +); +/** Formats and prints an stackInputSkyfileRow object + * + * When mdcf is set the formated output is in psMetadataConfig + * format, otherwise it is in a simple tabular format. + * + * @return true on success + */ + +bool stackInputSkyfilePrintObject( + FILE *stream, ///< a stream + stackInputSkyfileRow *object, ///< an stackInputSkyfileRow object + bool mdcf ///< format as mdconfig or simple +); +/** stackSumSkyfileRow data structure + * + * Structure for representing a single row of stackSumSkyfile table data. + */ + +typedef struct { + psS64 stack_id; + char *uri; + psF64 bg; + psF64 bg_stdev; +} stackSumSkyfileRow; + +/** Creates a new stackSumSkyfileRow object + * + * @return A new stackSumSkyfileRow object or NULL on failure. + */ + +stackSumSkyfileRow *stackSumSkyfileRowAlloc( + psS64 stack_id, + const char *uri, + psF64 bg, + psF64 bg_stdev +); + +/** Creates a new stackSumSkyfile table + * + * @return true on success + */ + +bool stackSumSkyfileCreateTable( + psDB *dbh ///< Database handle +); + +/** Deletes a stackSumSkyfile table + * + * @return true on success + */ + +bool stackSumSkyfileDropTable( + 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 stackSumSkyfileInsert( + psDB *dbh, ///< Database handle + psS64 stack_id, + const char *uri, + psF64 bg, + psF64 bg_stdev +); + +/** 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 stackSumSkyfileDelete( + psDB *dbh, ///< Database handle + const psMetadata *where, ///< Row match criteria + unsigned long long limit ///< Maximum number of elements to delete +); + +/** Insert a single stackSumSkyfileRow object into a table + * + * This function constructs and inserts a single row based on it's parameters. + * + * @return true on success + */ + +bool stackSumSkyfileInsertObject( + psDB *dbh, ///< Database handle + stackSumSkyfileRow *object ///< stackSumSkyfileRow object +); + +/** Insert an array of stackSumSkyfileRow object into a table + * + * This function constructs and inserts multiple rows based on it's parameters. + * + * @return true on success + */ + +bool stackSumSkyfileInsertObjects( + psDB *dbh, ///< Database handle + psArray *objects ///< array of stackSumSkyfileRow objects +); + +/** Insert data from a binary FITS table stackSumSkyfileRow 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 stackSumSkyfileInsertFits( + 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 stackSumSkyfileSelectRowsFits( + 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 stackSumSkyfileRow into an equivalent psMetadata + * + * @return A psMetadata pointer or NULL on error + */ + +psMetadata *stackSumSkyfileMetadataFromObject( + const stackSumSkyfileRow *object ///< fooRow to convert into a psMetadata +); + +/** Convert a psMetadata into an equivalent fooRow + * + * @return A stackSumSkyfileRow pointer or NULL on error + */ + +stackSumSkyfileRow *stackSumSkyfileObjectFromMetadata( + psMetadata *md ///< psMetadata to convert into a fooRow +); +/** Selects up to limit rows from the database and returns as stackSumSkyfileRow objects in a psArray + * + * See psDBSelectRows() for documentation on the format of where. + * + * @return A psArray pointer or NULL on error + */ + +psArray *stackSumSkyfileSelectRowObjects( + 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 stackSumSkyfile + * + * 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 stackSumSkyfileDeleteObject( + psDB *dbh, ///< Database handle + const stackSumSkyfileRow *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 stackSumSkyfileDeleteRowObjects( + 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 stackSumSkyfileRow 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 stackSumSkyfilePrintObjects( + FILE *stream, ///< a stream + psArray *objects, ///< An array of stackSumSkyfileRow objects + bool mdcf ///< format as mdconfig or simple +); +/** Formats and prints an stackSumSkyfileRow object + * + * When mdcf is set the formated output is in psMetadataConfig + * format, otherwise it is in a simple tabular format. + * + * @return true on success + */ + +bool stackSumSkyfilePrintObject( + FILE *stream, ///< a stream + stackSumSkyfileRow *object, ///< an stackSumSkyfileRow object bool mdcf ///< format as mdconfig or simple ); @@ -6845,2077 +8918,4 @@ bool mdcf ///< format as mdconfig or simple ); -/** warpRunRow data structure - * - * Structure for representing a single row of warpRun table data. - */ - -typedef struct { - psS64 warp_id; - char *mode; - char *state; - char *workdir; - char *dvodb; - psTime* registered; -} warpRunRow; - -/** Creates a new warpRunRow object - * - * @return A new warpRunRow object or NULL on failure. - */ - -warpRunRow *warpRunRowAlloc( - psS64 warp_id, - const char *mode, - const char *state, - const char *workdir, - const char *dvodb, - psTime* registered -); - -/** Creates a new warpRun table - * - * @return true on success - */ - -bool warpRunCreateTable( - psDB *dbh ///< Database handle -); - -/** Deletes a warpRun table - * - * @return true on success - */ - -bool warpRunDropTable( - 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 warpRunInsert( - psDB *dbh, ///< Database handle - psS64 warp_id, - const char *mode, - const char *state, - const char *workdir, - const char *dvodb, - psTime* registered -); - -/** 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 warpRunDelete( - psDB *dbh, ///< Database handle - const psMetadata *where, ///< Row match criteria - unsigned long long limit ///< Maximum number of elements to delete -); - -/** Insert a single warpRunRow object into a table - * - * This function constructs and inserts a single row based on it's parameters. - * - * @return true on success - */ - -bool warpRunInsertObject( - psDB *dbh, ///< Database handle - warpRunRow *object ///< warpRunRow object -); - -/** Insert an array of warpRunRow object into a table - * - * This function constructs and inserts multiple rows based on it's parameters. - * - * @return true on success - */ - -bool warpRunInsertObjects( - psDB *dbh, ///< Database handle - psArray *objects ///< array of warpRunRow objects -); - -/** Insert data from a binary FITS table warpRunRow 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 warpRunInsertFits( - 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 warpRunSelectRowsFits( - 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 warpRunRow into an equivalent psMetadata - * - * @return A psMetadata pointer or NULL on error - */ - -psMetadata *warpRunMetadataFromObject( - const warpRunRow *object ///< fooRow to convert into a psMetadata -); - -/** Convert a psMetadata into an equivalent fooRow - * - * @return A warpRunRow pointer or NULL on error - */ - -warpRunRow *warpRunObjectFromMetadata( - psMetadata *md ///< psMetadata to convert into a fooRow -); -/** Selects up to limit rows from the database and returns as warpRunRow objects in a psArray - * - * See psDBSelectRows() for documentation on the format of where. - * - * @return A psArray pointer or NULL on error - */ - -psArray *warpRunSelectRowObjects( - 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 warpRun - * - * 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 warpRunDeleteObject( - psDB *dbh, ///< Database handle - const warpRunRow *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 warpRunDeleteRowObjects( - 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 warpRunRow 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 warpRunPrintObjects( - FILE *stream, ///< a stream - psArray *objects, ///< An array of warpRunRow objects - bool mdcf ///< format as mdconfig or simple -); -/** Formats and prints an warpRunRow object - * - * When mdcf is set the formated output is in psMetadataConfig - * format, otherwise it is in a simple tabular format. - * - * @return true on success - */ - -bool warpRunPrintObject( - FILE *stream, ///< a stream - warpRunRow *object, ///< an warpRunRow object - bool mdcf ///< format as mdconfig or simple -); -/** warpInputExpRow data structure - * - * Structure for representing a single row of warpInputExp table data. - */ - -typedef struct { - psS64 warp_id; - psS64 cam_id; - bool magiced; -} warpInputExpRow; - -/** Creates a new warpInputExpRow object - * - * @return A new warpInputExpRow object or NULL on failure. - */ - -warpInputExpRow *warpInputExpRowAlloc( - psS64 warp_id, - psS64 cam_id, - bool magiced -); - -/** Creates a new warpInputExp table - * - * @return true on success - */ - -bool warpInputExpCreateTable( - psDB *dbh ///< Database handle -); - -/** Deletes a warpInputExp table - * - * @return true on success - */ - -bool warpInputExpDropTable( - 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 warpInputExpInsert( - psDB *dbh, ///< Database handle - psS64 warp_id, - psS64 cam_id, - bool magiced -); - -/** 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 warpInputExpDelete( - psDB *dbh, ///< Database handle - const psMetadata *where, ///< Row match criteria - unsigned long long limit ///< Maximum number of elements to delete -); - -/** Insert a single warpInputExpRow object into a table - * - * This function constructs and inserts a single row based on it's parameters. - * - * @return true on success - */ - -bool warpInputExpInsertObject( - psDB *dbh, ///< Database handle - warpInputExpRow *object ///< warpInputExpRow object -); - -/** Insert an array of warpInputExpRow object into a table - * - * This function constructs and inserts multiple rows based on it's parameters. - * - * @return true on success - */ - -bool warpInputExpInsertObjects( - psDB *dbh, ///< Database handle - psArray *objects ///< array of warpInputExpRow objects -); - -/** Insert data from a binary FITS table warpInputExpRow 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 warpInputExpInsertFits( - 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 warpInputExpSelectRowsFits( - 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 warpInputExpRow into an equivalent psMetadata - * - * @return A psMetadata pointer or NULL on error - */ - -psMetadata *warpInputExpMetadataFromObject( - const warpInputExpRow *object ///< fooRow to convert into a psMetadata -); - -/** Convert a psMetadata into an equivalent fooRow - * - * @return A warpInputExpRow pointer or NULL on error - */ - -warpInputExpRow *warpInputExpObjectFromMetadata( - psMetadata *md ///< psMetadata to convert into a fooRow -); -/** Selects up to limit rows from the database and returns as warpInputExpRow objects in a psArray - * - * See psDBSelectRows() for documentation on the format of where. - * - * @return A psArray pointer or NULL on error - */ - -psArray *warpInputExpSelectRowObjects( - 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 warpInputExp - * - * 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 warpInputExpDeleteObject( - psDB *dbh, ///< Database handle - const warpInputExpRow *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 warpInputExpDeleteRowObjects( - 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 warpInputExpRow 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 warpInputExpPrintObjects( - FILE *stream, ///< a stream - psArray *objects, ///< An array of warpInputExpRow objects - bool mdcf ///< format as mdconfig or simple -); -/** Formats and prints an warpInputExpRow object - * - * When mdcf is set the formated output is in psMetadataConfig - * format, otherwise it is in a simple tabular format. - * - * @return true on success - */ - -bool warpInputExpPrintObject( - FILE *stream, ///< a stream - warpInputExpRow *object, ///< an warpInputExpRow object - bool mdcf ///< format as mdconfig or simple -); -/** warpSkyCellMapRow data structure - * - * Structure for representing a single row of warpSkyCellMap table data. - */ - -typedef struct { - psS64 warp_id; - char *skycell_id; - char *tess_id; - psS64 cam_id; - char *class_id; - psS16 fault; -} warpSkyCellMapRow; - -/** Creates a new warpSkyCellMapRow object - * - * @return A new warpSkyCellMapRow object or NULL on failure. - */ - -warpSkyCellMapRow *warpSkyCellMapRowAlloc( - psS64 warp_id, - const char *skycell_id, - const char *tess_id, - psS64 cam_id, - const char *class_id, - psS16 fault -); - -/** Creates a new warpSkyCellMap table - * - * @return true on success - */ - -bool warpSkyCellMapCreateTable( - psDB *dbh ///< Database handle -); - -/** Deletes a warpSkyCellMap table - * - * @return true on success - */ - -bool warpSkyCellMapDropTable( - 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 warpSkyCellMapInsert( - psDB *dbh, ///< Database handle - psS64 warp_id, - const char *skycell_id, - const char *tess_id, - psS64 cam_id, - const char *class_id, - psS16 fault -); - -/** 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 warpSkyCellMapDelete( - psDB *dbh, ///< Database handle - const psMetadata *where, ///< Row match criteria - unsigned long long limit ///< Maximum number of elements to delete -); - -/** Insert a single warpSkyCellMapRow object into a table - * - * This function constructs and inserts a single row based on it's parameters. - * - * @return true on success - */ - -bool warpSkyCellMapInsertObject( - psDB *dbh, ///< Database handle - warpSkyCellMapRow *object ///< warpSkyCellMapRow object -); - -/** Insert an array of warpSkyCellMapRow object into a table - * - * This function constructs and inserts multiple rows based on it's parameters. - * - * @return true on success - */ - -bool warpSkyCellMapInsertObjects( - psDB *dbh, ///< Database handle - psArray *objects ///< array of warpSkyCellMapRow objects -); - -/** Insert data from a binary FITS table warpSkyCellMapRow 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 warpSkyCellMapInsertFits( - 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 warpSkyCellMapSelectRowsFits( - 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 warpSkyCellMapRow into an equivalent psMetadata - * - * @return A psMetadata pointer or NULL on error - */ - -psMetadata *warpSkyCellMapMetadataFromObject( - const warpSkyCellMapRow *object ///< fooRow to convert into a psMetadata -); - -/** Convert a psMetadata into an equivalent fooRow - * - * @return A warpSkyCellMapRow pointer or NULL on error - */ - -warpSkyCellMapRow *warpSkyCellMapObjectFromMetadata( - psMetadata *md ///< psMetadata to convert into a fooRow -); -/** Selects up to limit rows from the database and returns as warpSkyCellMapRow objects in a psArray - * - * See psDBSelectRows() for documentation on the format of where. - * - * @return A psArray pointer or NULL on error - */ - -psArray *warpSkyCellMapSelectRowObjects( - 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 warpSkyCellMap - * - * 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 warpSkyCellMapDeleteObject( - psDB *dbh, ///< Database handle - const warpSkyCellMapRow *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 warpSkyCellMapDeleteRowObjects( - 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 warpSkyCellMapRow 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 warpSkyCellMapPrintObjects( - FILE *stream, ///< a stream - psArray *objects, ///< An array of warpSkyCellMapRow objects - bool mdcf ///< format as mdconfig or simple -); -/** Formats and prints an warpSkyCellMapRow object - * - * When mdcf is set the formated output is in psMetadataConfig - * format, otherwise it is in a simple tabular format. - * - * @return true on success - */ - -bool warpSkyCellMapPrintObject( - FILE *stream, ///< a stream - warpSkyCellMapRow *object, ///< an warpSkyCellMapRow object - bool mdcf ///< format as mdconfig or simple -); -/** warpSkyfileRow data structure - * - * Structure for representing a single row of warpSkyfile table data. - */ - -typedef struct { - psS64 warp_id; - char *skycell_id; - char *tess_id; - char *uri; - psF64 bg; - psF64 bg_stdev; -} warpSkyfileRow; - -/** Creates a new warpSkyfileRow object - * - * @return A new warpSkyfileRow object or NULL on failure. - */ - -warpSkyfileRow *warpSkyfileRowAlloc( - psS64 warp_id, - const char *skycell_id, - const char *tess_id, - const char *uri, - psF64 bg, - psF64 bg_stdev -); - -/** Creates a new warpSkyfile table - * - * @return true on success - */ - -bool warpSkyfileCreateTable( - psDB *dbh ///< Database handle -); - -/** Deletes a warpSkyfile table - * - * @return true on success - */ - -bool warpSkyfileDropTable( - 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 warpSkyfileInsert( - psDB *dbh, ///< Database handle - psS64 warp_id, - const char *skycell_id, - const char *tess_id, - const char *uri, - psF64 bg, - psF64 bg_stdev -); - -/** 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 warpSkyfileDelete( - psDB *dbh, ///< Database handle - const psMetadata *where, ///< Row match criteria - unsigned long long limit ///< Maximum number of elements to delete -); - -/** Insert a single warpSkyfileRow object into a table - * - * This function constructs and inserts a single row based on it's parameters. - * - * @return true on success - */ - -bool warpSkyfileInsertObject( - psDB *dbh, ///< Database handle - warpSkyfileRow *object ///< warpSkyfileRow object -); - -/** Insert an array of warpSkyfileRow object into a table - * - * This function constructs and inserts multiple rows based on it's parameters. - * - * @return true on success - */ - -bool warpSkyfileInsertObjects( - psDB *dbh, ///< Database handle - psArray *objects ///< array of warpSkyfileRow objects -); - -/** Insert data from a binary FITS table warpSkyfileRow 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 warpSkyfileInsertFits( - 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 warpSkyfileSelectRowsFits( - 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 warpSkyfileRow into an equivalent psMetadata - * - * @return A psMetadata pointer or NULL on error - */ - -psMetadata *warpSkyfileMetadataFromObject( - const warpSkyfileRow *object ///< fooRow to convert into a psMetadata -); - -/** Convert a psMetadata into an equivalent fooRow - * - * @return A warpSkyfileRow pointer or NULL on error - */ - -warpSkyfileRow *warpSkyfileObjectFromMetadata( - psMetadata *md ///< psMetadata to convert into a fooRow -); -/** Selects up to limit rows from the database and returns as warpSkyfileRow objects in a psArray - * - * See psDBSelectRows() for documentation on the format of where. - * - * @return A psArray pointer or NULL on error - */ - -psArray *warpSkyfileSelectRowObjects( - 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 warpSkyfile - * - * 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 warpSkyfileDeleteObject( - psDB *dbh, ///< Database handle - const warpSkyfileRow *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 warpSkyfileDeleteRowObjects( - 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 warpSkyfileRow 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 warpSkyfilePrintObjects( - FILE *stream, ///< a stream - psArray *objects, ///< An array of warpSkyfileRow objects - bool mdcf ///< format as mdconfig or simple -); -/** Formats and prints an warpSkyfileRow object - * - * When mdcf is set the formated output is in psMetadataConfig - * format, otherwise it is in a simple tabular format. - * - * @return true on success - */ - -bool warpSkyfilePrintObject( - FILE *stream, ///< a stream - warpSkyfileRow *object, ///< an warpSkyfileRow object - bool mdcf ///< format as mdconfig or simple -); -/** diffRunRow data structure - * - * Structure for representing a single row of diffRun table data. - */ - -typedef struct { - psS64 diff_id; - char *state; - char *workdir; - char *dvodb; - psTime* registered; - char *skycell_id; - char *tess_id; -} diffRunRow; - -/** Creates a new diffRunRow object - * - * @return A new diffRunRow object or NULL on failure. - */ - -diffRunRow *diffRunRowAlloc( - psS64 diff_id, - const char *state, - const char *workdir, - const char *dvodb, - psTime* registered, - const char *skycell_id, - const char *tess_id -); - -/** Creates a new diffRun table - * - * @return true on success - */ - -bool diffRunCreateTable( - psDB *dbh ///< Database handle -); - -/** Deletes a diffRun table - * - * @return true on success - */ - -bool diffRunDropTable( - 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 diffRunInsert( - psDB *dbh, ///< Database handle - psS64 diff_id, - const char *state, - const char *workdir, - const char *dvodb, - psTime* registered, - const char *skycell_id, - const char *tess_id -); - -/** 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 diffRunDelete( - psDB *dbh, ///< Database handle - const psMetadata *where, ///< Row match criteria - unsigned long long limit ///< Maximum number of elements to delete -); - -/** Insert a single diffRunRow object into a table - * - * This function constructs and inserts a single row based on it's parameters. - * - * @return true on success - */ - -bool diffRunInsertObject( - psDB *dbh, ///< Database handle - diffRunRow *object ///< diffRunRow object -); - -/** Insert an array of diffRunRow object into a table - * - * This function constructs and inserts multiple rows based on it's parameters. - * - * @return true on success - */ - -bool diffRunInsertObjects( - psDB *dbh, ///< Database handle - psArray *objects ///< array of diffRunRow objects -); - -/** Insert data from a binary FITS table diffRunRow 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 diffRunInsertFits( - 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 diffRunSelectRowsFits( - 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 diffRunRow into an equivalent psMetadata - * - * @return A psMetadata pointer or NULL on error - */ - -psMetadata *diffRunMetadataFromObject( - const diffRunRow *object ///< fooRow to convert into a psMetadata -); - -/** Convert a psMetadata into an equivalent fooRow - * - * @return A diffRunRow pointer or NULL on error - */ - -diffRunRow *diffRunObjectFromMetadata( - psMetadata *md ///< psMetadata to convert into a fooRow -); -/** Selects up to limit rows from the database and returns as diffRunRow objects in a psArray - * - * See psDBSelectRows() for documentation on the format of where. - * - * @return A psArray pointer or NULL on error - */ - -psArray *diffRunSelectRowObjects( - 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 diffRun - * - * 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 diffRunDeleteObject( - psDB *dbh, ///< Database handle - const diffRunRow *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 diffRunDeleteRowObjects( - 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 diffRunRow 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 diffRunPrintObjects( - FILE *stream, ///< a stream - psArray *objects, ///< An array of diffRunRow objects - bool mdcf ///< format as mdconfig or simple -); -/** Formats and prints an diffRunRow object - * - * When mdcf is set the formated output is in psMetadataConfig - * format, otherwise it is in a simple tabular format. - * - * @return true on success - */ - -bool diffRunPrintObject( - FILE *stream, ///< a stream - diffRunRow *object, ///< an diffRunRow object - bool mdcf ///< format as mdconfig or simple -); -/** diffInputSkyfileRow data structure - * - * Structure for representing a single row of diffInputSkyfile table data. - */ - -typedef struct { - psS64 diff_id; - psS64 warp_id; - char *skycell_id; - char *tess_id; - char *kind; - bool template; -} diffInputSkyfileRow; - -/** Creates a new diffInputSkyfileRow object - * - * @return A new diffInputSkyfileRow object or NULL on failure. - */ - -diffInputSkyfileRow *diffInputSkyfileRowAlloc( - psS64 diff_id, - psS64 warp_id, - const char *skycell_id, - const char *tess_id, - const char *kind, - bool template -); - -/** Creates a new diffInputSkyfile table - * - * @return true on success - */ - -bool diffInputSkyfileCreateTable( - psDB *dbh ///< Database handle -); - -/** Deletes a diffInputSkyfile table - * - * @return true on success - */ - -bool diffInputSkyfileDropTable( - 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 diffInputSkyfileInsert( - psDB *dbh, ///< Database handle - psS64 diff_id, - psS64 warp_id, - const char *skycell_id, - const char *tess_id, - const char *kind, - bool template -); - -/** 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 diffInputSkyfileDelete( - psDB *dbh, ///< Database handle - const psMetadata *where, ///< Row match criteria - unsigned long long limit ///< Maximum number of elements to delete -); - -/** Insert a single diffInputSkyfileRow object into a table - * - * This function constructs and inserts a single row based on it's parameters. - * - * @return true on success - */ - -bool diffInputSkyfileInsertObject( - psDB *dbh, ///< Database handle - diffInputSkyfileRow *object ///< diffInputSkyfileRow object -); - -/** Insert an array of diffInputSkyfileRow object into a table - * - * This function constructs and inserts multiple rows based on it's parameters. - * - * @return true on success - */ - -bool diffInputSkyfileInsertObjects( - psDB *dbh, ///< Database handle - psArray *objects ///< array of diffInputSkyfileRow objects -); - -/** Insert data from a binary FITS table diffInputSkyfileRow 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 diffInputSkyfileInsertFits( - 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 diffInputSkyfileSelectRowsFits( - 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 diffInputSkyfileRow into an equivalent psMetadata - * - * @return A psMetadata pointer or NULL on error - */ - -psMetadata *diffInputSkyfileMetadataFromObject( - const diffInputSkyfileRow *object ///< fooRow to convert into a psMetadata -); - -/** Convert a psMetadata into an equivalent fooRow - * - * @return A diffInputSkyfileRow pointer or NULL on error - */ - -diffInputSkyfileRow *diffInputSkyfileObjectFromMetadata( - psMetadata *md ///< psMetadata to convert into a fooRow -); -/** Selects up to limit rows from the database and returns as diffInputSkyfileRow objects in a psArray - * - * See psDBSelectRows() for documentation on the format of where. - * - * @return A psArray pointer or NULL on error - */ - -psArray *diffInputSkyfileSelectRowObjects( - 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 diffInputSkyfile - * - * 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 diffInputSkyfileDeleteObject( - psDB *dbh, ///< Database handle - const diffInputSkyfileRow *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 diffInputSkyfileDeleteRowObjects( - 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 diffInputSkyfileRow 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 diffInputSkyfilePrintObjects( - FILE *stream, ///< a stream - psArray *objects, ///< An array of diffInputSkyfileRow objects - bool mdcf ///< format as mdconfig or simple -); -/** Formats and prints an diffInputSkyfileRow object - * - * When mdcf is set the formated output is in psMetadataConfig - * format, otherwise it is in a simple tabular format. - * - * @return true on success - */ - -bool diffInputSkyfilePrintObject( - FILE *stream, ///< a stream - diffInputSkyfileRow *object, ///< an diffInputSkyfileRow object - bool mdcf ///< format as mdconfig or simple -); -/** diffSkyfileRow data structure - * - * Structure for representing a single row of diffSkyfile table data. - */ - -typedef struct { - psS64 diff_id; - char *uri; - psF64 bg; - psF64 bg_stdev; -} diffSkyfileRow; - -/** Creates a new diffSkyfileRow object - * - * @return A new diffSkyfileRow object or NULL on failure. - */ - -diffSkyfileRow *diffSkyfileRowAlloc( - psS64 diff_id, - const char *uri, - psF64 bg, - psF64 bg_stdev -); - -/** Creates a new diffSkyfile table - * - * @return true on success - */ - -bool diffSkyfileCreateTable( - psDB *dbh ///< Database handle -); - -/** Deletes a diffSkyfile table - * - * @return true on success - */ - -bool diffSkyfileDropTable( - 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 diffSkyfileInsert( - psDB *dbh, ///< Database handle - psS64 diff_id, - const char *uri, - psF64 bg, - psF64 bg_stdev -); - -/** 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 diffSkyfileDelete( - psDB *dbh, ///< Database handle - const psMetadata *where, ///< Row match criteria - unsigned long long limit ///< Maximum number of elements to delete -); - -/** Insert a single diffSkyfileRow object into a table - * - * This function constructs and inserts a single row based on it's parameters. - * - * @return true on success - */ - -bool diffSkyfileInsertObject( - psDB *dbh, ///< Database handle - diffSkyfileRow *object ///< diffSkyfileRow object -); - -/** Insert an array of diffSkyfileRow object into a table - * - * This function constructs and inserts multiple rows based on it's parameters. - * - * @return true on success - */ - -bool diffSkyfileInsertObjects( - psDB *dbh, ///< Database handle - psArray *objects ///< array of diffSkyfileRow objects -); - -/** Insert data from a binary FITS table diffSkyfileRow 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 diffSkyfileInsertFits( - 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 diffSkyfileSelectRowsFits( - 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 diffSkyfileRow into an equivalent psMetadata - * - * @return A psMetadata pointer or NULL on error - */ - -psMetadata *diffSkyfileMetadataFromObject( - const diffSkyfileRow *object ///< fooRow to convert into a psMetadata -); - -/** Convert a psMetadata into an equivalent fooRow - * - * @return A diffSkyfileRow pointer or NULL on error - */ - -diffSkyfileRow *diffSkyfileObjectFromMetadata( - psMetadata *md ///< psMetadata to convert into a fooRow -); -/** Selects up to limit rows from the database and returns as diffSkyfileRow objects in a psArray - * - * See psDBSelectRows() for documentation on the format of where. - * - * @return A psArray pointer or NULL on error - */ - -psArray *diffSkyfileSelectRowObjects( - 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 diffSkyfile - * - * 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 diffSkyfileDeleteObject( - psDB *dbh, ///< Database handle - const diffSkyfileRow *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 diffSkyfileDeleteRowObjects( - 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 diffSkyfileRow 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 diffSkyfilePrintObjects( - FILE *stream, ///< a stream - psArray *objects, ///< An array of diffSkyfileRow objects - bool mdcf ///< format as mdconfig or simple -); -/** Formats and prints an diffSkyfileRow object - * - * When mdcf is set the formated output is in psMetadataConfig - * format, otherwise it is in a simple tabular format. - * - * @return true on success - */ - -bool diffSkyfilePrintObject( - FILE *stream, ///< a stream - diffSkyfileRow *object, ///< an diffSkyfileRow object - bool mdcf ///< format as mdconfig or simple -); -/** stackRunRow data structure - * - * Structure for representing a single row of stackRun table data. - */ - -typedef struct { - psS64 stack_id; - char *state; - char *workdir; - char *dvodb; - psTime* registered; - char *skycell_id; - char *tess_id; -} stackRunRow; - -/** Creates a new stackRunRow object - * - * @return A new stackRunRow object or NULL on failure. - */ - -stackRunRow *stackRunRowAlloc( - psS64 stack_id, - const char *state, - const char *workdir, - const char *dvodb, - psTime* registered, - const char *skycell_id, - const char *tess_id -); - -/** Creates a new stackRun table - * - * @return true on success - */ - -bool stackRunCreateTable( - psDB *dbh ///< Database handle -); - -/** Deletes a stackRun table - * - * @return true on success - */ - -bool stackRunDropTable( - 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 stackRunInsert( - psDB *dbh, ///< Database handle - psS64 stack_id, - const char *state, - const char *workdir, - const char *dvodb, - psTime* registered, - const char *skycell_id, - const char *tess_id -); - -/** 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 stackRunDelete( - psDB *dbh, ///< Database handle - const psMetadata *where, ///< Row match criteria - unsigned long long limit ///< Maximum number of elements to delete -); - -/** Insert a single stackRunRow object into a table - * - * This function constructs and inserts a single row based on it's parameters. - * - * @return true on success - */ - -bool stackRunInsertObject( - psDB *dbh, ///< Database handle - stackRunRow *object ///< stackRunRow object -); - -/** Insert an array of stackRunRow object into a table - * - * This function constructs and inserts multiple rows based on it's parameters. - * - * @return true on success - */ - -bool stackRunInsertObjects( - psDB *dbh, ///< Database handle - psArray *objects ///< array of stackRunRow objects -); - -/** Insert data from a binary FITS table stackRunRow 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 stackRunInsertFits( - 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 stackRunSelectRowsFits( - 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 stackRunRow into an equivalent psMetadata - * - * @return A psMetadata pointer or NULL on error - */ - -psMetadata *stackRunMetadataFromObject( - const stackRunRow *object ///< fooRow to convert into a psMetadata -); - -/** Convert a psMetadata into an equivalent fooRow - * - * @return A stackRunRow pointer or NULL on error - */ - -stackRunRow *stackRunObjectFromMetadata( - psMetadata *md ///< psMetadata to convert into a fooRow -); -/** Selects up to limit rows from the database and returns as stackRunRow objects in a psArray - * - * See psDBSelectRows() for documentation on the format of where. - * - * @return A psArray pointer or NULL on error - */ - -psArray *stackRunSelectRowObjects( - 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 stackRun - * - * 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 stackRunDeleteObject( - psDB *dbh, ///< Database handle - const stackRunRow *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 stackRunDeleteRowObjects( - 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 stackRunRow 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 stackRunPrintObjects( - FILE *stream, ///< a stream - psArray *objects, ///< An array of stackRunRow objects - bool mdcf ///< format as mdconfig or simple -); -/** Formats and prints an stackRunRow object - * - * When mdcf is set the formated output is in psMetadataConfig - * format, otherwise it is in a simple tabular format. - * - * @return true on success - */ - -bool stackRunPrintObject( - FILE *stream, ///< a stream - stackRunRow *object, ///< an stackRunRow object - bool mdcf ///< format as mdconfig or simple -); -/** stackInputSkyfileRow data structure - * - * Structure for representing a single row of stackInputSkyfile table data. - */ - -typedef struct { - psS64 stack_id; - psS64 warp_id; -} stackInputSkyfileRow; - -/** Creates a new stackInputSkyfileRow object - * - * @return A new stackInputSkyfileRow object or NULL on failure. - */ - -stackInputSkyfileRow *stackInputSkyfileRowAlloc( - psS64 stack_id, - psS64 warp_id -); - -/** Creates a new stackInputSkyfile table - * - * @return true on success - */ - -bool stackInputSkyfileCreateTable( - psDB *dbh ///< Database handle -); - -/** Deletes a stackInputSkyfile table - * - * @return true on success - */ - -bool stackInputSkyfileDropTable( - 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 stackInputSkyfileInsert( - psDB *dbh, ///< Database handle - psS64 stack_id, - psS64 warp_id -); - -/** 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 stackInputSkyfileDelete( - psDB *dbh, ///< Database handle - const psMetadata *where, ///< Row match criteria - unsigned long long limit ///< Maximum number of elements to delete -); - -/** Insert a single stackInputSkyfileRow object into a table - * - * This function constructs and inserts a single row based on it's parameters. - * - * @return true on success - */ - -bool stackInputSkyfileInsertObject( - psDB *dbh, ///< Database handle - stackInputSkyfileRow *object ///< stackInputSkyfileRow object -); - -/** Insert an array of stackInputSkyfileRow object into a table - * - * This function constructs and inserts multiple rows based on it's parameters. - * - * @return true on success - */ - -bool stackInputSkyfileInsertObjects( - psDB *dbh, ///< Database handle - psArray *objects ///< array of stackInputSkyfileRow objects -); - -/** Insert data from a binary FITS table stackInputSkyfileRow 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 stackInputSkyfileInsertFits( - 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 stackInputSkyfileSelectRowsFits( - 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 stackInputSkyfileRow into an equivalent psMetadata - * - * @return A psMetadata pointer or NULL on error - */ - -psMetadata *stackInputSkyfileMetadataFromObject( - const stackInputSkyfileRow *object ///< fooRow to convert into a psMetadata -); - -/** Convert a psMetadata into an equivalent fooRow - * - * @return A stackInputSkyfileRow pointer or NULL on error - */ - -stackInputSkyfileRow *stackInputSkyfileObjectFromMetadata( - psMetadata *md ///< psMetadata to convert into a fooRow -); -/** Selects up to limit rows from the database and returns as stackInputSkyfileRow objects in a psArray - * - * See psDBSelectRows() for documentation on the format of where. - * - * @return A psArray pointer or NULL on error - */ - -psArray *stackInputSkyfileSelectRowObjects( - 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 stackInputSkyfile - * - * 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 stackInputSkyfileDeleteObject( - psDB *dbh, ///< Database handle - const stackInputSkyfileRow *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 stackInputSkyfileDeleteRowObjects( - 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 stackInputSkyfileRow 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 stackInputSkyfilePrintObjects( - FILE *stream, ///< a stream - psArray *objects, ///< An array of stackInputSkyfileRow objects - bool mdcf ///< format as mdconfig or simple -); -/** Formats and prints an stackInputSkyfileRow object - * - * When mdcf is set the formated output is in psMetadataConfig - * format, otherwise it is in a simple tabular format. - * - * @return true on success - */ - -bool stackInputSkyfilePrintObject( - FILE *stream, ///< a stream - stackInputSkyfileRow *object, ///< an stackInputSkyfileRow object - bool mdcf ///< format as mdconfig or simple -); -/** stackSumSkyfileRow data structure - * - * Structure for representing a single row of stackSumSkyfile table data. - */ - -typedef struct { - psS64 stack_id; - char *uri; - psF64 bg; - psF64 bg_stdev; -} stackSumSkyfileRow; - -/** Creates a new stackSumSkyfileRow object - * - * @return A new stackSumSkyfileRow object or NULL on failure. - */ - -stackSumSkyfileRow *stackSumSkyfileRowAlloc( - psS64 stack_id, - const char *uri, - psF64 bg, - psF64 bg_stdev -); - -/** Creates a new stackSumSkyfile table - * - * @return true on success - */ - -bool stackSumSkyfileCreateTable( - psDB *dbh ///< Database handle -); - -/** Deletes a stackSumSkyfile table - * - * @return true on success - */ - -bool stackSumSkyfileDropTable( - 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 stackSumSkyfileInsert( - psDB *dbh, ///< Database handle - psS64 stack_id, - const char *uri, - psF64 bg, - psF64 bg_stdev -); - -/** 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 stackSumSkyfileDelete( - psDB *dbh, ///< Database handle - const psMetadata *where, ///< Row match criteria - unsigned long long limit ///< Maximum number of elements to delete -); - -/** Insert a single stackSumSkyfileRow object into a table - * - * This function constructs and inserts a single row based on it's parameters. - * - * @return true on success - */ - -bool stackSumSkyfileInsertObject( - psDB *dbh, ///< Database handle - stackSumSkyfileRow *object ///< stackSumSkyfileRow object -); - -/** Insert an array of stackSumSkyfileRow object into a table - * - * This function constructs and inserts multiple rows based on it's parameters. - * - * @return true on success - */ - -bool stackSumSkyfileInsertObjects( - psDB *dbh, ///< Database handle - psArray *objects ///< array of stackSumSkyfileRow objects -); - -/** Insert data from a binary FITS table stackSumSkyfileRow 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 stackSumSkyfileInsertFits( - 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 stackSumSkyfileSelectRowsFits( - 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 stackSumSkyfileRow into an equivalent psMetadata - * - * @return A psMetadata pointer or NULL on error - */ - -psMetadata *stackSumSkyfileMetadataFromObject( - const stackSumSkyfileRow *object ///< fooRow to convert into a psMetadata -); - -/** Convert a psMetadata into an equivalent fooRow - * - * @return A stackSumSkyfileRow pointer or NULL on error - */ - -stackSumSkyfileRow *stackSumSkyfileObjectFromMetadata( - psMetadata *md ///< psMetadata to convert into a fooRow -); -/** Selects up to limit rows from the database and returns as stackSumSkyfileRow objects in a psArray - * - * See psDBSelectRows() for documentation on the format of where. - * - * @return A psArray pointer or NULL on error - */ - -psArray *stackSumSkyfileSelectRowObjects( - 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 stackSumSkyfile - * - * 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 stackSumSkyfileDeleteObject( - psDB *dbh, ///< Database handle - const stackSumSkyfileRow *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 stackSumSkyfileDeleteRowObjects( - 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 stackSumSkyfileRow 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 stackSumSkyfilePrintObjects( - FILE *stream, ///< a stream - psArray *objects, ///< An array of stackSumSkyfileRow objects - bool mdcf ///< format as mdconfig or simple -); -/** Formats and prints an stackSumSkyfileRow object - * - * When mdcf is set the formated output is in psMetadataConfig - * format, otherwise it is in a simple tabular format. - * - * @return true on success - */ - -bool stackSumSkyfilePrintObject( - FILE *stream, ///< a stream - stackSumSkyfileRow *object, ///< an stackSumSkyfileRow object - bool mdcf ///< format as mdconfig or simple -); /// @} @@ -8925,3 +8925,3 @@ #endif -#endif // STACKSUMSKYFILE_DB_H +#endif // DETRUNSUMMARY_DB_H