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

Search Toolkit Book for CWriteDB_TaxID

This class supports creation of tax id list lookup files. More...

#include <objtools/blast/seqdb_writer/writedb_lmdb.hpp>

+ Inheritance diagram for CWriteDB_TaxID:
+ Collaboration diagram for CWriteDB_TaxID:

Classes

struct  SKeyValuePair
 

Public Member Functions

 CWriteDB_TaxID (const string &dbname, Uint8 map_size=500000, Uint8 capacity=500000)
 Constructor for LMDB write access. More...
 
 ~CWriteDB_TaxID ()
 
int InsertEntries (const set< TTaxId > &tax_ids, const blastdb::TOid oid)
 Add tax id entries in bulk for each oid This api needs to be called in sequential order of OIDs This api should only be called once for each OID. More...
 
- Public Member Functions inherited from CObject
 CObject (void)
 Constructor. More...
 
 CObject (const CObject &src)
 Copy constructor. More...
 
virtual ~CObject (void)
 Destructor. More...
 
CObjectoperator= (const CObject &src) THROWS_NONE
 Assignment operator. More...
 
bool CanBeDeleted (void) const THROWS_NONE
 Check if object can be deleted. More...
 
bool IsAllocatedInPool (void) const THROWS_NONE
 Check if object is allocated in memory pool (not system heap) More...
 
bool Referenced (void) const THROWS_NONE
 Check if object is referenced. More...
 
bool ReferencedOnlyOnce (void) const THROWS_NONE
 Check if object is referenced only once. More...
 
void AddReference (void) const
 Add reference to object. More...
 
void RemoveReference (void) const
 Remove reference to object. More...
 
void ReleaseReference (void) const
 Remove reference without deleting object. More...
 
virtual void DoNotDeleteThisObject (void)
 Mark this object as not allocated in heap – do not delete this object. More...
 
virtual void DoDeleteThisObject (void)
 Mark this object as allocated in heap – object can be deleted. More...
 
void * operator new (size_t size)
 Define new operator for memory allocation. More...
 
void * operator new[] (size_t size)
 Define new[] operator for 'array' memory allocation. More...
 
void operator delete (void *ptr)
 Define delete operator for memory deallocation. More...
 
void operator delete[] (void *ptr)
 Define delete[] operator for memory deallocation. More...
 
void * operator new (size_t size, void *place)
 Define new operator. More...
 
void operator delete (void *ptr, void *place)
 Define delete operator. More...
 
void * operator new (size_t size, CObjectMemoryPool *place)
 Define new operator using memory pool. More...
 
void operator delete (void *ptr, CObjectMemoryPool *place)
 Define delete operator. More...
 
virtual void DebugDump (CDebugDumpContext ddc, unsigned int depth) const
 Define method for dumping debug information. More...
 
- Public Member Functions inherited from CDebugDumpable
 CDebugDumpable (void)
 
virtual ~CDebugDumpable (void)
 
void DebugDumpText (ostream &out, const string &bundle, unsigned int depth) const
 
void DebugDumpFormat (CDebugDumpFormatter &ddf, const string &bundle, unsigned int depth) const
 
void DumpToConsole (void) const
 

Private Member Functions

void x_CommitTransaction ()
 
void x_CreateOidToTaxIdsLookupFile ()
 
void x_CreateTaxIdToOidsLookupFile ()
 
void x_Resize ()
 
void x_IncreaseEnvMapSize ()
 

Private Attributes

string m_Db
 
lmdb::envm_Env
 
Uint8 m_ListCapacity
 
unsigned int m_MaxEntryPerTxn
 
vector< SKeyValuePair< blastdb::TOid > > m_TaxId2OidList
 
vector< SKeyValuePair< Uint8 > > m_TaxId2OffsetsList
 

Additional Inherited Members

- Public Types inherited from CObject
enum  EAllocFillMode { eAllocFillNone = 1 , eAllocFillZero , eAllocFillPattern }
 Control filling of newly allocated memory. More...
 
typedef CObjectCounterLocker TLockerType
 Default locker type for CRef. More...
 
typedef atomic< Uint8TCounter
 Counter type is CAtomiCounter. More...
 
typedef Uint8 TCount
 Alias for value type of counter. More...
 
- Static Public Member Functions inherited from CObject
static NCBI_XNCBI_EXPORT void ThrowNullPointerException (void)
 Define method to throw null pointer exception. More...
 
static NCBI_XNCBI_EXPORT void ThrowNullPointerException (const type_info &type)
 
static EAllocFillMode GetAllocFillMode (void)
 
