Changeset 8380 for trunk/ippdb/src/ippdb.h
- Timestamp:
- Aug 15, 2006, 6:14:10 PM (20 years ago)
- File:
-
- 1 edited
-
trunk/ippdb/src/ippdb.h (modified) (38 diffs)
Legend:
- Unmodified
- Added
- Removed
-
trunk/ippdb/src/ippdb.h
r8368 r8380 6516 6516 char *class_id; 6517 6517 char *uri; 6518 char *recipe;6519 6518 } detNormalizedImfileRow; 6520 6519 … … 6528 6527 psS32 iteration, 6529 6528 const char *class_id, 6530 const char *uri, 6531 const char *recipe 6529 const char *uri 6532 6530 ); 6533 6531 … … 6562 6560 psS32 iteration, 6563 6561 const char *class_id, 6564 const char *uri, 6565 const char *recipe 6562 const char *uri 6566 6563 ); 6567 6564 … … 6587 6584 psS32 *iteration, 6588 6585 char **class_id, 6589 char **uri, 6590 char **recipe 6586 char **uri 6591 6587 ); 6592 6588 … … 7187 7183 bool mdcf ///< format as mdconfig or simple 7188 7184 ); 7189 /** detResidImfile AnalysisRow data structure7190 * 7191 * Structure for representing a single row of detResidImfile Analysistable data.7185 /** detResidImfileRow data structure 7186 * 7187 * Structure for representing a single row of detResidImfile table data. 7192 7188 */ 7193 7189 … … 7201 7197 char *b1_uri; 7202 7198 char *b2_uri; 7203 } detResidImfile AnalysisRow;7204 7205 /** Creates a new detResidImfile AnalysisRow object7206 * 7207 * @return A new detResidImfile AnalysisRow object or NULL on failure.7208 */ 7209 7210 detResidImfile AnalysisRow *detResidImfileAnalysisRowAlloc(7199 } detResidImfileRow; 7200 7201 /** Creates a new detResidImfileRow object 7202 * 7203 * @return A new detResidImfileRow object or NULL on failure. 7204 */ 7205 7206 detResidImfileRow *detResidImfileRowAlloc( 7211 7207 psS32 det_id, 7212 7208 psS32 iteration, … … 7219 7215 ); 7220 7216 7221 /** Creates a new detResidImfile Analysistable7222 * 7223 * @return true on success 7224 */ 7225 7226 bool detResidImfile AnalysisCreateTable(7227 psDB *dbh ///< Database handle 7228 ); 7229 7230 /** Deletes a detResidImfile Analysistable7231 * 7232 * @return true on success 7233 */ 7234 7235 bool detResidImfile AnalysisDropTable(7217 /** Creates a new detResidImfile table 7218 * 7219 * @return true on success 7220 */ 7221 7222 bool detResidImfileCreateTable( 7223 psDB *dbh ///< Database handle 7224 ); 7225 7226 /** Deletes a detResidImfile table 7227 * 7228 * @return true on success 7229 */ 7230 7231 bool detResidImfileDropTable( 7236 7232 psDB *dbh ///< Database handle 7237 7233 ); … … 7244 7240 */ 7245 7241 7246 bool detResidImfile AnalysisInsert(7242 bool detResidImfileInsert( 7247 7243 psDB *dbh, ///< Database handle 7248 7244 psS32 det_id, … … 7261 7257 */ 7262 7258 7263 long long detResidImfile AnalysisDelete(7259 long long detResidImfileDelete( 7264 7260 psDB *dbh, ///< Database handle 7265 7261 const psMetadata *where, ///< Row match criteria … … 7272 7268 */ 7273 7269 7274 bool detResidImfile AnalysisPop(7270 bool detResidImfilePop( 7275 7271 psDB *dbh, ///< Database handle 7276 7272 psS32 *det_id, … … 7284 7280 ); 7285 7281 7286 /** Insert a single detResidImfile AnalysisRow object into a table7282 /** Insert a single detResidImfileRow object into a table 7287 7283 * 7288 7284 * This function constructs and inserts a single row based on it's parameters. … … 7291 7287 */ 7292 7288 7293 bool detResidImfile AnalysisInsertObject(7294 psDB *dbh, ///< Database handle 7295 detResidImfile AnalysisRow *object ///< detResidImfileAnalysisRow object7296 ); 7297 7298 /** Insert an array of detResidImfile AnalysisRow object into a table7289 bool detResidImfileInsertObject( 7290 psDB *dbh, ///< Database handle 7291 detResidImfileRow *object ///< detResidImfileRow object 7292 ); 7293 7294 /** Insert an array of detResidImfileRow object into a table 7299 7295 * 7300 7296 * This function constructs and inserts multiple rows based on it's parameters. … … 7303 7299 */ 7304 7300 7305 bool detResidImfile AnalysisInsertObjects(7306 psDB *dbh, ///< Database handle 7307 psArray *objects ///< array of detResidImfile AnalysisRow objects7301 bool detResidImfileInsertObjects( 7302 psDB *dbh, ///< Database handle 7303 psArray *objects ///< array of detResidImfileRow objects 7308 7304 ); 7309 7305 7310 7306 /** Removes the last row from the database and returns it 7311 7307 * 7312 * @return A new detResidImfile AnalysisRow on success or NULL on failure.7313 */ 7314 7315 detResidImfile AnalysisRow *detResidImfileAnalysisPopObject(7316 psDB *dbh ///< Database handle 7317 ); 7318 7319 /** Insert data from a binary FITS table detResidImfile AnalysisRow into the database7308 * @return A new detResidImfileRow on success or NULL on failure. 7309 */ 7310 7311 detResidImfileRow *detResidImfilePopObject( 7312 psDB *dbh ///< Database handle 7313 ); 7314 7315 /** Insert data from a binary FITS table detResidImfileRow into the database 7320 7316 * 7321 7317 * This function expects a psFits object with a FITS table as the first … … 7327 7323 */ 7328 7324 7329 bool detResidImfile AnalysisInsertFits(7325 bool detResidImfileInsertFits( 7330 7326 psDB *dbh, ///< Database handle 7331 7327 const psFits *fits ///< psFits object … … 7340 7336 */ 7341 7337 7342 bool detResidImfile AnalysisPopFits(7338 bool detResidImfilePopFits( 7343 7339 psDB *dbh, ///< Database handle 7344 7340 psFits *fits, ///< psFits object … … 7356 7352 */ 7357 7353 7358 bool detResidImfile AnalysisSelectRowsFits(7354 bool detResidImfileSelectRowsFits( 7359 7355 psDB *dbh, ///< Database handle 7360 7356 psFits *fits, ///< psFits object … … 7363 7359 ); 7364 7360 7365 /** Convert a detResidImfile AnalysisRow into an equivalent psMetadata7361 /** Convert a detResidImfileRow into an equivalent psMetadata 7366 7362 * 7367 7363 * @return A psMetadata pointer or NULL on error 7368 7364 */ 7369 7365 7370 psMetadata *detResidImfile AnalysisMetadataFromObject(7371 const detResidImfile AnalysisRow *object ///< fooRow to convert into a psMetadata7366 psMetadata *detResidImfileMetadataFromObject( 7367 const detResidImfileRow *object ///< fooRow to convert into a psMetadata 7372 7368 ); 7373 7369 7374 7370 /** Convert a psMetadata into an equivalent fooRow 7375 7371 * 7376 * @return A detResidImfile AnalysisRow pointer or NULL on error7377 */ 7378 7379 detResidImfile AnalysisRow *detResidImfileAnalysisObjectFromMetadata(7372 * @return A detResidImfileRow pointer or NULL on error 7373 */ 7374 7375 detResidImfileRow *detResidImfileObjectFromMetadata( 7380 7376 psMetadata *md ///< psMetadata to convert into a fooRow 7381 7377 ); 7382 /** Selects up to limit rows from the database and returns as detResidImfile AnalysisRow objects in a psArray7378 /** Selects up to limit rows from the database and returns as detResidImfileRow objects in a psArray 7383 7379 * 7384 7380 * See psDBSelectRows() for documentation on the format of where. … … 7387 7383 */ 7388 7384 7389 psArray *detResidImfile AnalysisSelectRowObjects(7390 psDB *dbh, ///< Database handle 7391 const psMetadata *where, ///< Row match criteria 7392 unsigned long long limit ///< Maximum number of elements to return 7393 ); 7394 /** Deletes a row from the database coresponding to an detResidImfile Analysis7385 psArray *detResidImfileSelectRowObjects( 7386 psDB *dbh, ///< Database handle 7387 const psMetadata *where, ///< Row match criteria 7388 unsigned long long limit ///< Maximum number of elements to return 7389 ); 7390 /** Deletes a row from the database coresponding to an detResidImfile 7395 7391 * 7396 7392 * Note that a 'where' search psMetadata is constructed from each object and … … 7400 7396 */ 7401 7397 7402 bool detResidImfile AnalysisDeleteObject(7403 psDB *dbh, ///< Database handle 7404 const detResidImfile AnalysisRow *object ///< Object to delete7398 bool detResidImfileDeleteObject( 7399 psDB *dbh, ///< Database handle 7400 const detResidImfileRow *object ///< Object to delete 7405 7401 ); 7406 7402 /** Deletes up to limit rows from the database and returns the number of rows actually deleted. … … 7412 7408 */ 7413 7409 7414 long long detResidImfile AnalysisDeleteRowObjects(7410 long long detResidImfileDeleteRowObjects( 7415 7411 psDB *dbh, ///< Database handle 7416 7412 const psArray *objects, ///< Array of objects to delete 7417 7413 unsigned long long limit ///< Maximum number of elements to delete 7418 7414 ); 7419 /** Formats and prints an array of detResidImfile AnalysisRow objects7415 /** Formats and prints an array of detResidImfileRow objects 7420 7416 * 7421 7417 * When mdcf is set the formated output is in psMetadataConfig … … 7425 7421 */ 7426 7422 7427 bool detResidImfile AnalysisPrintObjects(7423 bool detResidImfilePrintObjects( 7428 7424 FILE *stream, ///< a stream 7429 psArray *objects, ///< An array of detResidImfile AnalysisRow objects7425 psArray *objects, ///< An array of detResidImfileRow objects 7430 7426 bool mdcf ///< format as mdconfig or simple 7431 7427 ); 7432 /** detResidExp AnalysisRow data structure7433 * 7434 * Structure for representing a single row of detResidExp Analysistable data.7428 /** detResidExpRow data structure 7429 * 7430 * Structure for representing a single row of detResidExp table data. 7435 7431 */ 7436 7432 … … 7442 7438 bool keep; 7443 7439 bool accept; 7444 } detResidExp AnalysisRow;7445 7446 /** Creates a new detResidExp AnalysisRow object7447 * 7448 * @return A new detResidExp AnalysisRow object or NULL on failure.7449 */ 7450 7451 detResidExp AnalysisRow *detResidExpAnalysisRowAlloc(7440 } detResidExpRow; 7441 7442 /** Creates a new detResidExpRow object 7443 * 7444 * @return A new detResidExpRow object or NULL on failure. 7445 */ 7446 7447 detResidExpRow *detResidExpRowAlloc( 7452 7448 psS32 det_id, 7453 7449 psS32 iteration, … … 7458 7454 ); 7459 7455 7460 /** Creates a new detResidExp Analysistable7461 * 7462 * @return true on success 7463 */ 7464 7465 bool detResidExp AnalysisCreateTable(7466 psDB *dbh ///< Database handle 7467 ); 7468 7469 /** Deletes a detResidExp Analysistable7470 * 7471 * @return true on success 7472 */ 7473 7474 bool detResidExp AnalysisDropTable(7456 /** Creates a new detResidExp table 7457 * 7458 * @return true on success 7459 */ 7460 7461 bool detResidExpCreateTable( 7462 psDB *dbh ///< Database handle 7463 ); 7464 7465 /** Deletes a detResidExp table 7466 * 7467 * @return true on success 7468 */ 7469 7470 bool detResidExpDropTable( 7475 7471 psDB *dbh ///< Database handle 7476 7472 ); … … 7483 7479 */ 7484 7480 7485 bool detResidExp AnalysisInsert(7481 bool detResidExpInsert( 7486 7482 psDB *dbh, ///< Database handle 7487 7483 psS32 det_id, … … 7498 7494 */ 7499 7495 7500 long long detResidExp AnalysisDelete(7496 long long detResidExpDelete( 7501 7497 psDB *dbh, ///< Database handle 7502 7498 const psMetadata *where, ///< Row match criteria … … 7509 7505 */ 7510 7506 7511 bool detResidExp AnalysisPop(7507 bool detResidExpPop( 7512 7508 psDB *dbh, ///< Database handle 7513 7509 psS32 *det_id, … … 7519 7515 ); 7520 7516 7521 /** Insert a single detResidExp AnalysisRow object into a table7517 /** Insert a single detResidExpRow object into a table 7522 7518 * 7523 7519 * This function constructs and inserts a single row based on it's parameters. … … 7526 7522 */ 7527 7523 7528 bool detResidExp AnalysisInsertObject(7529 psDB *dbh, ///< Database handle 7530 detResidExp AnalysisRow *object ///< detResidExpAnalysisRow object7531 ); 7532 7533 /** Insert an array of detResidExp AnalysisRow object into a table7524 bool detResidExpInsertObject( 7525 psDB *dbh, ///< Database handle 7526 detResidExpRow *object ///< detResidExpRow object 7527 ); 7528 7529 /** Insert an array of detResidExpRow object into a table 7534 7530 * 7535 7531 * This function constructs and inserts multiple rows based on it's parameters. … … 7538 7534 */ 7539 7535 7540 bool detResidExp AnalysisInsertObjects(7541 psDB *dbh, ///< Database handle 7542 psArray *objects ///< array of detResidExp AnalysisRow objects7536 bool detResidExpInsertObjects( 7537 psDB *dbh, ///< Database handle 7538 psArray *objects ///< array of detResidExpRow objects 7543 7539 ); 7544 7540 7545 7541 /** Removes the last row from the database and returns it 7546 7542 * 7547 * @return A new detResidExp AnalysisRow on success or NULL on failure.7548 */ 7549 7550 detResidExp AnalysisRow *detResidExpAnalysisPopObject(7551 psDB *dbh ///< Database handle 7552 ); 7553 7554 /** Insert data from a binary FITS table detResidExp AnalysisRow into the database7543 * @return A new detResidExpRow on success or NULL on failure. 7544 */ 7545 7546 detResidExpRow *detResidExpPopObject( 7547 psDB *dbh ///< Database handle 7548 ); 7549 7550 /** Insert data from a binary FITS table detResidExpRow into the database 7555 7551 * 7556 7552 * This function expects a psFits object with a FITS table as the first … … 7562 7558 */ 7563 7559 7564 bool detResidExp AnalysisInsertFits(7560 bool detResidExpInsertFits( 7565 7561 psDB *dbh, ///< Database handle 7566 7562 const psFits *fits ///< psFits object … … 7575 7571 */ 7576 7572 7577 bool detResidExp AnalysisPopFits(7573 bool detResidExpPopFits( 7578 7574 psDB *dbh, ///< Database handle 7579 7575 psFits *fits, ///< psFits object … … 7591 7587 */ 7592 7588 7593 bool detResidExp AnalysisSelectRowsFits(7589 bool detResidExpSelectRowsFits( 7594 7590 psDB *dbh, ///< Database handle 7595 7591 psFits *fits, ///< psFits object … … 7598 7594 ); 7599 7595 7600 /** Convert a detResidExp AnalysisRow into an equivalent psMetadata7596 /** Convert a detResidExpRow into an equivalent psMetadata 7601 7597 * 7602 7598 * @return A psMetadata pointer or NULL on error 7603 7599 */ 7604 7600 7605 psMetadata *detResidExp AnalysisMetadataFromObject(7606 const detResidExp AnalysisRow *object ///< fooRow to convert into a psMetadata7601 psMetadata *detResidExpMetadataFromObject( 7602 const detResidExpRow *object ///< fooRow to convert into a psMetadata 7607 7603 ); 7608 7604 7609 7605 /** Convert a psMetadata into an equivalent fooRow 7610 7606 * 7611 * @return A detResidExp AnalysisRow pointer or NULL on error7612 */ 7613 7614 detResidExp AnalysisRow *detResidExpAnalysisObjectFromMetadata(7607 * @return A detResidExpRow pointer or NULL on error 7608 */ 7609 7610 detResidExpRow *detResidExpObjectFromMetadata( 7615 7611 psMetadata *md ///< psMetadata to convert into a fooRow 7616 7612 ); 7617 /** Selects up to limit rows from the database and returns as detResidExp AnalysisRow objects in a psArray7613 /** Selects up to limit rows from the database and returns as detResidExpRow objects in a psArray 7618 7614 * 7619 7615 * See psDBSelectRows() for documentation on the format of where. … … 7622 7618 */ 7623 7619 7624 psArray *detResidExp AnalysisSelectRowObjects(7625 psDB *dbh, ///< Database handle 7626 const psMetadata *where, ///< Row match criteria 7627 unsigned long long limit ///< Maximum number of elements to return 7628 ); 7629 /** Deletes a row from the database coresponding to an detResidExp Analysis7620 psArray *detResidExpSelectRowObjects( 7621 psDB *dbh, ///< Database handle 7622 const psMetadata *where, ///< Row match criteria 7623 unsigned long long limit ///< Maximum number of elements to return 7624 ); 7625 /** Deletes a row from the database coresponding to an detResidExp 7630 7626 * 7631 7627 * Note that a 'where' search psMetadata is constructed from each object and … … 7635 7631 */ 7636 7632 7637 bool detResidExp AnalysisDeleteObject(7638 psDB *dbh, ///< Database handle 7639 const detResidExp AnalysisRow *object ///< Object to delete7633 bool detResidExpDeleteObject( 7634 psDB *dbh, ///< Database handle 7635 const detResidExpRow *object ///< Object to delete 7640 7636 ); 7641 7637 /** Deletes up to limit rows from the database and returns the number of rows actually deleted. … … 7647 7643 */ 7648 7644 7649 long long detResidExp AnalysisDeleteRowObjects(7645 long long detResidExpDeleteRowObjects( 7650 7646 psDB *dbh, ///< Database handle 7651 7647 const psArray *objects, ///< Array of objects to delete 7652 7648 unsigned long long limit ///< Maximum number of elements to delete 7653 7649 ); 7654 /** Formats and prints an array of detResidExp AnalysisRow objects7650 /** Formats and prints an array of detResidExpRow objects 7655 7651 * 7656 7652 * When mdcf is set the formated output is in psMetadataConfig … … 7660 7656 */ 7661 7657 7662 bool detResidExp AnalysisPrintObjects(7658 bool detResidExpPrintObjects( 7663 7659 FILE *stream, ///< a stream 7664 psArray *objects, ///< An array of detResidExp AnalysisRow objects7660 psArray *objects, ///< An array of detResidExpRow objects 7665 7661 bool mdcf ///< format as mdconfig or simple 7666 7662 ); … … 7672 7668 #endif 7673 7669 7674 #endif // DETRESIDEXP ANALYSIS_DB_H7670 #endif // DETRESIDEXP_DB_H
Note:
See TracChangeset
for help on using the changeset viewer.
