Changeset 10238 for trunk/ippdb/src/ippdb.h
- Timestamp:
- Nov 28, 2006, 12:23:25 PM (20 years ago)
- File:
-
- 1 edited
-
trunk/ippdb/src/ippdb.h (modified) (2 diffs)
Legend:
- Unmodified
- Added
- Removed
-
trunk/ippdb/src/ippdb.h
r10155 r10238 20 20 /* 21 21 * 22 * This file was generated by glueforge 0.3 122 * This file was generated by glueforge 0.32 23 23 * 24 24 * Do NOT directly edit this file. … … 5976 5976 bool mdcf ///< format as mdconfig or simple 5977 5977 ); 5978 /** detMasterFrameRow data structure5979 *5980 * Structure for representing a single row of detMasterFrame table data.5981 */5982 5983 typedef struct {5984 psS32 det_id;5985 psS32 iteration;5986 char *comment;5987 } detMasterFrameRow;5988 5989 /** Creates a new detMasterFrameRow object5990 *5991 * @return A new detMasterFrameRow object or NULL on failure.5992 */5993 5994 detMasterFrameRow *detMasterFrameRowAlloc(5995 psS32 det_id,5996 psS32 iteration,5997 const char *comment5998 );5999 6000 /** Creates a new detMasterFrame table6001 *6002 * @return true on success6003 */6004 6005 bool detMasterFrameCreateTable(6006 psDB *dbh ///< Database handle6007 );6008 6009 /** Deletes a detMasterFrame table6010 *6011 * @return true on success6012 */6013 6014 bool detMasterFrameDropTable(6015 psDB *dbh ///< Database handle6016 );6017 6018 /** Insert a single row into a table6019 *6020 * This function constructs and inserts a single row based on it's parameters.6021 *6022 * @return true on success6023 */6024 6025 bool detMasterFrameInsert(6026 psDB *dbh, ///< Database handle6027 psS32 det_id,6028 psS32 iteration,6029 const char *comment6030 );6031 6032 /** Deletes up to limit rows from the database and returns the number of rows actually deleted.6033 *6034 * @return A The number of rows removed or a negative value on error6035 */6036 6037 long long detMasterFrameDelete(6038 psDB *dbh, ///< Database handle6039 const psMetadata *where, ///< Row match criteria6040 unsigned long long limit ///< Maximum number of elements to delete6041 );6042 6043 /** Insert a single detMasterFrameRow object into a table6044 *6045 * This function constructs and inserts a single row based on it's parameters.6046 *6047 * @return true on success6048 */6049 6050 bool detMasterFrameInsertObject(6051 psDB *dbh, ///< Database handle6052 detMasterFrameRow *object ///< detMasterFrameRow object6053 );6054 6055 /** Insert an array of detMasterFrameRow object into a table6056 *6057 * This function constructs and inserts multiple rows based on it's parameters.6058 *6059 * @return true on success6060 */6061 6062 bool detMasterFrameInsertObjects(6063 psDB *dbh, ///< Database handle6064 psArray *objects ///< array of detMasterFrameRow objects6065 );6066 6067 /** Insert data from a binary FITS table detMasterFrameRow into the database6068 *6069 * This function expects a psFits object with a FITS table as the first6070 * extension. The table must have at least one row of data in it, that is of6071 * the appropriate format (number of columns and their type). All other6072 * extensions are ignored.6073 *6074 * @return true on success6075 */6076 6077 bool detMasterFrameInsertFits(6078 psDB *dbh, ///< Database handle6079 const psFits *fits ///< psFits object6080 );6081 6082 /** Selects up to limit from the database and returns them in a binary FITS table6083 *6084 * This function assumes an empty psFits object and will create a FITS table6085 * as the first extension.6086 *6087 * See psDBSelectRows() for documentation on the format of where.6088 *6089 * @return true on success6090 */6091 6092 bool detMasterFrameSelectRowsFits(6093 psDB *dbh, ///< Database handle6094 psFits *fits, ///< psFits object6095 const psMetadata *where, ///< Row match criteria6096 unsigned long long limit ///< Maximum number of elements to return6097 );6098 6099 /** Convert a detMasterFrameRow into an equivalent psMetadata6100 *6101 * @return A psMetadata pointer or NULL on error6102 */6103 6104 psMetadata *detMasterFrameMetadataFromObject(6105 const detMasterFrameRow *object ///< fooRow to convert into a psMetadata6106 );6107 6108 /** Convert a psMetadata into an equivalent fooRow6109 *6110 * @return A detMasterFrameRow pointer or NULL on error6111 */6112 6113 detMasterFrameRow *detMasterFrameObjectFromMetadata(6114 psMetadata *md ///< psMetadata to convert into a fooRow6115 );6116 /** Selects up to limit rows from the database and returns as detMasterFrameRow objects in a psArray6117 *6118 * See psDBSelectRows() for documentation on the format of where.6119 *6120 * @return A psArray pointer or NULL on error6121 */6122 6123 psArray *detMasterFrameSelectRowObjects(6124 psDB *dbh, ///< Database handle6125 const psMetadata *where, ///< Row match criteria6126 unsigned long long limit ///< Maximum number of elements to return6127 );6128 /** Deletes a row from the database coresponding to an detMasterFrame6129 *6130 * Note that a 'where' search psMetadata is constructed from each object and6131 * used to find rows to delete.6132 *6133 * @return A The number of rows removed or a negative value on error6134 */6135 6136 bool detMasterFrameDeleteObject(6137 psDB *dbh, ///< Database handle6138 const detMasterFrameRow *object ///< Object to delete6139 );6140 /** Deletes up to limit rows from the database and returns the number of rows actually deleted.6141 *6142 * Note that a 'where' search psMetadata is constructed from each object and6143 * used to find rows to delete.6144 *6145 * @return A The number of rows removed or a negative value on error6146 */6147 6148 long long detMasterFrameDeleteRowObjects(6149 psDB *dbh, ///< Database handle6150 const psArray *objects, ///< Array of objects to delete6151 unsigned long long limit ///< Maximum number of elements to delete6152 );6153 /** Formats and prints an array of detMasterFrameRow objects6154 *6155 * When mdcf is set the formated output is in psMetadataConfig6156 * format, otherwise it is in a simple tabular format.6157 *6158 * @return true on success6159 */6160 6161 bool detMasterFramePrintObjects(6162 FILE *stream, ///< a stream6163 psArray *objects, ///< An array of detMasterFrameRow objects6164 bool mdcf ///< format as mdconfig or simple6165 );6166 /** detMasterImfileRow data structure6167 *6168 * Structure for representing a single row of detMasterImfile table data.6169 */6170 6171 typedef struct {6172 psS32 det_id;6173 char *class_id;6174 char *uri;6175 char *recipe;6176 } detMasterImfileRow;6177 6178 /** Creates a new detMasterImfileRow object6179 *6180 * @return A new detMasterImfileRow object or NULL on failure.6181 */6182 6183 detMasterImfileRow *detMasterImfileRowAlloc(6184 psS32 det_id,6185 const char *class_id,6186 const char *uri,6187 const char *recipe6188 );6189 6190 /** Creates a new detMasterImfile table6191 *6192 * @return true on success6193 */6194 6195 bool detMasterImfileCreateTable(6196 psDB *dbh ///< Database handle6197 );6198 6199 /** Deletes a detMasterImfile table6200 *6201 * @return true on success6202 */6203 6204 bool detMasterImfileDropTable(6205 psDB *dbh ///< Database handle6206 );6207 6208 /** Insert a single row into a table6209 *6210 * This function constructs and inserts a single row based on it's parameters.6211 *6212 * @return true on success6213 */6214 6215 bool detMasterImfileInsert(6216 psDB *dbh, ///< Database handle6217 psS32 det_id,6218 const char *class_id,6219 const char *uri,6220 const char *recipe6221 );6222 6223 /** Deletes up to limit rows from the database and returns the number of rows actually deleted.6224 *6225 * @return A The number of rows removed or a negative value on error6226 */6227 6228 long long detMasterImfileDelete(6229 psDB *dbh, ///< Database handle6230 const psMetadata *where, ///< Row match criteria6231 unsigned long long limit ///< Maximum number of elements to delete6232 );6233 6234 /** Insert a single detMasterImfileRow object into a table6235 *6236 * This function constructs and inserts a single row based on it's parameters.6237 *6238 * @return true on success6239 */6240 6241 bool detMasterImfileInsertObject(6242 psDB *dbh, ///< Database handle6243 detMasterImfileRow *object ///< detMasterImfileRow object6244 );6245 6246 /** Insert an array of detMasterImfileRow object into a table6247 *6248 * This function constructs and inserts multiple rows based on it's parameters.6249 *6250 * @return true on success6251 */6252 6253 bool detMasterImfileInsertObjects(6254 psDB *dbh, ///< Database handle6255 psArray *objects ///< array of detMasterImfileRow objects6256 );6257 6258 /** Insert data from a binary FITS table detMasterImfileRow into the database6259 *6260 * This function expects a psFits object with a FITS table as the first6261 * extension. The table must have at least one row of data in it, that is of6262 * the appropriate format (number of columns and their type). All other6263 * extensions are ignored.6264 *6265 * @return true on success6266 */6267 6268 bool detMasterImfileInsertFits(6269 psDB *dbh, ///< Database handle6270 const psFits *fits ///< psFits object6271 );6272 6273 /** Selects up to limit from the database and returns them in a binary FITS table6274 *6275 * This function assumes an empty psFits object and will create a FITS table6276 * as the first extension.6277 *6278 * See psDBSelectRows() for documentation on the format of where.6279 *6280 * @return true on success6281 */6282 6283 bool detMasterImfileSelectRowsFits(6284 psDB *dbh, ///< Database handle6285 psFits *fits, ///< psFits object6286 const psMetadata *where, ///< Row match criteria6287 unsigned long long limit ///< Maximum number of elements to return6288 );6289 6290 /** Convert a detMasterImfileRow into an equivalent psMetadata6291 *6292 * @return A psMetadata pointer or NULL on error6293 */6294 6295 psMetadata *detMasterImfileMetadataFromObject(6296 const detMasterImfileRow *object ///< fooRow to convert into a psMetadata6297 );6298 6299 /** Convert a psMetadata into an equivalent fooRow6300 *6301 * @return A detMasterImfileRow pointer or NULL on error6302 */6303 6304 detMasterImfileRow *detMasterImfileObjectFromMetadata(6305 psMetadata *md ///< psMetadata to convert into a fooRow6306 );6307 /** Selects up to limit rows from the database and returns as detMasterImfileRow objects in a psArray6308 *6309 * See psDBSelectRows() for documentation on the format of where.6310 *6311 * @return A psArray pointer or NULL on error6312 */6313 6314 psArray *detMasterImfileSelectRowObjects(6315 psDB *dbh, ///< Database handle6316 const psMetadata *where, ///< Row match criteria6317 unsigned long long limit ///< Maximum number of elements to return6318 );6319 /** Deletes a row from the database coresponding to an detMasterImfile6320 *6321 * Note that a 'where' search psMetadata is constructed from each object and6322 * used to find rows to delete.6323 *6324 * @return A The number of rows removed or a negative value on error6325 */6326 6327 bool detMasterImfileDeleteObject(6328 psDB *dbh, ///< Database handle6329 const detMasterImfileRow *object ///< Object to delete6330 );6331 /** Deletes up to limit rows from the database and returns the number of rows actually deleted.6332 *6333 * Note that a 'where' search psMetadata is constructed from each object and6334 * used to find rows to delete.6335 *6336 * @return A The number of rows removed or a negative value on error6337 */6338 6339 long long detMasterImfileDeleteRowObjects(6340 psDB *dbh, ///< Database handle6341 const psArray *objects, ///< Array of objects to delete6342 unsigned long long limit ///< Maximum number of elements to delete6343 );6344 /** Formats and prints an array of detMasterImfileRow objects6345 *6346 * When mdcf is set the formated output is in psMetadataConfig6347 * format, otherwise it is in a simple tabular format.6348 *6349 * @return true on success6350 */6351 6352 bool detMasterImfilePrintObjects(6353 FILE *stream, ///< a stream6354 psArray *objects, ///< An array of detMasterImfileRow objects6355 bool mdcf ///< format as mdconfig or simple6356 );6357 5978 /** detResidImfileRow data structure 6358 5979 *
Note:
See TracChangeset
for help on using the changeset viewer.
