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

Search Toolkit Book for CSNPScoringMethod

CSNPScoringMethod. More...

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

+ Inheritance diagram for CSNPScoringMethod:
+ Collaboration diagram for CSNPScoringMethod:

Public Member Functions

 CSNPScoringMethod ()
 CSNPScoringMethod. More...
 
 CSNPScoringMethod (const CSNPScoringMethod &orig)
 
virtual void CalculateScores (char cons, const string &column, TScore &col_score, TScoreVector &scores)
 
virtual bool CanCalculateScores (const IScoringAlignment &aln)
 Do we have what it takes to calculate scores? e.g. a master row selected? More...
 
virtual const CRgbaColorGetColorForNoScore (EColorType type) const
 Call for display colors when CanCalculateScores returns false. More...
 
virtual void SetColorForNoScore (EColorType type, const CRgbaColor &color)
 
IScoringMethod implementation
virtual IUIToolClone () const
 
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...
 
virtual int GetSupportedColorTypes () const
 returns a combination of EColorType flags More...
 
virtual const CRgbaColorGetColorForScore (TScore score, EColorType type) const
 returns a color corresponding to a given score value. More...
 
IUIToolWithGUI implementation
virtual const CMenuItemGetMenu ()
 Returns a pointer to the submenu. More...
 
virtual bool HasPropertiesPanel () const
 returns true if the method supports properties dialog More...
 
virtual wxWindow * CreatePropertiesPanel (wxWindow *parent)
 This a factory method that shall produce a CPropertiesPanel representing properties of the method; the panel Apply() must take care of appying changes to the method. More...
 
- Public Member Functions inherited from CSimpleScoringMethod
 CSimpleScoringMethod ()
 CSimpleScoringMethod. More...
 
 CSimpleScoringMethod (int colors)
 
 CSimpleScoringMethod (const CSimpleScoringMethod &orig)
 
virtual ~CSimpleScoringMethod ()
 
void SetOptions (int options)
 
int GetOptions ()
 
void CreateColorTable (int size)
 
virtual 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...
 
- 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 IColumnScoringMethod
virtual ~IColumnScoringMethod ()
 
virtual bool NeedsTranslation () const
 
virtual void UpdateSettings (const IScoringAlignment &aln)
 Set alignment specifi settings. More...
 
- Public Member Functions inherited from IUIToolWithGUI
virtual ~IUIToolWithGUI ()
 
virtual ~IUIToolWithGUI ()
 

Protected Attributes

CRgbaColor m_UndefColor
 
bool m_NoScores
 
- Protected Attributes inherited from CSimpleScoringMethod
int m_Options
 
CRgbaColor m_Worst
 combination of EOptions flags More...
 
CRgbaColor m_Best
 
CRgbaGradColorTable m_ColorTable
 
vector< intm_vCharCounts
 
char m_Space
 histogramm of characters More...
 
char m_Gap
 
unique_ptr< CMenuItemm_Menu
 
- Protected Attributes inherited from IColumnScoringMethod
char m_AmbiguousResidue = ' '
 Ambiguous Residue, typically 'N' for nucleotides, 'X' for proteins. More...
 
std::function< bool(char c, char b)> mf_CompareResidue
 

Friends

class CSNPScoringPanel
 

Additional Inherited Members

- Public Types inherited from CSimpleScoringMethod
enum  EOptions { fIgnoreEmptySpace = 0x01 , fIgnoreGaps = 0x02 }
 
- 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...
 
- Static Public Attributes inherited from IColumnScoringMethod
static const int kAmbiguousResidueScore = 1000
 
- Protected Member Functions inherited from CObject
virtual void DeleteThis (void)
 Virtual method "deleting" this object. More...
 

Detailed Description

CSNPScoringMethod.

Definition at line 126 of file simple_methods.hpp.

Constructor & Destructor Documentation

◆ CSNPScoringMethod() [1/2]

CSNPScoringMethod::CSNPScoringMethod ( )

CSNPScoringMethod.

Definition at line 422 of file simple_methods.cpp.

Referenced by Clone().

◆ CSNPScoringMethod() [2/2]

