NCBI C++ ToolKit
Classes | Public Member Functions | Static Public Attributes | Protected Member Functions | Protected Attributes | Private Types | Private Member Functions | Friends | List of all members
CSeqTable_sparse_index Class Reference

Represents ASN.1 type SeqTable-sparse-index defined in file seqtable.asn

Search Toolkit Book for CSeqTable_sparse_index

#include <objects/seqtable/SeqTable_sparse_index.hpp>

+ Inheritance diagram for CSeqTable_sparse_index:
+ Collaboration diagram for CSeqTable_sparse_index:

Classes

class  const_iterator
 
struct  SBitsInfo
 

Public Member Functions

 CSeqTable_sparse_index (void)
 
 ~CSeqTable_sparse_index (void)
 
size_t GetSize (void) const
 
size_t GetIndexAt (size_t row) const
 
bool HasValueAt (size_t row) const
 
const_iterator begin (void) const
 
const_iterator end (void) const
 
void ChangeTo (E_Choice type)
 
void ChangeToIndexes (void)
 
void ChangeToIndexes_delta (void)
 
void ChangeToBit_set (void)
 
void ChangeToBit_set_bvector (void)
 
void Reset (void)
 Reset the whole object. More...
 
TIndexesSetIndexes (void)
 
TIndexes_deltaSetIndexes_delta (void)
 
TBit_setSetBit_set (void)
 
TBit_set_bvectorSetBit_set_bvector (void)
 
void PostRead (void)
 
- Public Member Functions inherited from CSeqTable_sparse_index_Base
 CSeqTable_sparse_index_Base (void)
 
virtual ~CSeqTable_sparse_index_Base (void)
 
 DECLARE_INTERNAL_TYPE_INFO ()
 
virtual void ResetSelection (void)
 Reset the selection (set it to e_not_set). More...
 
E_Choice Which (void) const
 Which variant is currently selected. More...
 
void CheckSelected (E_Choice index) const
 Verify selection, throw exception if it differs from the expected. More...
 
void ThrowInvalidSelection (E_Choice index) const
 Throw 'InvalidSelection' exception. More...
 
void Select (E_Choice index, EResetVariant reset=eDoResetVariant)
 Select the requested variant if needed. More...
 
void Select (E_Choice index, EResetVariant reset, CObjectMemoryPool *pool)
 Select the requested variant if needed, allocating CObject variants from memory pool. More...
 
bool IsIndexes (void) const
 Check if variant Indexes is selected. More...
 
const TIndexesGetIndexes (void) const
 Get the variant data. More...
 
TIndexesSetIndexes (void)
 Select the variant. More...
 
bool IsBit_set (void) const
 Check if variant Bit_set is selected. More...
 
const TBit_setGetBit_set (void) const
 Get the variant data. More...
 
TBit_setSetBit_set (void)
 Select the variant. More...
 
bool IsIndexes_delta (void) const
 Check if variant Indexes_delta is selected. More...
 
const TIndexes_deltaGetIndexes_delta (void) const
 Get the variant data. More...
 
TIndexes_deltaSetIndexes_delta (void)
 Select the variant. More...
 
bool IsBit_set_bvector (void) const
 Check if variant Bit_set_bvector is selected. More...
 
const TBit_set_bvectorGetBit_set_bvector (void) const
 Get the variant data. More...
 
TBit_set_bvectorSetBit_set_bvector (void)
 Select the variant. More...
 
void SetBit_set_bvector (TBit_set_bvector &value)
 Select the variant and set its data. More...
 
- Public Member Functions inherited from CSerialObject
 CSerialObject (void)
 
virtual ~CSerialObject (void)
 
virtual const CTypeInfoGetThisTypeInfo (void) const =0
 
virtual void Assign (const CSerialObject &source, ESerialRecursionMode how=eRecursive)
 Set object to copy of another one. More...
 
virtual bool Equals (const CSerialObject &object, ESerialRecursionMode how=eRecursive) const
 Check if both objects contain the same values. More...
 
