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

Search Toolkit Book for CCDDBlobId

#include <objtools/data_loaders/cdd/cdd_loader/cdd_loader_impl.hpp>

+ Inheritance diagram for CCDDBlobId:
+ Collaboration diagram for CCDDBlobId:

Public Types

using TSat = CID2_Blob_Id::TSat
 
using TSubSat = CID2_Blob_Id::TSub_sat
 
using TSatKey = CID2_Blob_Id::TSat_key
 
using TVersion = CID2_Blob_Id::TVersion
 
- 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

 CCDDBlobId (void)
 
 CCDDBlobId (CTempString str_id)
 
 CCDDBlobId (const CID2_Blob_Id &blob_id)
 
const CID2_Blob_IdGet (void) const
 
CID2_Blob_IdGet (void)
 
TSat GetSat (void) const
 
TSubSat GetSubSat (void) const
 
TSatKey GetSatKey (void) const
 
TVersion GetVersion (void) const
 
string ToString (void) const
 Get string representation of blob id. More...
 
bool operator< (const CBlobId &blob_id) const
 
bool operator== (const CBlobId &blob_id) const
 
bool operator< (const CCDDBlobId &blob_id) const
 
bool operator== (const CCDDBlobId &blob_id) const
 
bool operator!= (const CCDDBlobId &blob_id) const
 
bool IsEmpty (void) const
 
- Public Member Functions inherited from CBlobId
virtual ~CBlobId (void)
 
- 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

CRef< CID2_Blob_Idm_Id2BlobId
 

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...
 
- Protected Member Functions inherited from CBlobId
bool LessByTypeId (const CBlobId &id2) const
 
- Protected Member Functions inherited from CObject
virtual void DeleteThis (void)
 Virtual method "deleting" this object. More...
 

Detailed Description

Definition at line 48 of file cdd_loader_impl.hpp.

Member Typedef Documentation

◆ TSat

Definition at line 51 of file cdd_loader_impl.hpp.

◆ TSatKey

Definition at line 53 of file cdd_loader_impl.hpp.

◆ TSubSat

Definition at line 52 of file cdd_loader_impl.hpp.

◆ TVersion

Definition at line 54 of file cdd_loader_impl.hpp.

Constructor & Destructor Documentation

◆ CCDDBlobId() [1/3]

CCDDBlobId::CCDDBlobId ( void  )
inline

Definition at line 56 of file cdd_loader_impl.hpp.

◆ CCDDBlobId() [2/3]

CCDDBlobId::CCDDBlobId ( CTempString  str_id)
explicit

Definition at line 236 of file cdd_loader.cpp.

References Get().

◆ CCDDBlobId() [3/3]

CCDDBlobId::CCDDBlobId ( const CID2_Blob_Id blob_id)

Definition at line 246 of file cdd_loader.cpp.

References CSerialObject::Assign(), m_Id2BlobId, and CRef< C, Locker >::Reset().

Member Function Documentation

◆ Get() [1/2]

CID2_Blob_Id & CCDDBlobId::Get ( void  )

Definition at line 262 of file cdd_loader.cpp.

References m_Id2BlobId, and CRef< C, Locker >::Reset().

◆ Get() [2/2]

const CID2_Blob_Id & CCDDBlobId::Get ( void  ) const

Definition at line 253 of file cdd_loader.cpp.

References m_Id2BlobId, and CRef< C, Locker >::Reset().

Referenced by CCDDBlobId().

◆ GetSat()

TSat CCDDBlobId::GetSat ( void  ) const
inline

Definition at line 64 of file cdd_loader_impl.hpp.

Referenced by operator==().

◆ GetSatKey()

TSatKey CCDDBlobId::GetSatKey ( void  ) const
inline

Definition at line 66 of file cdd_loader_impl.hpp.

Referenced by operator==().

◆ GetSubSat()

TSubSat CCDDBlobId::GetSubSat ( void  ) const
inline

Definition at line 65 of file cdd_loader_impl.hpp.

Referenced by operator==().

◆ GetVersion()

TVersion CCDDBlobId::GetVersion ( void  ) const
inline

Definition at line 67 of file cdd_loader_impl.hpp.

Referenced by operator==().

◆ IsEmpty()

bool CCDDBlobId::IsEmpty ( void  ) const
inline

Definition at line 78 of file cdd_loader_impl.hpp.

Referenced by operator<(), operator==(), and ToString().

◆ operator!=()

bool CCDDBlobId::operator!= ( const CCDDBlobId blob_id) const
inline

Definition at line 76 of file cdd_loader_impl.hpp.

◆ operator<() [1/2]

bool CCDDBlobId::operator< ( const CBlobId blob_id) const
virtual

Implements CBlobId.

Definition at line 282 of file cdd_loader.cpp.

◆ operator<() [2/2]

bool CCDDBlobId::operator< ( const CCDDBlobId blob_id) const

Definition at line 304 of file cdd_loader.cpp.

References CMP_MEMBER, and IsEmpty().

◆ operator==() [1/2]

bool CCDDBlobId::operator== ( const CBlobId blob_id) const
virtual

Reimplemented from CBlobId.

Definition at line 289 of file cdd_loader.cpp.

◆ operator==() [2/2]

bool CCDDBlobId::operator== ( const CCDDBlobId blob_id) const

Definition at line 317 of file cdd_loader.cpp.

References GetSat(), GetSatKey(), GetSubSat(), GetVersion(), and IsEmpty().

◆ ToString()

string CCDDBlobId::ToString ( void  ) const
virtual

Get string representation of blob id.

Should be unique for all blob ids from the same data loader.

Implements CBlobId.

Definition at line 271 of file cdd_loader.cpp.

References IsEmpty(), and m_Id2BlobId.

Member Data Documentation

◆ m_Id2BlobId

CRef<CID2_Blob_Id> CCDDBlobId::m_Id2BlobId
mutableprivate

Definition at line 81 of file cdd_loader_impl.hpp.

Referenced by CCDDBlobId(), Get(), and ToString().


The documentation for this class was generated from the following files:
Modified on Mon May 20 05:04:51 2024 by modify_doxy.py rev. 669887