CSNPScoringMethod::CSNPScoringMethod ( const CSNPScoringMethod orig)

Definition at line 430 of file simple_methods.cpp.

Member Function Documentation

◆ CalculateScores()

void CSNPScoringMethod::CalculateScores ( char  cons,
const string column,
TScore col_score,
TScoreVector scores 
)
virtual

◆ CanCalculateScores()

bool CSNPScoringMethod::CanCalculateScores ( const IScoringAlignment aln)
virtual

Do we have what it takes to calculate scores? e.g. a master row selected?

Reimplemented from CSimpleScoringMethod.

Definition at line 500 of file simple_methods.cpp.

◆ Clone()

IUITool * CSNPScoringMethod::Clone ( void  ) const
virtual

Reimplemented from CSimpleScoringMethod.

Definition at line 437 of file simple_methods.cpp.

References CSNPScoringMethod().

◆ CreatePropertiesPanel()

wxWindow * CSNPScoringMethod::CreatePropertiesPanel ( wxWindow *  parent)
virtual

This a factory method that shall produce a CPropertiesPanel representing properties of the method; the panel Apply() must take care of appying changes to the method.

Reimplemented from CSimpleScoringMethod.

Definition at line 630 of file simple_methods.cpp.

References CSNPScoringPanel.

◆ GetColorForNoScore()

const CRgbaColor & CSNPScoringMethod::GetColorForNoScore ( EColorType  type) const
virtual

Call for display colors when CanCalculateScores returns false.

Reimplemented from CSimpleScoringMethod.

Definition at line 506 of file simple_methods.cpp.

References _VERIFY, IScoringMethod::fBackground, and m_UndefColor.

◆ GetColorForScore()

const CRgbaColor & CSNPScoringMethod::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.

Reimplemented from CSimpleScoringMethod.

Definition at line 521 of file simple_methods.cpp.

References CSimpleScoringMethod::GetColorForScore(), and m_UndefColor.

◆ GetDescription()

string CSNPScoringMethod::GetDescription ( ) const
virtual

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

Reimplemented from CSimpleScoringMethod.

Definition at line 454 of file simple_methods.cpp.

References SNP_DESCR.

◆ GetMenu()

const CMenuItem * CSNPScoringMethod::GetMenu ( )
virtual

Returns a pointer to the submenu.

If the pointer is not NULL, then this submenu is integrated into the application's menu. If method is derived from CCommandTarget it will recieve command events.

Reimplemented from CSimpleScoringMethod.

Definition at line 532 of file simple_methods.cpp.

References CSimpleScoringMethod::m_Menu.

◆ GetName()

string CSNPScoringMethod::GetName ( ) const
virtual

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

Reimplemented from CSimpleScoringMethod.

Definition at line 443 of file simple_methods.cpp.

◆ GetSupportedColorTypes()

int CSNPScoringMethod::GetSupportedColorTypes ( ) const
virtual

returns a combination of EColorType flags

Reimplemented from CSimpleScoringMethod.

Definition at line 494 of file simple_methods.cpp.

References IScoringMethod::fBackground.

◆ HasPropertiesPanel()

bool CSNPScoringMethod::HasPropertiesPanel ( ) const
virtual

returns true if the method supports properties dialog

Reimplemented from CSimpleScoringMethod.

Definition at line 538 of file simple_methods.cpp.

◆ SetColorForNoScore()

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

Reimplemented from CSimpleScoringMethod.

Definition at line 513 of file simple_methods.cpp.

References _VERIFY, color, IScoringMethod::fBackground, and m_UndefColor.

Friends And Related Function Documentation

◆ CSNPScoringPanel

friend class CSNPScoringPanel
friend

Definition at line 130 of file simple_methods.hpp.

Referenced by CreatePropertiesPanel().

Member Data Documentation

◆ m_NoScores

bool CSNPScoringMethod::m_NoScores
protected

Definition at line 163 of file simple_methods.hpp.

◆ m_UndefColor

CRgbaColor CSNPScoringMethod::m_UndefColor
protected

The documentation for this class was generated from the following files:
Modified on Sat Apr 13 11:44:06 2024 by modify_doxy.py rev. 669887