virtual void DebugDump (CDebugDumpContext ddc, unsigned int depth) const
 Define method for dumping debug information. More...
 
void ThrowUnassigned (TMemberIndex index) const
 
void ThrowUnassigned (TMemberIndex index, const char *file_name, int file_line) const
 
bool HasNamespaceName (void) const
 Check if object data type has namespace name. More...
 
const stringGetNamespaceName (void) const
 Get namespace name. More...
 
bool HasNamespacePrefix (void) const
 Check if data type has namespace prefix. More...
 
const stringGetNamespacePrefix (void) const
 Get namespace prefix. 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...
 
- 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
 

Static Public Attributes

static const size_t kSkipped = size_t(0)-1
 
static const size_t kInvalidRow = size_t(0)-1
 
- Static Public Attributes inherited from CSerialObject
static const char * ms_UnassignedStr = "<*unassigned*>"
 
static const char ms_UnassignedByte = char(0xcd)
 
- 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

void x_ResetCache (void)
 
size_t x_GetFirstRowWithValue (void) const
 
size_t x_GetNextRowWithValue (size_t row, size_t value_index) const
 
size_t x_GetBitSetCache (size_t byte_count) const
 
CIndexDeltaSumCachex_GetDeltaCache (void) const
 
size_t x_GetDeltaSum (size_t index) const
 
size_t x_FindDeltaSum (size_t sum) const
 
- Protected Member Functions inherited from CObject
virtual void DeleteThis (void)
 Virtual method "deleting" this object. More...
 

Protected Attributes

CRef< CObjectm_Cache
 

Private Types

typedef CSeqTable_sparse_index_Base Tparent
 

Private Member Functions

 CSeqTable_sparse_index (const CSeqTable_sparse_index &value)
 
CSeqTable_sparse_indexoperator= (const CSeqTable_sparse_index &value)
 

Friends

class const_iterator
 

Additional Inherited Members

- Public Types inherited from CSeqTable_sparse_index_Base
enum  E_Choice {
  e_not_set = 0 , e_Indexes , e_Bit_set , e_Indexes_delta ,
  e_Bit_set_bvector
}
 Choice variants. More...
 
enum  E_ChoiceStopper { e_MaxChoice = 5 }
 Maximum+1 value of the choice variant enumerator. More...
 
typedef vector< unsigned > TIndexes
 
typedef vector< char > TBit_set
 
typedef vector< unsigned > TIndexes_delta
 
typedef CBVector_data TBit_set_bvector
 
- 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 CSeqTable_sparse_index_Base
static string SelectionName (E_Choice index)
 Retrieve selection name (for diagnostic purposes). More...
 
- Static Public Member Functions inherited from CSerialObject
static void SetVerifyDataThread (ESerialVerifyData verify)
 
static void SetVerifyDataGlobal (ESerialVerifyData verify)
 
static string UnassignedString (void)
 
static CStringUTF8 UnassignedStringUTF8 (void)
 
static char UnassignedByte (void)
 
- 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)
 

Detailed Description

Definition at line 87 of file SeqTable_sparse_index.hpp.

Member Typedef Documentation

◆ Tparent

Definition at line 89 of file SeqTable_sparse_index.hpp.

Constructor & Destructor Documentation

◆ CSeqTable_sparse_index() [1/2]

CSeqTable_sparse_index::CSeqTable_sparse_index ( void  )
inline

Definition at line 265 of file SeqTable_sparse_index.hpp.

◆ ~CSeqTable_sparse_index()

CSeqTable_sparse_index::~CSeqTable_sparse_index ( void  )

Definition at line 57 of file SeqTable_sparse_index.cpp.

◆ CSeqTable_sparse_index() [2/2]

CSeqTable_sparse_index::CSeqTable_sparse_index ( const CSeqTable_sparse_index value)
private

Member Function Documentation

◆ begin()

const_iterator CSeqTable_sparse_index::begin ( void  ) const
inline

◆ ChangeTo()

void CSeqTable_sparse_index::ChangeTo ( E_Choice  type)

