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

Search Toolkit Book for CTemplateScoringMethod

CTemplateMethod - describes a class of similar methods. More...

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

+ Inheritance diagram for CTemplateScoringMethod:
+ Collaboration diagram for CTemplateScoringMethod:

Public Types

enum  EColorGradType { eTwoColorGradient , eThreeColorGradient }
 
- 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
 

Public Member Functions

 CTemplateScoringMethod ()
 CTemplateScoringMethod. More...
 
virtual ~CTemplateScoringMethod ()
 
virtual bool LoadInfo (CNcbiRegistry &reg)
 loads only descriptive information More...
 
virtual bool Load (CNcbiRegistry &reg)
 
IScoringMethod / IUITool implementation
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 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...
 
Edit interface
void SetName (const string &s)
 
void SetDescription (const string &s)
 
virtual bool SaveInfo (CNcbiRegistry &reg)
 saves only descriptive information More...
 
virtual bool Save (CNcbiRegistry &reg)
 
- 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 ()
 
virtual const CRgbaColorGetColorForScore (TScore score, EColorType type) const =0
 returns a color corresponding to a given score value. More...
 
virtual const CRgbaColorGetColorForNoScore (IScoringMethod::EColorType type) const =0
 Call for display colors when CanCalculateScores returns false. More...
 
virtual void SetColorForNoScore (IScoringMethod::EColorType type, const CRgbaColor &color)=0
 
- Public Member Functions inherited from IUITool
virtual ~IUITool ()
 
virtual IUIToolClone () const =0
 
- Public Member Functions inherited from ITemplateUITool
virtual ~ITemplateUITool ()
 ITemplateUITool. More...
 

Protected Member Functions

CRgbaColor x_GetColor (CNcbiRegistry &reg, const string &key, const string def_value)
 
- Protected Member Functions inherited from CObject
virtual void DeleteThis (void)
 Virtual method "deleting" this object. More...
 

Protected Attributes

string m_Name
 
string m_Descr
 
int m_Type
 
bool m_Averageable
 
EColorGradType m_ColorGradType
 

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 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...
 

Detailed Description

CTemplateMethod - describes a class of similar methods.

Specific information for a particular incarnation is loaded from CNcbiRegistry.

Definition at line 192 of file scoring_method.hpp.

Member Enumeration Documentation

◆ EColorGradType

Enumerator
eTwoColorGradient 
eThreeColorGradient 

Definition at line 198 of file scoring_method.hpp.

Constructor & Destructor Documentation

◆ CTemplateScoringMethod()

CTemplateScoringMethod::CTemplateScoringMethod ( )

CTemplateScoringMethod.

Definition at line 96 of file scoring_method.cpp.

◆ ~CTemplateScoringMethod()

CTemplateScoringMethod::~CTemplateScoringMethod ( )
virtual

Definition at line 103 of file scoring_method.cpp.

Member Function Documentation

◆ GetDescription()

string CTemplateScoringMethod::GetDescription ( ) const
virtual

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

Implements IUITool.

Definition at line 114 of file scoring_method.cpp.

References m_Descr.

◆ GetName()

string CTemplateScoringMethod::GetName ( ) const
virtual

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

Implements IUITool.

Definition at line 108 of file scoring_method.cpp.

References m_Name.

◆ GetSupportedColorTypes()

int CTemplateScoringMethod::GetSupportedColorTypes ( ) const
virtual

returns a combination of EColorType flags

Implements IScoringMethod.

Reimplemented in CMatrixScoringMethod, CColumnScoringMethod, and CColorTableMethod.

Definition at line 132 of file scoring_method.cpp.

References IScoringMethod::fBackground.

◆ GetType()

int CTemplateScoringMethod::GetType ( ) const
virtual

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

Implements IScoringMethod.

Definition at line 120 of file scoring_method.cpp.

References m_Type.

◆ IsAverageable()

bool CTemplateScoringMethod::IsAverageable ( ) const
virtual

return "true" if scores could be averaged

Implements IScoringMethod.

Definition at line 126 of file scoring_method.cpp.

References m_Averageable.

◆ Load()

bool CTemplateScoringMethod::Load ( CNcbiRegistry reg)
virtual

Reimplemented from ITemplateUITool.

Reimplemented in CMatrixScoringMethod, CColumnScoringMethod, and CColorTableMethod.

Definition at line 196 of file scoring_method.cpp.

References LoadInfo().

◆ LoadInfo()

bool CTemplateScoringMethod::LoadInfo ( CNcbiRegistry reg)
virtual

◆ Save()

bool CTemplateScoringMethod::Save ( CNcbiRegistry reg)
virtual

Reimplemented from ITemplateUITool.

Reimplemented in CColorTableMethod.

Definition at line 214 of file scoring_method.cpp.

References SaveInfo().

◆ SaveInfo()

bool CTemplateScoringMethod::SaveInfo ( CNcbiRegistry reg)
virtual

◆ SetDescription()

void CTemplateScoringMethod::SetDescription ( const string s)
virtual

Implements ITemplateUITool.

Definition at line 208 of file scoring_method.cpp.

References m_Descr.

◆ SetName()

void CTemplateScoringMethod::SetName ( const string s)
virtual

Implements ITemplateUITool.

Definition at line 202 of file scoring_method.cpp.

References m_Name.

◆ x_GetColor()

CRgbaColor CTemplateScoringMethod::x_GetColor ( CNcbiRegistry reg,
const string key,
const string  def_value 
)
protected

Member Data Documentation

◆ m_Averageable

bool CTemplateScoringMethod::m_Averageable
protected

◆ m_ColorGradType

EColorGradType CTemplateScoringMethod::m_ColorGradType
protected

◆ m_Descr

string CTemplateScoringMethod::m_Descr
protected

Definition at line 241 of file scoring_method.hpp.

Referenced by GetDescription(), LoadInfo(), SaveInfo(), and SetDescription().

◆ m_Name

string CTemplateScoringMethod::m_Name
protected

Definition at line 240 of file scoring_method.hpp.

Referenced by GetName(), LoadInfo(), SaveInfo(), and SetName().

◆ m_Type

int CTemplateScoringMethod::m_Type
protected

Definition at line 242 of file scoring_method.hpp.

Referenced by GetType(), LoadInfo(), and SaveInfo().


The documentation for this class was generated from the following files:
Modified on Sat May 18 11:36:08 2024 by modify_doxy.py rev. 669887