Changeset 10748 for trunk/ippdb/src/ippdb.h
- Timestamp:
- Dec 15, 2006, 12:20:35 PM (20 years ago)
- File:
-
- 1 edited
-
trunk/ippdb/src/ippdb.h (modified) (16 diffs)
Legend:
- Unmodified
- Added
- Removed
-
trunk/ippdb/src/ippdb.h
r10686 r10748 7439 7439 bool mdcf ///< format as mdconfig or simple 7440 7440 ); 7441 /** p4 PWarpedImfileRow data structure7442 * 7443 * Structure for representing a single row of p4 PWarpedImfile table data.7441 /** p4WarpedImfileRow data structure 7442 * 7443 * Structure for representing a single row of p4WarpedImfile table data. 7444 7444 */ 7445 7445 … … 7452 7452 char *b1_uri; 7453 7453 char *b2_uri; 7454 } p4 PWarpedImfileRow;7455 7456 /** Creates a new p4 PWarpedImfileRow object7457 * 7458 * @return A new p4 PWarpedImfileRow object or NULL on failure.7459 */ 7460 7461 p4 PWarpedImfileRow *p4PWarpedImfileRowAlloc(7454 } p4WarpedImfileRow; 7455 7456 /** Creates a new p4WarpedImfileRow object 7457 * 7458 * @return A new p4WarpedImfileRow object or NULL on failure. 7459 */ 7460 7461 p4WarpedImfileRow *p4WarpedImfileRowAlloc( 7462 7462 psS32 p4_id, 7463 7463 const char *exp_tag, … … 7469 7469 ); 7470 7470 7471 /** Creates a new p4 PWarpedImfile table7472 * 7473 * @return true on success 7474 */ 7475 7476 bool p4 PWarpedImfileCreateTable(7471 /** Creates a new p4WarpedImfile table 7472 * 7473 * @return true on success 7474 */ 7475 7476 bool p4WarpedImfileCreateTable( 7477 7477 psDB *dbh ///< Database handle 7478 7478 ); 7479 7479 7480 /** Deletes a p4 PWarpedImfile table7481 * 7482 * @return true on success 7483 */ 7484 7485 bool p4 PWarpedImfileDropTable(7480 /** Deletes a p4WarpedImfile table 7481 * 7482 * @return true on success 7483 */ 7484 7485 bool p4WarpedImfileDropTable( 7486 7486 psDB *dbh ///< Database handle 7487 7487 ); … … 7494 7494 */ 7495 7495 7496 bool p4 PWarpedImfileInsert(7496 bool p4WarpedImfileInsert( 7497 7497 psDB *dbh, ///< Database handle 7498 7498 psS32 p4_id, … … 7510 7510 */ 7511 7511 7512 long long p4 PWarpedImfileDelete(7512 long long p4WarpedImfileDelete( 7513 7513 psDB *dbh, ///< Database handle 7514 7514 const psMetadata *where, ///< Row match criteria … … 7516 7516 ); 7517 7517 7518 /** Insert a single p4 PWarpedImfileRow object into a table7518 /** Insert a single p4WarpedImfileRow object into a table 7519 7519 * 7520 7520 * This function constructs and inserts a single row based on it's parameters. … … 7523 7523 */ 7524 7524 7525 bool p4 PWarpedImfileInsertObject(7526 psDB *dbh, ///< Database handle 7527 p4 PWarpedImfileRow *object ///< p4PWarpedImfileRow object7528 ); 7529 7530 /** Insert an array of p4 PWarpedImfileRow object into a table7525 bool p4WarpedImfileInsertObject( 7526 psDB *dbh, ///< Database handle 7527 p4WarpedImfileRow *object ///< p4WarpedImfileRow object 7528 ); 7529 7530 /** Insert an array of p4WarpedImfileRow object into a table 7531 7531 * 7532 7532 * This function constructs and inserts multiple rows based on it's parameters. … … 7535 7535 */ 7536 7536 7537 bool p4 PWarpedImfileInsertObjects(7538 psDB *dbh, ///< Database handle 7539 psArray *objects ///< array of p4 PWarpedImfileRow objects7540 ); 7541 7542 /** Insert data from a binary FITS table p4 PWarpedImfileRow into the database7537 bool p4WarpedImfileInsertObjects( 7538 psDB *dbh, ///< Database handle 7539 psArray *objects ///< array of p4WarpedImfileRow objects 7540 ); 7541 7542 /** Insert data from a binary FITS table p4WarpedImfileRow into the database 7543 7543 * 7544 7544 * This function expects a psFits object with a FITS table as the first … … 7550 7550 */ 7551 7551 7552 bool p4 PWarpedImfileInsertFits(7552 bool p4WarpedImfileInsertFits( 7553 7553 psDB *dbh, ///< Database handle 7554 7554 const psFits *fits ///< psFits object … … 7565 7565 */ 7566 7566 7567 bool p4 PWarpedImfileSelectRowsFits(7567 bool p4WarpedImfileSelectRowsFits( 7568 7568 psDB *dbh, ///< Database handle 7569 7569 psFits *fits, ///< psFits object … … 7572 7572 ); 7573 7573 7574 /** Convert a p4 PWarpedImfileRow into an equivalent psMetadata7574 /** Convert a p4WarpedImfileRow into an equivalent psMetadata 7575 7575 * 7576 7576 * @return A psMetadata pointer or NULL on error 7577 7577 */ 7578 7578 7579 psMetadata *p4 PWarpedImfileMetadataFromObject(7580 const p4 PWarpedImfileRow *object ///< fooRow to convert into a psMetadata7579 psMetadata *p4WarpedImfileMetadataFromObject( 7580 const p4WarpedImfileRow *object ///< fooRow to convert into a psMetadata 7581 7581 ); 7582 7582 7583 7583 /** Convert a psMetadata into an equivalent fooRow 7584 7584 * 7585 * @return A p4 PWarpedImfileRow pointer or NULL on error7586 */ 7587 7588 p4 PWarpedImfileRow *p4PWarpedImfileObjectFromMetadata(7585 * @return A p4WarpedImfileRow pointer or NULL on error 7586 */ 7587 7588 p4WarpedImfileRow *p4WarpedImfileObjectFromMetadata( 7589 7589 psMetadata *md ///< psMetadata to convert into a fooRow 7590 7590 ); 7591 /** Selects up to limit rows from the database and returns as p4 PWarpedImfileRow objects in a psArray7591 /** Selects up to limit rows from the database and returns as p4WarpedImfileRow objects in a psArray 7592 7592 * 7593 7593 * See psDBSelectRows() for documentation on the format of where. … … 7596 7596 */ 7597 7597 7598 psArray *p4 PWarpedImfileSelectRowObjects(7598 psArray *p4WarpedImfileSelectRowObjects( 7599 7599 psDB *dbh, ///< Database handle 7600 7600 const psMetadata *where, ///< Row match criteria 7601 7601 unsigned long long limit ///< Maximum number of elements to return 7602 7602 ); 7603 /** Deletes a row from the database coresponding to an p4 PWarpedImfile7603 /** Deletes a row from the database coresponding to an p4WarpedImfile 7604 7604 * 7605 7605 * Note that a 'where' search psMetadata is constructed from each object and … … 7609 7609 */ 7610 7610 7611 bool p4 PWarpedImfileDeleteObject(7612 psDB *dbh, ///< Database handle 7613 const p4 PWarpedImfileRow *object ///< Object to delete7611 bool p4WarpedImfileDeleteObject( 7612 psDB *dbh, ///< Database handle 7613 const p4WarpedImfileRow *object ///< Object to delete 7614 7614 ); 7615 7615 /** Deletes up to limit rows from the database and returns the number of rows actually deleted. … … 7621 7621 */ 7622 7622 7623 long long p4 PWarpedImfileDeleteRowObjects(7623 long long p4WarpedImfileDeleteRowObjects( 7624 7624 psDB *dbh, ///< Database handle 7625 7625 const psArray *objects, ///< Array of objects to delete 7626 7626 unsigned long long limit ///< Maximum number of elements to delete 7627 7627 ); 7628 /** Formats and prints an array of p4 PWarpedImfileRow objects7628 /** Formats and prints an array of p4WarpedImfileRow objects 7629 7629 * 7630 7630 * When mdcf is set the formated output is in psMetadataConfig … … 7634 7634 */ 7635 7635 7636 bool p4 PWarpedImfilePrintObjects(7636 bool p4WarpedImfilePrintObjects( 7637 7637 FILE *stream, ///< a stream 7638 psArray *objects, ///< An array of p4 PWarpedImfileRow objects7638 psArray *objects, ///< An array of p4WarpedImfileRow objects 7639 7639 bool mdcf ///< format as mdconfig or simple 7640 7640 ); 7641 /** Formats and prints an p4 PWarpedImfileRow object7641 /** Formats and prints an p4WarpedImfileRow object 7642 7642 * 7643 7643 * When mdcf is set the formated output is in psMetadataConfig … … 7647 7647 */ 7648 7648 7649 bool p4 PWarpedImfilePrintObject(7649 bool p4WarpedImfilePrintObject( 7650 7650 FILE *stream, ///< a stream 7651 p4 PWarpedImfileRow *object, ///< an p4PWarpedImfileRow object7651 p4WarpedImfileRow *object, ///< an p4WarpedImfileRow object 7652 7652 bool mdcf ///< format as mdconfig or simple 7653 7653 );
Note:
See TracChangeset
for help on using the changeset viewer.