static void SetAllocFillMode (EAllocFillMode mode)
 
static void SetAllocFillMode (const string &value)
 Set mode from configuration parameter value. More...
 
- Static Public Member Functions inherited from CDebugDumpable
static void EnableDebugDump (bool on)
 
- Static Public Attributes inherited from CObject
static const TCount eCounterBitsCanBeDeleted = 1 << 0
 Define possible object states. More...
 
static const TCount eCounterBitsInPlainHeap = 1 << 1
 Heap signature was found. More...
 
static const TCount eCounterBitsPlaceMask
 Mask for 'in heap' state flags. More...
 
static const int eCounterStep = 1 << 2
 Skip over the "in heap" bits. More...
 
static const TCount eCounterValid = TCount(1) << (sizeof(TCount) * 8 - 2)
 Minimal value for valid objects (reference counter is zero) Must be a single bit value. More...
 
static const TCount eCounterStateMask
 Valid object, and object in heap. More...
 
- Protected Member Functions inherited from CObject
virtual void DeleteThis (void)
 Virtual method "deleting" this object. More...
 

Detailed Description

This class supports creation of tax id list lookup files.

Definition at line 136 of file writedb_lmdb.hpp.

Constructor & Destructor Documentation

◆ CWriteDB_TaxID()

CWriteDB_TaxID::CWriteDB_TaxID ( const string dbname,
Uint8  map_size = 500000,
Uint8  capacity = 500000 
)

Constructor for LMDB write access.

Parameters
dbnameDatabase name

Definition at line 425 of file writedb_lmdb.cpp.

References _TRACE, m_ListCapacity, m_MaxEntryPerTxn, m_TaxId2OidList, and NStr::StringToInt().

◆ ~CWriteDB_TaxID()

CWriteDB_TaxID::~CWriteDB_TaxID ( )

Member Function Documentation

◆ InsertEntries()

int CWriteDB_TaxID::InsertEntries ( const set< TTaxId > &  tax_ids,
const blastdb::TOid  oid 
)

Add tax id entries in bulk for each oid This api needs to be called in sequential order of OIDs This api should only be called once for each OID.

Parameters
oidOID
tax_idslist for oid
Returns
number of rows added to database
See also
InsertEntry

Definition at line 446 of file writedb_lmdb.cpp.

References ITERATE, m_TaxId2OidList, set< Key, Compare >::size(), x_Resize(), and ZERO_TAX_ID.

Referenced by BOOST_AUTO_TEST_CASE(), and CWriteDB_Impl::x_Publish().

◆ x_CommitTransaction()

void CWriteDB_TaxID::x_CommitTransaction ( )
private

◆ x_CreateOidToTaxIdsLookupFile()

void CWriteDB_TaxID::x_CreateOidToTaxIdsLookupFile ( )
private

◆ x_CreateTaxIdToOidsLookupFile()

void CWriteDB_TaxID::x_CreateTaxIdToOidsLookupFile ( )
private

◆ x_IncreaseEnvMapSize()

void CWriteDB_TaxID::x_IncreaseEnvMapSize ( )
private

◆ x_Resize()

void CWriteDB_TaxID::x_Resize ( )
private

Definition at line 616 of file writedb_lmdb.cpp.

References m_ListCapacity, and m_TaxId2OidList.

Referenced by InsertEntries().

Member Data Documentation

◆ m_Db

string CWriteDB_TaxID::m_Db
private

◆ m_Env

lmdb::env& CWriteDB_TaxID::m_Env
private

Definition at line 167 of file writedb_lmdb.hpp.

Referenced by x_CommitTransaction(), and x_IncreaseEnvMapSize().

◆ m_ListCapacity

Uint8 CWriteDB_TaxID::m_ListCapacity
private

Definition at line 168 of file writedb_lmdb.hpp.

Referenced by CWriteDB_TaxID(), and x_Resize().

◆ m_MaxEntryPerTxn

unsigned int CWriteDB_TaxID::m_MaxEntryPerTxn
private

Definition at line 169 of file writedb_lmdb.hpp.

Referenced by CWriteDB_TaxID(), and x_CommitTransaction().

◆ m_TaxId2OffsetsList

vector<SKeyValuePair<Uint8> > CWriteDB_TaxID::m_TaxId2OffsetsList
private

◆ m_TaxId2OidList

vector<SKeyValuePair<blastdb::TOid> > CWriteDB_TaxID::m_TaxId2OidList
private

The documentation for this class was generated from the following files:
Modified on Fri Dec 01 04:50:09 2023 by modify_doxy.py rev. 669887