NCBI C++ ToolKit
Public Member Functions | Private Types | Private Member Functions | Private Attributes | List of all members
CWriteDB_PackedBuffer< ALLOCSIZE > Class Template Reference

Search Toolkit Book for CWriteDB_PackedBuffer

Sortable packed array of null terminated strings. More...

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

+ Inheritance diagram for CWriteDB_PackedBuffer< ALLOCSIZE >:
+ Collaboration diagram for CWriteDB_PackedBuffer< ALLOCSIZE >:

Public Member Functions

 CWriteDB_PackedBuffer ()
 Constructor. More...
 
 ~CWriteDB_PackedBuffer ()
 Destructor. More...
 
const char * Insert (const char *data, int length)
 Insert a new string plus a NUL terminator. More...
 
void Clear ()
 Free all held memory. 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 Types

typedef CWriteDB_PackedBuffer< ALLOCSIZE > TThis
 This object type. More...
 

Private Member Functions

 CWriteDB_PackedBuffer (const TThis &other)
 Prevent copy constructor. More...
 
TThisoperator= (const TThis &other)
 Prevent copy operator. More...
 
void x_AddBlock ()
 Add an block of ALLOCSIZE bytes to the sorted string vector. More...
 

Private Attributes

vector< string * > m_Packed
 Array of pointers to the start of the strings stored here. More...
 
char m_Zero [1]
 Array containing NUL byte for convenience. More...
 

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 CAtomicCounter TCounter
 Counter type is CAtomiCounter. More...
 
typedef TCounter::TValue TCount
 Alias for value type of counter. More...
 
- Static Public Member Functions inherited from CObject
static NCBI_NORETURN void ThrowNullPointerException (void)
 Define method to throw null pointer exception. More...
 
static NCBI_NORETURN 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

template<int ALLOCSIZE>
class CWriteDB_PackedBuffer< ALLOCSIZE >

Sortable packed array of null terminated strings.

This class holds NUL terminated string data for multiple strings. Compared to a vector<string>, it is more efficient in terms of both time and space, but it omits many general purpose features such as iteration, deletion and modification of stored data.

Definition at line 90 of file writedb_general.hpp.

Member Typedef Documentation

template<int ALLOCSIZE>
typedef CWriteDB_PackedBuffer<ALLOCSIZE> CWriteDB_PackedBuffer< ALLOCSIZE >::TThis
private

This object type.

Definition at line 148 of file writedb_general.hpp.

Constructor & Destructor Documentation

template<int ALLOCSIZE>
CWriteDB_PackedBuffer< ALLOCSIZE >::CWriteDB_PackedBuffer ( )
inline

Constructor.

Definition at line 93 of file writedb_general.hpp.

template<int ALLOCSIZE>
CWriteDB_PackedBuffer< ALLOCSIZE >::~CWriteDB_PackedBuffer ( )
inline

Destructor.

Definition at line 99 of file writedb_general.hpp.

template<int ALLOCSIZE>
CWriteDB_PackedBuffer< ALLOCSIZE >::CWriteDB_PackedBuffer ( const TThis other)
private

Prevent copy constructor.

Member Function Documentation

template<int ALLOCSIZE>
void CWriteDB_PackedBuffer< ALLOCSIZE >::Clear ( void  )
inline
template<int ALLOCSIZE>
const char* CWriteDB_PackedBuffer< ALLOCSIZE >::Insert ( const char *  data,
int  length 
)
inline

Insert a new string plus a NUL terminator.

This inserts a string and returns the location of that string in the packed buffer. The returned address will not change over the lifetime of this object.

Parameters
dataThe string data.
lengthThe length of the string data.
Returns
A pointer to the packed string.

Definition at line 113 of file writedb_general.hpp.

template<int ALLOCSIZE>
TThis& CWriteDB_PackedBuffer< ALLOCSIZE >::operator= ( const TThis other)
private

Prevent copy operator.

template<int ALLOCSIZE>
void CWriteDB_PackedBuffer< ALLOCSIZE >::x_AddBlock ( )
inlineprivate

Add an block of ALLOCSIZE bytes to the sorted string vector.

Definition at line 157 of file writedb_general.hpp.

Referenced by CWriteDB_PackedBuffer< BLOCK >::Insert().

Member Data Documentation

template<int ALLOCSIZE>
vector<string*> CWriteDB_PackedBuffer< ALLOCSIZE >::m_Packed
private

Array of pointers to the start of the strings stored here.

Definition at line 175 of file writedb_general.hpp.

Referenced by CWriteDB_PackedBuffer< BLOCK >::Clear(), CWriteDB_PackedBuffer< BLOCK >::Insert(), and CWriteDB_PackedBuffer< BLOCK >::x_AddBlock().

template<int ALLOCSIZE>
char CWriteDB_PackedBuffer< ALLOCSIZE >::m_Zero[1]
private

Array containing NUL byte for convenience.

Definition at line 178 of file writedb_general.hpp.

Referenced by CWriteDB_PackedBuffer< BLOCK >::CWriteDB_PackedBuffer(), and CWriteDB_PackedBuffer< BLOCK >::Insert().


The documentation for this class was generated from the following file:
Modified on Fri Sep 22 15:39:26 2017 by modify_doxy.py rev. 546573