NCBI C++ ToolKit
Public Types | Public Member Functions | Private Attributes | List of all members
CVDBTableIndex Class Reference

Search Toolkit Book for CVDBTableIndex

#include <sra/readers/sra/vdbread.hpp>

+ Inheritance diagram for CVDBTableIndex:
+ Collaboration diagram for CVDBTableIndex:

Public Types

enum  EMissing { eMissing_Throw , eMissing_Allow }
 
- Public Types inherited from CSraRef< const KIndex >
typedef const KIndex TObject
 
typedef TObjectTPointer
 

Public Member Functions

 CVDBTableIndex (void)
 
 CVDBTableIndex (const CVDBTable &table, const char *index_name, EMissing missing=eMissing_Throw)
 
const CVDBTableGetTable (void) const
 
const char * GetName (void) const
 
string GetFullName (void) const
 
CNcbiOstreamPrintFullName (CNcbiOstream &out) const
 
TVDBRowIdRange Find (const string &value) const
 
void Close (void)
 
- Public Member Functions inherited from CSraRef< const KIndex >
 CSraRef (void)
 
 CSraRef (const TSelf &ref)
 
 CSraRef (TSelf &&ref)
 Copy constructor from an existing CRef object,. More...
 
TSelfoperator= (const TSelf &ref)
 
TSelfoperator= (TSelf &&ref)
 
 ~CSraRef (void)
 
void Release (void)
 
TObjectGetPointer (void) const
 
 operator TObject * (void) const
 
TObjectoperator-> (void) const
 
TObjectoperator* (void) const
 

Private Attributes

CVDBTable m_Table
 
const char * m_Name
 

Additional Inherited Members

- Protected Types inherited from CSraRef< const KIndex >
typedef CSraRef< const KIndex > TSelf
 
typedef CSraRefTraits< const KIndex > TTraits
 
- Protected Member Functions inherited from CSraRef< const KIndex >
 CSraRef (TPointer ptr)
 
TObject ** x_InitPtr (void)
 
- Static Protected Member Functions inherited from CSraRef< const KIndex >
static TObjects_AddRef (const TSelf &ref)
 

Detailed Description

Definition at line 350 of file vdbread.hpp.

Member Enumeration Documentation

◆ EMissing

Enumerator
eMissing_Throw 
eMissing_Allow 

Definition at line 354 of file vdbread.hpp.

Constructor & Destructor Documentation

◆ CVDBTableIndex() [1/2]

CVDBTableIndex::CVDBTableIndex ( void  )
inline

Definition at line 359 of file vdbread.hpp.

Referenced by Close().

◆ CVDBTableIndex() [2/2]

CVDBTableIndex::CVDBTableIndex ( const CVDBTable table,
const char *  index_name,
EMissing  missing = eMissing_Throw 
)

Member Function Documentation

◆ Close()

void CVDBTableIndex::Close ( void  )
inline

Definition at line 379 of file vdbread.hpp.

References CVDBTableIndex().

◆ Find()

TVDBRowIdRange CVDBTableIndex::Find ( const string value) const

◆ GetFullName()

string CVDBTableIndex::GetFullName ( void  ) const

Definition at line 1305 of file vdbread.cpp.

References CVDBTable::GetFullName(), GetName(), and GetTable().

Referenced by CVDBTableIndex().

◆ GetName()

const char* CVDBTableIndex::GetName ( void  ) const
inline

Definition at line 370 of file vdbread.hpp.

References m_Name.

Referenced by GetFullName(), and PrintFullName().

◆ GetTable()

const CVDBTable& CVDBTableIndex::GetTable ( void  ) const
inline

Definition at line 366 of file vdbread.hpp.

References m_Table.

Referenced by GetFullName(), and PrintFullName().

◆ PrintFullName()

CNcbiOstream & CVDBTableIndex::PrintFullName ( CNcbiOstream out) const

Definition at line 1311 of file vdbread.cpp.

References GetName(), GetTable(), out(), and CVDBTable::PrintFullName().

Referenced by operator<<().

Member Data Documentation

◆ m_Name

const char* CVDBTableIndex::m_Name
private

Definition at line 385 of file vdbread.hpp.

Referenced by GetName().

◆ m_Table

CVDBTable CVDBTableIndex::m_Table
private

Definition at line 384 of file vdbread.hpp.

Referenced by GetTable().


The documentation for this class was generated from the following files:
Modified on Sun Jun 23 05:22:33 2024 by modify_doxy.py rev. 669887