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

Search Toolkit Book for COrdinalFeatIdGenerator

Default implementation for a generator of identifiers, as integers, mashalled as CFeat_id objects. More...

#include <objtools/readers/reader_idgen.hpp>

+ Inheritance diagram for COrdinalFeatIdGenerator:
+ Collaboration diagram for COrdinalFeatIdGenerator:

Public Member Functions

 COrdinalFeatIdGenerator ()
 
TId GenerateId ()
 Generates the "next" id. More...
 
- Public Member Functions inherited from IThreadSafeIdGenerator< CRef< CFeat_id > >
bool IsThreadSafe ()
 This implementeation IS thread-safe. More...
 
- Public Member Functions inherited from IIdGenerator< CRef< CFeat_id > >
virtual ~IIdGenerator ()
 Enforce virtual destructor. 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 Attributes

CAtomicCounter m_Id
 

Additional Inherited Members

- Public Types inherited from IThreadSafeIdGenerator< CRef< CFeat_id > >
typedef IIdGenerator< CRef< CFeat_id > > TThisType
 
- Public Types inherited from IIdGenerator< CRef< CFeat_id > >
typedef IIdGenerator< CRef< CFeat_id > > TThisType
 
typedef CRef< CFeat_idTId
 Type for the ID, which is a template parameter. More...
 
- 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

Default implementation for a generator of identifiers, as integers, mashalled as CFeat_id objects.

Definition at line 133 of file reader_idgen.hpp.

Constructor & Destructor Documentation

◆ COrdinalFeatIdGenerator()

COrdinalFeatIdGenerator::COrdinalFeatIdGenerator ( )
inline

Definition at line 136 of file reader_idgen.hpp.

References m_Id, and CAtomicCounter::Set().

Member Function Documentation

◆ GenerateId()

TId COrdinalFeatIdGenerator::GenerateId ( )
inlinevirtual

Generates the "next" id.

There is no specific constraint on the next id, except that it be effectively, if not actually, unique. Uniqueness is not a hard-core requirement, since wrap-around, limited reuse, and probabilistic uniqueness guarantees are all permitted, depending on the implementation details.

Exceptions
ifan ID cannot be generated, perhaps because the generator has been excausted.
Note
TId should be a CRef in the case of CObject instance, an AutoPtr for other non copy-constructible objects, and otherwise, should have value semantics.

Implements IIdGenerator< CRef< CFeat_id > >.

Definition at line 141 of file reader_idgen.hpp.

References CAtomicCounter::Add(), and m_Id.

Member Data Documentation

◆ m_Id

CAtomicCounter COrdinalFeatIdGenerator::m_Id
private

Definition at line 149 of file reader_idgen.hpp.

Referenced by COrdinalFeatIdGenerator(), and GenerateId().


The documentation for this class was generated from the following file:
Modified on Fri Apr 12 17:21:06 2024 by modify_doxy.py rev. 669887