Search Toolkit Book for SCompoundIDFieldImpl
#include "compound_id_impl.hpp"
(Private to src/connect/services.)
Inheritance diagram for SCompoundIDFieldImpl:
Collaboration diagram for SCompoundIDFieldImpl:
Public Member Functions | |
| virtual void | DeleteThis () |
| Virtual method "deleting" this object. More... | |
| Public Member Functions inherited from CObject | |
| CObject (void) | |
| Constructor. More... | |
| CObject (const CObject &src) | |
| Copy constructor. More... | |
| virtual | ~CObject (void) |
| Destructor. More... | |
| CObject & | operator= (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 |
Public Attributes | |
| CCompoundID | m_CID |
| ECompoundIDFieldType | m_Type |
| union { | |
| Uint8 m_Uint8Value | |
| Int8 m_Int8Value | |
| Uint4 m_Uint4Value | |
| struct { | |
| Uint4 m_IPv4Addr | |
| Uint2 m_Port | |
| } m_IPv4SockAddr | |
| bool m_BoolValue | |
| SCompoundIDFieldImpl * m_NextObjectInPool | |
| }; | |
| string | m_StringValue |
| CCompoundID | m_NestedCID |
| Public Attributes inherited from SFieldListLink | |
| SCompoundIDFieldImpl * | m_Prev |
| SCompoundIDFieldImpl * | m_Next |
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< Uint8 > | TCounter |
| 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... | |
Detailed Description
Definition at line 62 of file compound_id_impl.hpp.
Member Function Documentation
◆ DeleteThis()
|
virtual |
Virtual method "deleting" this object.
Method is called whenever by all other indicators this object should be deleted. These indicators are: last reference to the object is removed, object created on heap and method DoNotDeleteThisObject() was not called. Default implementation actually deletes the object, but derived classes are free to do whatever they want (e.g. if they know that they are allocated at some pool they should return themselves to this pool).
Reimplemented from CObject.
Definition at line 113 of file compound_id.cpp.
Member Data Documentation
◆
| union { ... } |
◆ m_BoolValue
| bool SCompoundIDFieldImpl::m_BoolValue |
Definition at line 79 of file compound_id_impl.hpp.
Referenced by s_DumpCompoundID().
◆ m_CID
| CCompoundID SCompoundIDFieldImpl::m_CID |
Definition at line 67 of file compound_id_impl.hpp.
Referenced by DeleteThis().
◆ m_Int8Value
| Int8 SCompoundIDFieldImpl::m_Int8Value |
Definition at line 73 of file compound_id_impl.hpp.
Referenced by s_DumpCompoundID().
◆ m_IPv4Addr
| Uint4 SCompoundIDFieldImpl::m_IPv4Addr |
Definition at line 76 of file compound_id_impl.hpp.
◆
| struct { ... } SCompoundIDFieldImpl::m_IPv4SockAddr |
Referenced by CCompoundID::AppendIPv4SockAddr(), and s_DumpCompoundID().
◆ m_NestedCID
| CCompoundID SCompoundIDFieldImpl::m_NestedCID |
Definition at line 84 of file compound_id_impl.hpp.
Referenced by s_DumpCompoundID().
◆ m_NextObjectInPool
| SCompoundIDFieldImpl* SCompoundIDFieldImpl::m_NextObjectInPool |
Definition at line 81 of file compound_id_impl.hpp.
◆ m_Port
| Uint2 SCompoundIDFieldImpl::m_Port |
Definition at line 77 of file compound_id_impl.hpp.
◆ m_StringValue
| string SCompoundIDFieldImpl::m_StringValue |
Definition at line 83 of file compound_id_impl.hpp.
Referenced by s_DumpCompoundID().
◆ m_Type
| ECompoundIDFieldType SCompoundIDFieldImpl::m_Type |
Definition at line 69 of file compound_id_impl.hpp.
Referenced by SCompoundIDImpl::AppendField(), SCompoundIDImpl::Remove(), and s_DumpCompoundID().
◆ m_Uint4Value
| Uint4 SCompoundIDFieldImpl::m_Uint4Value |
Definition at line 74 of file compound_id_impl.hpp.
Referenced by s_DumpCompoundID().
◆ m_Uint8Value
| Uint8 SCompoundIDFieldImpl::m_Uint8Value |
Definition at line 72 of file compound_id_impl.hpp.
Referenced by s_DumpCompoundID().
The documentation for this struct was generated from the following files:
- src/connect/services/compound_id_impl.hpp
- src/connect/services/compound_id.cpp
