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

Search Toolkit Book for CReadSharedObjectIdHookBase

#include <objects/general/Object_id.hpp>

+ Inheritance diagram for CReadSharedObjectIdHookBase:
+ Collaboration diagram for CReadSharedObjectIdHookBase:

Public Member Functions

CObject_idGetSharedObject_id (const string &id)
 Returns shared version of Object-id with specified 'str' field value. More...
 
CObject_idGetSharedObject_id (int id)
 Returns shared version of Object-id with specified 'id' field value. More...
 
CObject_idGetSharedObject_id (const CObject_id &oid)
 Returns shared version of argument Object-id. More...
 
CObject_idReadSharedObject_id (CObjectIStream &in)
 Reads Object-id and returns reference to its shared version. More...
 
- Public Member Functions inherited from CReadClassMemberHook
virtual ~CReadClassMemberHook (void)
 
virtual void ReadClassMember (CObjectIStream &in, const CObjectInfoMI &member)=0
 This method will be called at approriate time when the object of requested type is to be read. More...
 
virtual void ReadMissingClassMember (CObjectIStream &in, const CObjectInfoMI &member)
 
void DefaultRead (CObjectIStream &in, const CObjectInfoMI &object)
 
void DefaultSkip (CObjectIStream &in, const CObjectTypeInfoMI &object)
 
void ResetMember (const CObjectInfoMI &object, CObjectInfoMI::EEraseFlag flag=CObjectInfoMI::eErase_Optional)
 
- 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 Attributes

CObject_id m_Temp
 

Private Types

typedef map< string, CRef< CObject_id > > TMapByStr
 
typedef map< int, CRef< CObject_id > > TMapByInt
 

Private Attributes

TMapByStr m_MapByStr
 
TMapByInt m_MapByInt
 

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

Definition at line 230 of file Object_id.hpp.

Member Typedef Documentation

◆ TMapByInt

Definition at line 258 of file Object_id.hpp.

◆ TMapByStr

Definition at line 257 of file Object_id.hpp.

Member Function Documentation

◆ GetSharedObject_id() [1/3]

CObject_id& CReadSharedObjectIdHookBase::GetSharedObject_id ( const CObject_id oid)
inline

Returns shared version of argument Object-id.

Can be stored for later read-only use.

Definition at line 243 of file Object_id.hpp.

References CObject_id_Base::GetId(), GetSharedObject_id(), CObject_id_Base::GetStr(), and CObject_id_Base::IsStr().

◆ GetSharedObject_id() [2/3]

CObject_id & CReadSharedObjectIdHookBase::GetSharedObject_id ( const string id)

Returns shared version of Object-id with specified 'str' field value.

Can be stored for later read-only use.

Definition at line 219 of file Object_id.cpp.

References m_MapByStr, and CObject_id_Base::SetStr().

Referenced by GetSharedObject_id(), and ReadSharedObject_id().

◆ GetSharedObject_id() [3/3]

CObject_id & CReadSharedObjectIdHookBase::GetSharedObject_id ( int  id)

Returns shared version of Object-id with specified 'id' field value.

Can be stored for later read-only use.

Definition at line 231 of file Object_id.cpp.

References m_MapByInt, and CObject_id_Base::SetId().

◆ ReadSharedObject_id()

CObject_id & CReadSharedObjectIdHookBase::ReadSharedObject_id ( CObjectIStream in)

Reads Object-id and returns reference to its shared version.

Can be stored for later read-only use.

Definition at line 246 of file Object_id.cpp.

References GetSharedObject_id(), in(), and m_Temp.

Referenced by CReadSharedScoreIdHook::ReadClassMember().

Member Data Documentation

◆ m_MapByInt

TMapByInt CReadSharedObjectIdHookBase::m_MapByInt
private

Definition at line 260 of file Object_id.hpp.

Referenced by GetSharedObject_id().

◆ m_MapByStr

TMapByStr CReadSharedObjectIdHookBase::m_MapByStr
private

Definition at line 259 of file Object_id.hpp.

Referenced by GetSharedObject_id().

◆ m_Temp

CObject_id CReadSharedObjectIdHookBase::m_Temp
protected

Definition at line 254 of file Object_id.hpp.

Referenced by ReadSharedObject_id().


The documentation for this class was generated from the following files:
Modified on Fri Sep 20 14:57:20 2024 by modify_doxy.py rev. 669887