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

Search Toolkit Book for CPSIMatrix

Wrapper class for PSIMatrix . More...

#include <algo/blast/api/blast_aux.hpp>

+ Inheritance diagram for CPSIMatrix:
+ Collaboration diagram for CPSIMatrix:

Public Member Functions

 CPSIMatrix ()
 
 CPSIMatrix (PSIMatrix *p)
 
virtual ~CPSIMatrix ()
 
void Reset (PSIMatrix *p=NULL)
 
PSIMatrixRelease ()
 
PSIMatrixGet () const
 
 operator PSIMatrix * ()
 
 operator PSIMatrix * () const
 
PSIMatrixoperator-> ()
 
PSIMatrixoperator-> () const
 
PSIMatrix ** operator& ()
 
virtual void DebugDump (CDebugDumpContext ddc, unsigned int depth) const
 Define method for dumping debug information. More...
 
- 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...
 
- 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

PSIMatrixm_Ptr
 

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 CAtomicCounter TCounter
 Counter type is CAtomiCounter. More...
 
typedef TCounter::TValue TCount
 Alias for value type of counter. More...
 
- Static Public Member Functions inherited from CObject
static NCBI_NORETURN void ThrowNullPointerException (void)
 Define method to throw null pointer exception. More...
 
static NCBI_NORETURN 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

Wrapper class for PSIMatrix .

Definition at line 320 of file blast_aux.hpp.

Constructor & Destructor Documentation

CPSIMatrix::CPSIMatrix ( )
inline

Definition at line 320 of file blast_aux.hpp.

CPSIMatrix::CPSIMatrix ( PSIMatrix p)
inline

Definition at line 320 of file blast_aux.hpp.

virtual CPSIMatrix::~CPSIMatrix ( )
inlinevirtual

Definition at line 320 of file blast_aux.hpp.

Member Function Documentation

PSIMatrix* CPSIMatrix::Get ( ) const
inline

Definition at line 320 of file blast_aux.hpp.

CPSIMatrix::operator PSIMatrix * ( )
inline

Definition at line 320 of file blast_aux.hpp.

CPSIMatrix::operator PSIMatrix * ( ) const
inline

Definition at line 320 of file blast_aux.hpp.

PSIMatrix** CPSIMatrix::operator& ( )
inline

Definition at line 320 of file blast_aux.hpp.

PSIMatrix* CPSIMatrix::operator-> ( ) const
inline

Definition at line 320 of file blast_aux.hpp.

PSIMatrix* CPSIMatrix::operator-> ( )
inline

Definition at line 320 of file blast_aux.hpp.

PSIMatrix* CPSIMatrix::Release ( )
inline

Definition at line 320 of file blast_aux.hpp.

void CPSIMatrix::Reset ( PSIMatrix p = NULL)
inline

Definition at line 320 of file blast_aux.hpp.

Member Data Documentation

PSIMatrix* CPSIMatrix::m_Ptr
private

Definition at line 320 of file blast_aux.hpp.

Referenced by DebugDump().


The documentation for this class was generated from the following files:
Modified on Tue Jul 26 18:35:33 2016 by modify_doxy.py rev. 506947