◆ ChangeToBit_set()

void CSeqTable_sparse_index::ChangeToBit_set ( void  )

◆ ChangeToBit_set_bvector()

void CSeqTable_sparse_index::ChangeToBit_set_bvector ( void  )

◆ ChangeToIndexes()

void CSeqTable_sparse_index::ChangeToIndexes ( void  )

◆ ChangeToIndexes_delta()

void CSeqTable_sparse_index::ChangeToIndexes_delta ( void  )

◆ end()

const_iterator CSeqTable_sparse_index::end ( void  ) const
inline

Definition at line 169 of file SeqTable_sparse_index.hpp.

References const_iterator.

◆ GetIndexAt()

size_t CSeqTable_sparse_index::GetIndexAt ( size_t  row) const

◆ GetSize()

size_t CSeqTable_sparse_index::GetSize ( void  ) const

◆ HasValueAt()

bool CSeqTable_sparse_index::HasValueAt ( size_t  row) const

◆ operator=()

CSeqTable_sparse_index& CSeqTable_sparse_index::operator= ( const CSeqTable_sparse_index value)
private

◆ PostRead()

void CSeqTable_sparse_index::PostRead ( void  )
inline

Definition at line 203 of file SeqTable_sparse_index.hpp.

References x_ResetCache().

◆ Reset()

void CSeqTable_sparse_index::Reset ( void  )
inlinevirtual

Reset the whole object.

Reimplemented from CSeqTable_sparse_index_Base.

Definition at line 182 of file SeqTable_sparse_index.hpp.

References CSeqTable_sparse_index_Base::Reset(), and x_ResetCache().

◆ SetBit_set()

TBit_set& CSeqTable_sparse_index::SetBit_set ( void  )
inline

◆ SetBit_set_bvector()

TBit_set_bvector& CSeqTable_sparse_index::SetBit_set_bvector ( void  )
inline

◆ SetIndexes()

TIndexes& CSeqTable_sparse_index::SetIndexes ( void  )
inline

◆ SetIndexes_delta()

TIndexes_delta& CSeqTable_sparse_index::SetIndexes_delta ( void  )
inline

◆ x_FindDeltaSum()

size_t CSeqTable_sparse_index::x_FindDeltaSum ( size_t  sum) const
inlineprotected

◆ x_GetBitSetCache()

size_t CSeqTable_sparse_index::x_GetBitSetCache ( size_t  byte_count) const
protected

◆ x_GetDeltaCache()

CIndexDeltaSumCache & CSeqTable_sparse_index::x_GetDeltaCache ( void  ) const
protected

◆ x_GetDeltaSum()

size_t CSeqTable_sparse_index::x_GetDeltaSum ( size_t  index) const
inlineprotected

◆ x_GetFirstRowWithValue()

size_t CSeqTable_sparse_index::x_GetFirstRowWithValue ( void  ) const
protected

◆ x_GetNextRowWithValue()

size_t CSeqTable_sparse_index::x_GetNextRowWithValue ( size_t  row,
size_t  value_index 
) const
protected

◆ x_ResetCache()

void CSeqTable_sparse_index::x_ResetCache ( void  )
inlineprotected

Friends And Related Function Documentation

◆ const_iterator

friend class const_iterator
friend

Definition at line 208 of file SeqTable_sparse_index.hpp.

Referenced by begin(), and end().

Member Data Documentation

◆ kInvalidRow

const size_t CSeqTable_sparse_index::kInvalidRow = size_t(0)-1
static

◆ kSkipped

const size_t CSeqTable_sparse_index::kSkipped = size_t(0)-1
static

◆ m_Cache

CRef<CObject> CSeqTable_sparse_index::m_Cache
mutableprotected

Definition at line 253 of file SeqTable_sparse_index.hpp.

Referenced by x_GetBitSetCache(), x_GetDeltaCache(), and x_ResetCache().


The documentation for this class was generated from the following files:
Modified on Wed Apr 17 13:08:51 2024 by modify_doxy.py rev. 669887