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

Search Toolkit Book for CConsensusRow

Class CConsensusRow - Simple interface to a row that represents the consensus for rendering purposes. More...

#include <gui/widgets/aln_multiple/alnmulti_ds.hpp>

+ Inheritance diagram for CConsensusRow:
+ Collaboration diagram for CConsensusRow:

Public Types

typedef IAlnExplorer::TSignedRange TSignedRange
 
- 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

 CConsensusRow (const IAlignRowHandle *handle)
 
 ~CConsensusRow ()
 
const IAlignRowHandleGetHandle () const
 
void SetHandle (const IAlignRowHandle *h)
 
bool IsValid () const
 
virtual stringGetAlnSeqString (string &buffer, const IAlnExplorer::TSignedRange &aln_rng) const
 
virtual stringGetStringAtPos (string &buffer, TSignedSeqPos aln_pos) const
 
- Public Member Functions inherited from CObjectEx
 CObjectEx (void)
 
virtual ~CObjectEx (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
 
- Public Member Functions inherited from CWeakObject
 CWeakObject (void)
 
virtual ~CWeakObject (void)
 
CPtrToObjectProxyGetPtrProxy (void) const
 Get pointer to proxy object containing pointer to this object. More...
 

Protected Attributes

const IAlignRowHandlem_Handle
 

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 CObject
virtual void DeleteThis (void)
 Virtual method "deleting" this object. More...
 
- Protected Member Functions inherited from CWeakObject
void CleanWeakRefs (void) const
 Method cleaning all CWeakRefs referencing at this moment to the object After calling to this method all existing CWeakRefs referencing to the object will return NULL, so it effectively will be equal to deleting the object. More...
 

Detailed Description

Class CConsensusRow - Simple interface to a row that represents the consensus for rendering purposes.

Rows need access to a consensus row, which may be a consensus or selected master row, for rendering. It gives the row the option to not render characters when they match the consensus

Definition at line 145 of file alnmulti_ds.hpp.

Member Typedef Documentation

◆ TSignedRange

Definition at line 149 of file alnmulti_ds.hpp.

Constructor & Destructor Documentation

◆ CConsensusRow()

CConsensusRow::CConsensusRow ( const IAlignRowHandle handle)
inline

Definition at line 152 of file alnmulti_ds.hpp.

◆ ~CConsensusRow()

CConsensusRow::~CConsensusRow ( )
inline

Definition at line 155 of file alnmulti_ds.hpp.

Member Function Documentation

◆ GetAlnSeqString()

string & CConsensusRow::GetAlnSeqString ( string buffer,
const IAlnExplorer::TSignedRange aln_rng 
) const
inlinevirtual

◆ GetHandle()

const IAlignRowHandle& CConsensusRow::GetHandle ( void  ) const
inline

Definition at line 157 of file alnmulti_ds.hpp.

References m_Handle.

Referenced by CAlnVecRow::x_RenderSequence().

◆ GetStringAtPos()

string & CConsensusRow::GetStringAtPos ( string buffer,
TSignedSeqPos  aln_pos 
) const
inlinevirtual

◆ IsValid()

bool CConsensusRow::IsValid ( void  ) const
inline

Definition at line 160 of file alnmulti_ds.hpp.

References m_Handle, and NULL.

Referenced by CAlnVecRow::x_RenderSequence().

◆ SetHandle()

void CConsensusRow::SetHandle ( const IAlignRowHandle h)
inline

Definition at line 158 of file alnmulti_ds.hpp.

References m_Handle.

Referenced by CAlnMultiModel::CreateRows(), and CAlnMultiModel::SetMasterRow().

Member Data Documentation

◆ m_Handle

const IAlignRowHandle* CConsensusRow::m_Handle
protected

Definition at line 166 of file alnmulti_ds.hpp.

Referenced by GetAlnSeqString(), GetHandle(), GetStringAtPos(), IsValid(), and SetHandle().


The documentation for this class was generated from the following file:
Modified on Sat Feb 24 07:47:14 2024 by modify_doxy.py rev. 669887