NCBI C++ ToolKit
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | Friends | List of all members
CInfoCache< KeyType, DataType >::CInfo Class Reference

Search Toolkit Book for CInfoCache::CInfo

#include <objtools/data_loaders/genbank/impl/info_cache.hpp>

+ Inheritance diagram for CInfoCache< KeyType, DataType >::CInfo:
+ Collaboration diagram for CInfoCache< KeyType, DataType >::CInfo:

Public Types

typedef KeyType TKey
 
- Public Types inherited from CInfo_DataBase< DataType >
typedef DataType TData
 
- Public Types inherited from CInfo_Base
typedef Uint4 TExpirationTime
 
typedef int TUseCounter
 
typedef list< CRef< CInfo_Base > > TGCQueue
 
- 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

const TKeyGetKey (void) const
 
- Public Member Functions inherited from CInfo_Base
 CInfo_Base (TGCQueue &gc_queue)
 
virtual ~CInfo_Base (void)
 
bool IsLoaded (TExpirationTime expiration_time) const
 
bool IsLoaded (CInfoRequestor &requestor) const
 
TExpirationTime GetExpirationTime (void) 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
 

Protected Member Functions

 CInfo (typename CInfo_Base::TGCQueue &gc_queue, const TKey &key)
 
- Protected Member Functions inherited from CInfo_DataBase< DataType >
 CInfo_DataBase (typename CInfo_Base::TGCQueue &gc_queue)
 
- Protected Member Functions inherited from CObject
virtual void DeleteThis (void)
 Virtual method "deleting" this object. More...
 

Protected Attributes

TKey m_Key
 
- Protected Attributes inherited from CInfo_DataBase< DataType >
TData m_Data
 
- Protected Attributes inherited from CInfo_Base
TUseCounter m_UseCounter
 
atomic< TExpirationTimem_ExpirationTime
 
CRef< CLoadMutexm_LoadMutex
 
TGCQueue::iterator m_GCQueuePos
 

Friends

class CInfoCache
 

Additional Inherited Members

- 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...
 

Detailed Description

template<class KeyType, class DataType>
class CInfoCache< KeyType, DataType >::CInfo

Definition at line 589 of file info_cache.hpp.

Member Typedef Documentation

◆ TKey

template<class KeyType , class DataType >
typedef KeyType CInfoCache< KeyType, DataType >::CInfo::TKey

Definition at line 592 of file info_cache.hpp.

Constructor & Destructor Documentation

◆ CInfo()

template<class KeyType , class DataType >
CInfoCache< KeyType, DataType >::CInfo::CInfo ( typename CInfo_Base::TGCQueue gc_queue,
const TKey key 
)
inlineprotected

Definition at line 601 of file info_cache.hpp.

Member Function Documentation

◆ GetKey()

template<class KeyType , class DataType >
const TKey& CInfoCache< KeyType, DataType >::CInfo::GetKey ( void  ) const
inline

Friends And Related Function Documentation

◆ CInfoCache

template<class KeyType , class DataType >
friend class CInfoCache
friend

Definition at line 600 of file info_cache.hpp.

Member Data Documentation

◆ m_Key

template<class KeyType , class DataType >
TKey CInfoCache< KeyType, DataType >::CInfo::m_Key
protected

Definition at line 608 of file info_cache.hpp.

Referenced by CInfoCache< KeyType, DataType >::CInfo::GetKey().


The documentation for this class was generated from the following file:
Modified on Sat Mar 02 10:58:32 2024 by modify_doxy.py rev. 669887