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

Search Toolkit Book for CTestSeqBasedMethod

CTestSeqBasedMethod. More...

#include <gui/widgets/aln_score/simple_methods.hpp>

+ Inheritance diagram for CTestSeqBasedMethod:
+ Collaboration diagram for CTestSeqBasedMethod:

Public Member Functions

 CTestSeqBasedMethod ()
 CTestSeqBasedMethod. More...
 
virtual IUIToolClone () const
 
void CreateColorTable ()
 
virtual string GetName () const
 returns unique name of the method that is used in UI to identify it More...
 
virtual string GetDescription () const
 returns a detailed description of the method that is used in UI More...
 
int GetType () const
 returns combination of EAlignType flags defining types of alignments that can be colored with this method More...
 
virtual bool IsAverageable () const
 return "true" if scores could be averaged More...
 
virtual int GetSupportedColorTypes () const
 returns a combination of EColorType flags More...
 
virtual void CalculateScores (IAlnExplorer::TNumrow row, const IScoringAlignment &aln, TScoreColl &scores)
 
virtual const CRgbaColorGetColorForScore (TScore score, EColorType type) const
 returns a color corresponding to a given score value. More...
 
virtual const CRgbaColorGetColorForNoScore (IScoringMethod::EColorType type) const
 Call for display colors when CanCalculateScores returns false. More...
 
virtual void SetColorForNoScore (IScoringMethod::EColorType type, const CRgbaColor &color)
 
- 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 IScoringMethod
virtual ~IScoringMethod ()
 
- Public Member Functions inherited from IUITool
virtual ~IUITool ()
 
- Public Member Functions inherited from IRowScoringMethod
virtual ~IRowScoringMethod ()
 

Protected Attributes

vector< CRgbaColorm_vColors
 
CRgbaColor m_NoScoreColor
 

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...
 
- Public Types inherited from IScoringMethod
enum  EColorType { fBackground = 0x1 , fForeground = 0x2 }
 
typedef float TScore
 
typedef vector< TScoreTScoreVector
 
typedef CAttrRangeCollection< TScore, TSeqPosTScoreColl
 
- 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 Member Functions inherited from IScoringMethod
static const char * GetAlignmentTagByType (IAlnExplorer::EAlignType type)
 returns symbolic label for the given alignment type, should be More...
 
static IAlnExplorer::EAlignType GetAlignmentTypeByTag (const string &tag)
 
- 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...
 
- Static Public Attributes inherited from IScoringMethod
static const int sm_DefGradientSize = 32
 default number of colors in gradient More...
 
- Protected Member Functions inherited from CObject
virtual void DeleteThis (void)
 Virtual method "deleting" this object. More...
 

Detailed Description

CTestSeqBasedMethod.

Definition at line 171 of file simple_methods.hpp.

Constructor & Destructor Documentation

◆ CTestSeqBasedMethod()

CTestSeqBasedMethod::CTestSeqBasedMethod ( )

CTestSeqBasedMethod.

Definition at line 639 of file simple_methods.cpp.

References CreateColorTable().

Referenced by Clone().

Member Function Documentation

◆ CalculateScores()

void CTestSeqBasedMethod::CalculateScores ( IAlnExplorer::TNumrow  row,
const IScoringAlignment aln,
TScoreColl scores 
)
virtual

◆ Clone()

IUITool * CTestSeqBasedMethod::Clone ( void  ) const
virtual

Implements IUITool.

Definition at line 645 of file simple_methods.cpp.

References CTestSeqBasedMethod().

◆ CreateColorTable()

void CTestSeqBasedMethod::CreateColorTable ( )

Definition at line 651 of file simple_methods.cpp.

References m_vColors.

Referenced by CTestSeqBasedMethod().

◆ GetColorForNoScore()

const CRgbaColor & CTestSeqBasedMethod::GetColorForNoScore ( IScoringMethod::EColorType  type) const
virtual

Call for display colors when CanCalculateScores returns false.

Implements IScoringMethod.

Definition at line 745 of file simple_methods.cpp.

References _VERIFY, IScoringMethod::fBackground, and m_NoScoreColor.

◆ GetColorForScore()

const CRgbaColor & CTestSeqBasedMethod::GetColorForScore ( TScore  score,
EColorType  type 
) const
virtual

returns a color corresponding to a given score value.

It is recommended that this method be implemented using color table, on-the-fly creation of colors is expensive.

Implements IScoringMethod.

Definition at line 734 of file simple_methods.cpp.

References _ASSERT, _VERIFY, IScoringMethod::fBackground, and m_vColors.

◆ GetDescription()

string CTestSeqBasedMethod::GetDescription ( ) const
virtual

returns a detailed description of the method that is used in UI

Implements IUITool.

Definition at line 668 of file simple_methods.cpp.

◆ GetName()

string CTestSeqBasedMethod::GetName ( ) const
virtual

returns unique name of the method that is used in UI to identify it

Implements IUITool.

Definition at line 662 of file simple_methods.cpp.

◆ GetSupportedColorTypes()

int CTestSeqBasedMethod::GetSupportedColorTypes ( ) const
virtual

returns a combination of EColorType flags

Implements IScoringMethod.

Definition at line 728 of file simple_methods.cpp.

References IScoringMethod::fBackground.

◆ GetType()

int CTestSeqBasedMethod::GetType ( ) const
virtual

returns combination of EAlignType flags defining types of alignments that can be colored with this method

Implements IScoringMethod.

Definition at line 674 of file simple_methods.cpp.

References IAlnExplorer::fDNA.

◆ IsAverageable()

bool CTestSeqBasedMethod::IsAverageable ( ) const
virtual

return "true" if scores could be averaged

Implements IScoringMethod.

Definition at line 680 of file simple_methods.cpp.

◆ SetColorForNoScore()

void CTestSeqBasedMethod::SetColorForNoScore ( IScoringMethod::EColorType  type,
const CRgbaColor color 
)
virtual

Implements IScoringMethod.

Definition at line 752 of file simple_methods.cpp.

References color.

Member Data Documentation

◆ m_NoScoreColor

CRgbaColor CTestSeqBasedMethod::m_NoScoreColor
protected

Definition at line 201 of file simple_methods.hpp.

Referenced by GetColorForNoScore().

◆ m_vColors

vector<CRgbaColor> CTestSeqBasedMethod::m_vColors
protected

Definition at line 200 of file simple_methods.hpp.

Referenced by CreateColorTable(), and GetColorForScore().


The documentation for this class was generated from the following files:
Modified on Tue May 28 05:53:28 2024 by modify_doxy.py rev. 669887