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

Search Toolkit Book for CSynonymsSet

#include <objmgr/impl/synonyms.hpp>

+ Inheritance diagram for CSynonymsSet:
+ Collaboration diagram for CSynonymsSet:

Public Types

typedef CSeq_id_Handle value_type
 
typedef vector< value_typeTIdSet
 
typedef TIdSet::const_iterator const_iterator
 
- 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...
 

Public Member Functions

 CSynonymsSet (void)
 
 ~CSynonymsSet (void)
 
const_iterator begin (void) const
 
const_iterator end (void) const
 
bool empty (void) const
 
void AddSynonym (const value_type &syn)
 
bool ContainsSynonym (const CSeq_id_Handle &id) const
 
- 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
 

Static Public Member Functions

static CSeq_id_Handle GetSeq_id_Handle (const const_iterator &iter)
 
- 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)
 

Private Member Functions

 CSynonymsSet (const CSynonymsSet &)
 
CSynonymsSetoperator= (const CSynonymsSet &)
 

Private Attributes

TIdSet m_IdSet
 

Additional Inherited Members

- 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

Definition at line 54 of file synonyms.hpp.

Member Typedef Documentation

◆ const_iterator

Definition at line 59 of file synonyms.hpp.

◆ TIdSet

Definition at line 58 of file synonyms.hpp.

◆ value_type

Definition at line 57 of file synonyms.hpp.

Constructor & Destructor Documentation

◆ CSynonymsSet() [1/2]

CSynonymsSet::CSynonymsSet ( void  )

Definition at line 2226 of file scope_info.cpp.

◆ ~CSynonymsSet()

CSynonymsSet::~CSynonymsSet ( void  )

Definition at line 2231 of file scope_info.cpp.

◆ CSynonymsSet() [2/2]

CSynonymsSet::CSynonymsSet ( const CSynonymsSet )
private

Member Function Documentation

◆ AddSynonym()

void CSynonymsSet::AddSynonym ( const value_type syn)

Definition at line 2253 of file scope_info.cpp.

References _ASSERT, ContainsSynonym(), and m_IdSet.

Referenced by CScope_Impl::x_AddSynonym().

◆ begin()

CSynonymsSet::const_iterator CSynonymsSet::begin ( void  ) const
inline

Definition at line 89 of file synonyms.hpp.

References m_IdSet.

◆ ContainsSynonym()

bool CSynonymsSet::ContainsSynonym ( const CSeq_id_Handle id) const

Definition at line 2242 of file scope_info.cpp.

References ITERATE, and m_IdSet.

Referenced by AddSynonym(), and CScope_Impl::x_AddSynonym().

◆ empty()

bool CSynonymsSet::empty ( void  ) const
inline

Definition at line 103 of file synonyms.hpp.

References m_IdSet.

◆ end()

CSynonymsSet::const_iterator CSynonymsSet::end ( void  ) const
inline

Definition at line 96 of file synonyms.hpp.

References m_IdSet.

◆ GetSeq_id_Handle()

CSeq_id_Handle CSynonymsSet::GetSeq_id_Handle ( const const_iterator iter)
static

◆ operator=()

CSynonymsSet& CSynonymsSet::operator= ( const CSynonymsSet )
private

Member Data Documentation

◆ m_IdSet

TIdSet CSynonymsSet::m_IdSet
private

Definition at line 78 of file synonyms.hpp.

Referenced by AddSynonym(), begin(), ContainsSynonym(), empty(), and end().


The documentation for this class was generated from the following files:
Modified on Sun Apr 14 05:25:02 2024 by modify_doxy.py rev. 669887