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

Search Toolkit Book for CPsgBlobId

#include <objtools/data_loaders/genbank/psg_loader.hpp>

+ Inheritance diagram for CPsgBlobId:
+ Collaboration diagram for CPsgBlobId:

Public Member Functions

 CPsgBlobId (const string &id)
 
 CPsgBlobId (const string &id, const string &id2_info)
 
virtual ~CPsgBlobId ()
 
const stringToPsgId () const
 
virtual string ToString (void) const override
 Get string representation of blob id. More...
 
virtual bool operator< (const CBlobId &id) const override
 
virtual bool operator== (const CBlobId &id) const override
 
const stringGetId2Info () const
 
void SetId2Info (const string &id2_info)
 
bool GetSatSatkey (int &sat, int &satkey) 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
 

Static Public Member Functions

static CConstRef< CPsgBlobIdGetPsgBlobId (const CBlobId &blob_id)
 
- 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)
 

Private Attributes

string m_Id
 
string m_Id2Info
 

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 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 52 of file psg_loader.hpp.

Constructor & Destructor Documentation

◆ CPsgBlobId() [1/2]

CPsgBlobId::CPsgBlobId ( const string id)
explicit

Definition at line 75 of file psg_loader.cpp.

Referenced by GetPsgBlobId().

◆ CPsgBlobId() [2/2]

CPsgBlobId::CPsgBlobId ( const string id,
const string id2_info 
)

Definition at line 81 of file psg_loader.cpp.

◆ ~CPsgBlobId()

CPsgBlobId::~CPsgBlobId ( )
virtual

Definition at line 88 of file psg_loader.cpp.

Member Function Documentation

◆ GetId2Info()

const string& CPsgBlobId::GetId2Info ( ) const
inline

Definition at line 68 of file psg_loader.hpp.

References m_Id2Info.

Referenced by CPSGDataLoader_Impl::LoadChunksOnce(), and SPsgBlobInfo::SPsgBlobInfo().

◆ GetPsgBlobId()

CConstRef< CPsgBlobId > CPsgBlobId::GetPsgBlobId ( const CBlobId blob_id)
static

◆ GetSatSatkey()

bool CPsgBlobId::GetSatSatkey ( int sat,
int satkey 
) const

Definition at line 116 of file psg_loader.cpp.

References m_Id, and NStr::SplitInTwo().

Referenced by CPSGDataLoader::x_GetRealBlobId().

◆ operator<()

bool CPsgBlobId::operator< ( const CBlobId id) const
overridevirtual

Implements CBlobId.

Definition at line 106 of file psg_loader.cpp.

References CBlobId::LessByTypeId(), and m_Id.

◆ operator==()

bool CPsgBlobId::operator== ( const CBlobId id) const
overridevirtual

Reimplemented from CBlobId.

Definition at line 99 of file psg_loader.cpp.

References m_Id.

◆ SetId2Info()

void CPsgBlobId::SetId2Info ( const string id2_info)
inline

Definition at line 72 of file psg_loader.hpp.

References m_Id2Info.

Referenced by CPSG_Blob_Task::DoExecute().

◆ ToPsgId()

const string& CPsgBlobId::ToPsgId ( void  ) const
inline

◆ ToString()

string CPsgBlobId::ToString ( void  ) const
overridevirtual

Get string representation of blob id.

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

Implements CBlobId.

Definition at line 93 of file psg_loader.cpp.

References m_Id.

Referenced by CPSGDataLoader_Impl::GetBlobByIdOnce().

Member Data Documentation

◆ m_Id

string CPsgBlobId::m_Id
private

Definition at line 82 of file psg_loader.hpp.

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

◆ m_Id2Info

string CPsgBlobId::m_Id2Info
private

Definition at line 83 of file psg_loader.hpp.

Referenced by GetId2Info(), and SetId2Info().


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