NCBI C++ ToolKit
Classes | Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
CVDBValue Class Reference

Search Toolkit Book for CVDBValue

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

+ Inheritance diagram for CVDBValue:
+ Collaboration diagram for CVDBValue:

Classes

struct  SRef
 
struct  SSaveRef
 

Public Types

enum  EMissing { eMissing_Throw , eMissing_Allow }
 

Public Member Functions

 CVDBValue (void)
 
 CVDBValue (const CVDBCursor &cursor, const CVDBColumn &column)
 
 CVDBValue (const CVDBCursor &cursor, TVDBRowId row, const CVDBColumn &column, EMissing missing=eMissing_Throw)
 
 CVDBValue (const SRef &ref)
 
 CVDBValue (const CVDBCursor &cursor, const char *param_name, const CTempString &param_value, const CVDBColumn &column)
 
bool empty (void) const
 
size_t size (void) const
 
CNcbiOstreamPrintFullName (CNcbiOstream &out) const
 

Protected Member Functions

void x_Get (const CVDBCursor &cursor, const CVDBColumn &column)
 
void x_Get (const CVDBCursor &cursor, TVDBRowId row, const CVDBColumn &column, EMissing missing=eMissing_Throw)
 
void x_ReportIndexOutOfBounds (size_t index) const
 
void x_ReportNotOneValue (void) const
 
void x_CheckIndex (size_t index) const
 
void x_CheckRange (size_t pos, size_t len) const
 
void x_CheckOneValue (void) const
 

Protected Attributes

SSaveRef m_Ref
 
const void * m_Data
 
uint32_t m_ElemCount
 

Detailed Description

Definition at line 628 of file vdbread.hpp.

Member Enumeration Documentation

◆ EMissing

Enumerator
eMissing_Throw 
eMissing_Allow 

Definition at line 631 of file vdbread.hpp.

Constructor & Destructor Documentation

◆ CVDBValue() [1/5]

CVDBValue::CVDBValue ( void  )
inline

Definition at line 669 of file vdbread.hpp.

◆ CVDBValue() [2/5]

CVDBValue::CVDBValue ( const CVDBCursor cursor,
const CVDBColumn column 
)
inline

Definition at line 674 of file vdbread.hpp.

References column, and x_Get().

◆ CVDBValue() [3/5]

CVDBValue::CVDBValue ( const CVDBCursor cursor,
TVDBRowId  row,
const CVDBColumn column,
EMissing  missing = eMissing_Throw 
)
inline

Definition at line 680 of file vdbread.hpp.

References column, row, and x_Get().

◆ CVDBValue() [4/5]

CVDBValue::CVDBValue ( const SRef ref)
inlineexplicit

◆ CVDBValue() [5/5]

CVDBValue::CVDBValue ( const CVDBCursor cursor,
const char *  param_name,
const CTempString param_value,
const CVDBColumn column 
)
inline

Definition at line 693 of file vdbread.hpp.

References column, CVDBCursor::SetParam(), and x_Get().

Member Function Documentation

◆ empty()

bool CVDBValue::empty ( void  ) const
inline

◆ PrintFullName()

CNcbiOstream& CVDBValue::PrintFullName ( CNcbiOstream out) const
inline

Definition at line 712 of file vdbread.hpp.

References m_Ref, out(), and CVDBValue::SSaveRef::PrintFullName().

Referenced by operator<<().

◆ size()

size_t CVDBValue::size ( void  ) const
inline

◆ x_CheckIndex()

void CVDBValue::x_CheckIndex ( size_t  index) const
inlineprotected

Definition at line 727 of file vdbread.hpp.

References size(), and x_ReportIndexOutOfBounds().

Referenced by CVDBValueFor< char >::operator[]().

◆ x_CheckOneValue()

void CVDBValue::x_CheckOneValue ( void  ) const
inlineprotected

Definition at line 734 of file vdbread.hpp.

References size(), and x_ReportNotOneValue().

Referenced by CVDBValueFor< char >::Value().

◆ x_CheckRange()

void CVDBValue::x_CheckRange ( size_t  pos,
size_t  len 
) const
protected

◆ x_Get() [1/2]

void CVDBValue::x_Get ( const CVDBCursor cursor,
const CVDBColumn column 
)
protected

◆ x_Get() [2/2]

void CVDBValue::x_Get ( const CVDBCursor cursor,
TVDBRowId  row,
const CVDBColumn column,
EMissing  missing = eMissing_Throw 
)
protected

◆ x_ReportIndexOutOfBounds()

void CVDBValue::x_ReportIndexOutOfBounds ( size_t  index) const
protected

Definition at line 1810 of file vdbread.cpp.

References NCBI_THROW2_FMT, and size().

Referenced by x_CheckIndex().

◆ x_ReportNotOneValue()

void CVDBValue::x_ReportNotOneValue ( void  ) const
protected

Definition at line 1821 of file vdbread.cpp.

References NCBI_THROW2_FMT, and size().

Referenced by x_CheckOneValue().

Member Data Documentation

◆ m_Data

const void* CVDBValue::m_Data
protected

Definition at line 742 of file vdbread.hpp.

Referenced by CVDBValueFor< char >::data(), CVDBStringValue::data(), and x_Get().

◆ m_ElemCount

uint32_t CVDBValue::m_ElemCount
protected

Definition at line 743 of file vdbread.hpp.

Referenced by empty(), size(), x_Get(), CVDBValueFor4Bits::x_Get(), and CVDBValueFor2Bits::x_Get().

◆ m_Ref

SSaveRef CVDBValue::m_Ref
protected

The documentation for this class was generated from the following files:
Modified on Mon Jul 15 05:35:29 2024 by modify_doxy.py rev. 669887