/usr/include/ncbi-vdb/sra/wsradb.hpp is in libncbi-vdb-dev 2.8.1+dfsg-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 | /*===========================================================================
*
* PUBLIC DOMAIN NOTICE
* National Center for Biotechnology Information
*
* This software/database is a "United States Government Work" under the
* terms of the United States Copyright Act. It was written as part of
* the author's official duties as a United States Government employee and
* thus cannot be copyrighted. This software/database is freely available
* to the public for use. The National Library of Medicine and the U.S.
* Government have not placed any restriction on its use or reproduction.
*
* Although all reasonable efforts have been taken to ensure the accuracy
* and reliability of the software and data, the NLM and the U.S.
* Government do not and cannot warrant the performance or results that
* may be obtained by using this software or data. The NLM and the U.S.
* Government disclaim all warranties, express or implied, including
* warranties of performance, merchantability or fitness for any particular
* purpose.
*
* Please cite the author in any work or product based on this material.
*
* ===========================================================================
*
*/
#ifndef _hpp_sra_wsradb_
#define _hpp_sra_wsradb_
#ifdef _hpp_sra_sradb_
#error "read and update libraries are mutually exclusive"
#endif
#ifndef _h_sra_wsradb_
#include <sra/wsradb.h>
#endif
/*--------------------------------------------------------------------------
* SRAMgr
* opaque handle to SRA library
*/
struct SRAMgr
{
/* AddRef
* Release
*/
inline rc_t AddRef () const throw()
{ return SRAMgrAddRef ( this ); }
inline rc_t Release () const throw()
{ return SRAMgrRelease ( this ); }
/* Make
* create library handle for read/write access
*
* NB - not implemented in read-only library,
* and the read-only library may not be mixed with read/write
*/
static inline rc_t Make ( SRAMgr **mgr, struct KDirectory *wd = 0 ) throw()
{ return SRAMgrMakeUpdate ( mgr, wd ); }
/* SetMD5Mode
* sets default MD5 file mode for all objects
* opened for update under manager
*/
inline rc_t SetMD5Mode ( bool useMD5 ) throw()
{ return SRAMgrSetMD5Mode ( this, useMD5 ); }
/* Lock
* apply lock
*
* if table is already locked, the operation is idempotent
* and returns an rc state of rcLocked
*
* "path" [ IN ] - NUL terminated table path
*/
inline rc_t Lock ( const char *path, ... ) throw()
{
va_list args;
va_start ( args, path );
rc_t rc = SRAMgrVLock ( this, path, args );
va_end ( args );
return rc;
}
inline rc_t Lock ( const char *path, va_list args ) throw()
{ return SRAMgrVLock ( this, path, args ); }
/* Unlock
* remove lock
*
* if table is already unlocked, the operation is idempotent
* and returns an rc state of rcUnlocked
*
* "path" [ IN ] - NUL terminated table path
*/
inline rc_t SRAMgrUnlock ( SRAMgr *self, const char *path, ... ) throw()
{
va_list args;
va_start ( args, path );
rc_t rc = SRAMgrVUnlock ( this, path, args );
va_end ( args );
return rc;
}
inline rc_t SRAMgrUnlock ( SRAMgr *self, const char *path,
va_list args ) throw()
{ return SRAMgrVUnlock ( this, path, args ); }
/* DropTable
* drop an existing table
*
* "force" [ IN ] - if true, make every attempt to remove table
*
* "path" [ IN ] - NUL terminated table name
*/
inline rc_t DropTable ( bool force, const char *path, ... ) throw()
{
va_list args;
va_start ( args, path );
rc_t rc = SRAMgrVDropTable ( this, force, path, args );
va_end ( args );
return rc;
}
inline rc_t DropTable ( bool force, const char *path, va_list args ) throw()
{ return SRAMgrVDropTable ( this, force, path, args ); }
/* OpenDatatypes
* open datatype registry object for requested access
* see <vdb/types.hpp> for VDatatypes
*
* "dt" [ OUT ] - return parameter for datatypes object
*/
inline rc_t OpenDatatypes ( struct VDatatypes const **dt ) const throw()
{ return SRAMgrOpenDatatypesRead ( this, dt ); }
/* GetSchema
* get a reference to the schema used to create new tables
*
* "schema" [ OUT ] - return parameter for reference to SRA schema
*
* NB - returns a new reference that must be released via VSchemaRelease
*/
inline rc_t GetSchemaRead ( struct VSchema const **schema ) const throw()
{ return SRAMgrGetSchemaRead ( this, schema ); }
/* UseSchema
* allows SRA schema to be entirely replaced
* affects creation/update of all subsequent tables
*
* "schema" [ IN ] - new schema to be applied
*
* NB - manager will attach a new reference to schema object,
* you are still responsible for releasing it via VSchemaRelease
*/
inline rc_t UseSchemaRead ( struct VSchema const *schema ) const throw()
{ return SRAMgrUseSchemaRead ( this, schema ); }
/* Writable
* returns 0 if table is writable
* rcLocked if locked, rcReadonly if read-only
* other code upon error
*
* "path" [ IN ] - NUL terminated table path
*/
inline bool Writable ( const char *path, ... ) const throw()
{
va_list args;
va_start ( args, path );
bool locked = SRAMgrVWritable ( this, path, args );
va_end ( args );
return locked;
}
inline bool Writable ( const char *path, va_list args ) const throw()
{ return SRAMgrVWritable ( this, path, args ); }
/* Create
* creates a new table
*
* "tbl" [ OUT ] - return parameter for table
*
* "typespec" [ IN ] - type and optionally version of table schema,
* e.g. 'MY_NAMESPACE:MyTable' or 'MY_NAMESPACE:MyTable#1.1'
*
* "path" [ IN ] - NUL terminated table name
*/
inline rc_t CreateTable ( SRATable **tbl, const char *typespec,
const char *path, ... ) throw()
{
va_list args;
va_start ( args, path );
rc_t rc = SRAMgrVCreateTable ( this, tbl, typespec, path, args );
va_end ( args );
return rc;
}
inline rc_t CreateTable ( SRATable **tbl, const char *typespec,
const char *path, va_list args ) throw()
{ return SRAMgrVCreateTable ( this, tbl, typespec, path, args ); }
/* OpenTable
* open an existing table for read
*
* "tbl" [ OUT ] - return parameter for table
*
* "path" [ IN ] - NUL terminated run name
*/
inline rc_t OpenTable ( const SRATable **tbl,
const char *path, ... ) const throw()
{
va_list args;
va_start ( args, path );
rc_t rc = SRAMgrVOpenTableRead ( this, tbl, path, args );
va_end ( args );
return rc;
}
inline rc_t OpenTable ( const SRATable **tbl, const char *path,
va_list args ) const throw()
{ return SRAMgrVOpenTableRead ( this, tbl, path, args ); }
inline rc_t OpenTable ( SRATable **tbl, const char *path, ... ) throw()
{
va_list args;
va_start ( args, path );
rc_t rc = SRAMgrVOpenTableUpdate ( this, tbl, path, args );
va_end ( args );
return rc;
}
inline rc_t OpenTable ( SRATable **tbl, const char *path, va_list args ) throw()
{ return SRAMgrVOpenTableUpdate ( this, tbl, path, args ); }
private:
SRAMgr ();
~ SRAMgr ();
SRAMgr ( const SRAMgr& );
SRAMgr &operator = ( const SRAMgr& );
};
/*--------------------------------------------------------------------------
* SRATable
* a collection of spots with several data series, minimally including
* base or color calls and their quality ( confidence ) values, and
* optionally signal-related values ( signal, intensity, noise, ... ).
*/
struct SRATable
{
/* AddRef
* Release
*/
inline rc_t AddRef () const throw()
{ return SRATableAddRef ( this ); }
inline rc_t Release () const throw()
{ return SRATableRelease ( this ); }
/* Locked
* returns true if locked
*/
inline bool Locked () const throw()
{ return SRATableLocked ( this ); }
/* BaseCount
* get the number of stored bases
*
* "num_bases" [ OUT ] - return parameter for base count
*/
inline rc_t BaseCount ( uint64_t *num_bases ) const throw()
{ return SRATableBaseCount ( this, num_bases ); }
/* SpotCount
* get the number of stored spots
*
* "spot_count" [ OUT ] - return parameter for spot count
*/
inline rc_t SpotCount ( uint64_t *spot_count ) const throw()
{ return SRATableSpotCount ( this, spot_count ); }
/* MaxSpotId
* returns the maximum spot id
*
* a table will contain a collection of spots with ids from
* min to max ( spot_id ).
*
* "id" [ OUT ] - return parameter of last spot id
*/
inline rc_t MaxSpotId ( spotid_t *id ) const throw()
{ return SRATableMaxSpotId ( this, id ); }
/* MinSpotId
* returns the minimum spot id
*
* a table will contain a collection of spots with ids from
* min to max ( spot_id ).
*
* "id" [ OUT ] - return parameter of last spot id
*/
inline rc_t MinSpotId ( spotid_t *id ) const throw()
{ return SRATableMinSpotId ( this, id ); }
/* GetSpotId
* project a spot id from a spot name
*
* "id" [ OUT ] - return parameter for 1-based spot id
*
* "spot_name" [ IN ] - external spot name string
*/
inline rc_t GetSpotId ( spotid_t *id, const char *spot_name ) const throw()
{ return SRATableGetSpotId ( this, id, spot_name ); }
/* NewSpot
* creates a new spot record, returning spot id.
*
* "id" [ OUT ] - return parameter for id of newly created spot
*/
inline rc_t NewSpot ( spotid_t *id ) throw()
{ return SRATableNewSpot ( this, id ); }
/* OpenSpot
* opens an existing spot record from id
*
* "id" [ IN ] - 1-based spot id
*/
inline rc_t OpenSpot ( spotid_t id ) throw()
{ return SRATableOpenSpot ( this, id ); }
/* CloseSpot
* closes a spot opened with either NewSpot or OpenSpot
*/
inline rc_t CloseSpot () throw()
{ return SRATableCloseSpot ( this ); }
/* Commit
* commit all changes
*/
inline rc_t Commit () throw()
{ return SRATableCommit ( this ); }
/* ListCol
* returns a list of column names
*
* "names" [ out ] - return parameter for names list
*/
inline rc_t ListCol ( SRANamelist **names ) const throw()
{ return SRATableListCol ( this, names ); }
/* ColDatatypes
* returns list of typedecls for named column
*
* "col" [ IN ] - column name
*
* "dflt_idx" [ OUT, NULL OKAY ] - returns the zero-based index
* into "typedecls" of the default datatype for the named column
*
* "typedecls" [ OUT ] - list of datatypes available for named column
*/
inline rc_t ColDatatypes ( const char *col,
uint32_t *dflt_idx, SRANamelist **typedecls ) const throw()
{ return SRATableColDatatypes ( this, col, dflt_idx, typedecls ); }
/* OpenColumn
* open a column for read
*
* "col" [ OUT ] - return parameter for newly opened column
*
* "name" [ IN ] - NUL terminated string in UTF-8 giving column name
*
* "datatype" [ IN - NULL OKAY ] - optional NUL terminated
* string describing fully qualified column data type in ASCII
*/
inline rc_t OpenColumn ( const SRAColumn **col,
const char *name, const char *datatype = 0 ) const throw()
{ return SRATableOpenColumnRead ( this, col, name, datatype ); }
/* OpenColumn
* open a column for write
*
* "idx" [ OUT ] - return parameter for 1-based column index.
*
* "col" [ OUT, NULL OKAY ] - optional return parameter for
* newly opened column.
*
* "name" [ IN ] - NUL terminated string in UTF-8 giving column name
*
* "datatype" [ IN ] - NUL terminated string in ASCII
* describing fully qualified column data type
*/
inline rc_t OpenColumn ( uint32_t *idx, SRAColumn **col,
const char *name, const char *datatype ) throw()
{ return SRATableOpenColumnWrite ( this, idx, col, name, datatype ); }
/* SetIdxColumnDefault
* give a default value for column
*
* if no value gets written to a column within an open spot,
* this value is substituted.
*
* "idx" [ IN ] - 1-based column index
*
* "base" [ IN ] and "offset" [ IN ] - pointer and bit offset
* to start of row data
*
* "size" [ IN ] - size in bits of row data
*/
inline rc_t SetIdxColumnDefault ( uint32_t idx,
const void *base, bitsz_t offset, bitsz_t size ) throw()
{ return SRATableSetIdxColumnDefault ( this, idx, base, offset, size ); }
/* WriteIdxColumn
* write row data to an indexed column
*
* "idx" [ IN ] - 1-based column index
*
* "base" [ IN ] and "offset" [ IN ] - pointer and bit offset
* to start of row data
*
* "size" [ IN ] - size in bits of row data
*/
inline rc_t WriteIdxColumn ( uint32_t idx,
const void *base, bitsz_t offset, bitsz_t size ) throw()
{ return SRATableWriteIdxColumn ( this, idx, base, offset, size ); }
/* MetaRevision
* returns current revision number
* where 0 ( zero ) means tip
*/
inline rc_t MetaRevision ( uint32_t *revision ) const throw()
{ return SRATableMetaRevision ( this, revision ); }
/* MaxRevision
* returns the maximum revision available
*/
inline rc_t MaxMetaRevision ( uint32_t *revision ) const throw()
{ return SRATableMaxMetaRevision ( this, revision ); }
/* UseMetaRevision
* opens indicated revision of metadata
* all non-zero revisions are read-only
*/
inline rc_t UseMetaRevision ( uint32_t revision ) const throw()
{ return SRATableUseMetaRevision ( this, revision ); }
/* MetaFreeze
* freezes current metadata revision
* further modification will begin on a copy
*/
inline rc_t MetaFreeze () throw()
{ return SRATableMetaFreeze ( this ); }
/* OpenMDataNode
* open a metadata node
*
* "node" [ OUT ] - return parameter for metadata node
*
* "path" [ IN ] - simple or hierarchical NUL terminated
* path to node
*/
inline rc_t OpenMDataNode ( struct KMDataNode const **node,
const char *path, ... ) const throw()
{
va_list args;
va_start ( args, path );
rc_t rc = SRATableVOpenMDataNodeRead ( this, node, path, args );
va_end ( args );
return rc;
}
inline rc_t OpenMDataNode ( struct KMDataNode const **node,
const char *path, va_list args ) const throw()
{ return SRATableVOpenMDataNodeRead ( this, node, path, args ); }
inline rc_t OpenMDataNode ( struct KMDataNode **node,
const char *path, ... ) throw()
{
va_list args;
va_start ( args, path );
rc_t rc = SRATableVOpenMDataNodeUpdate ( this, node, path, args );
va_end ( args );
return rc;
}
inline rc_t OpenMDataNode ( struct KMDataNode **node,
const char *path, va_list args ) throw()
{ return SRATableVOpenMDataNodeUpdate ( this, node, path, args ); }
private:
SRATable ();
~ SRATable ();
SRATable ( const SRATable& );
SRATable &operator = ( const SRATable& );
};
/*--------------------------------------------------------------------------
* SRAColumn
* represents a spot data column, where the column is configured as
* a sequence of blobs, and each blob is a sequence of records,
* indexed by spot id.
*/
struct SRAColumn
{
/* AddRef
* Release
*/
inline rc_t AddRef () const throw()
{ return SRAColumnAddRef ( this ); }
inline rc_t Release () const throw()
{ return SRAColumnRelease ( this ); }
/* Datatype
* access data type
*
* "type" [ OUT, NULL OKAY ] - returns the column type declaration
*
* "def" [ OUT, NULL OKAY ] - returns the definition of the type
* returned in "type_decl"
*
* NB - one of "type" and "def" must be non-NULL
*/
inline int Datatype ( struct VTypedecl *type,
struct VTypedef *def ) const throw()
{ return SRAColumnDatatype ( this, type, def ); }
/* GetRange
* get a contiguous range around a spot id, e.g. tile for Illumina
*
* "id" [ IN ] - return parameter for 1-based spot id
*
* "first" [ OUT, NULL OKAY ] and "last" [ OUT, NULL OKAY ] -
* id range is returned in these output parameters, where
* at least ONE must be NOT-NULL
*/
inline rc_t GetRange ( spotid_t id, spotid_t *first,
spotid_t *last ) const throw()
{ return SRAColumnGetRange ( this, id, first, last ); }
/* Read
* read row data
*
* "id" [ IN ] - spot row id between 1 and max ( spot id )
*
* "base" [ OUT ] and "offset" [ OUT ] - pointer and bit offset
* to start of spot row data.
*
* "size" [ OUT ] - size in bits of row data
*/
inline rc_t Read ( spotid_t id,
const void **base, bitsz_t *offset, bitsz_t *size ) const throw()
{ return SRAColumnRead ( this, id, base, offset, size ); }
private:
SRAColumn ();
~ SRAColumn ();
SRAColumn ( const SRAColumn& );
SRAColumn &operator = ( const SRAColumn& );
};
#endif // _hpp_sra_sradb_
|