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

Search Toolkit Book for CMasterContext

#include <objtools/format/context.hpp>

+ Inheritance diagram for CMasterContext:
+ Collaboration diagram for CMasterContext:

Public Member Functions

 CMasterContext (const CBioseq_Handle &master)
 
 ~CMasterContext (void)
 
const CBioseq_HandleGetHandle (void) const
 
SIZE_TYPE GetNumParts (void) const
 
const stringGetBaseName (void) const
 
SIZE_TYPE GetPartNumber (const CBioseq_Handle &part)
 
- 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 Member Functions

void x_SetBaseName (void)
 
void x_SetNumParts (void)
 

Private Attributes

CBioseq_Handle m_Handle
 
string m_BaseName
 
SIZE_TYPE m_NumParts
 

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 404 of file context.hpp.

Constructor & Destructor Documentation

◆ CMasterContext()

CMasterContext::CMasterContext ( const CBioseq_Handle master)

◆ ~CMasterContext()

CMasterContext::~CMasterContext ( void  )

Definition at line 1118 of file context.cpp.

Member Function Documentation

◆ GetBaseName()

const string& CMasterContext::GetBaseName ( void  ) const
inline

Definition at line 417 of file context.hpp.

References m_BaseName.

◆ GetHandle()

const CBioseq_Handle& CMasterContext::GetHandle ( void  ) const
inline

Definition at line 413 of file context.hpp.

References m_Handle.

◆ GetNumParts()

SIZE_TYPE CMasterContext::GetNumParts ( void  ) const
inline

Definition at line 415 of file context.hpp.

References m_NumParts.

Referenced by CBioseqContext::GetTotalNumParts().

◆ GetPartNumber()

SIZE_TYPE CMasterContext::GetPartNumber ( const CBioseq_Handle part)

◆ x_SetBaseName()

void CMasterContext::x_SetBaseName ( void  )
private

◆ x_SetNumParts()

void CMasterContext::x_SetNumParts ( void  )
private

Member Data Documentation

◆ m_BaseName

string CMasterContext::m_BaseName
private

Definition at line 428 of file context.hpp.

Referenced by GetBaseName(), and x_SetBaseName().

◆ m_Handle

CBioseq_Handle CMasterContext::m_Handle
private

Definition at line 427 of file context.hpp.

Referenced by GetHandle(), GetPartNumber(), x_SetBaseName(), and x_SetNumParts().

◆ m_NumParts

SIZE_TYPE CMasterContext::m_NumParts
private

Definition at line 429 of file context.hpp.

Referenced by GetNumParts(), and x_SetNumParts().


The documentation for this class was generated from the following files:
Modified on Sun Jun 23 05:19:35 2024 by modify_doxy.py rev. 669887