NCBI C++ ToolKit
|
Search Toolkit Book for CTemplateScoringMethod
CTemplateMethod - describes a class of similar methods. More...
#include <gui/widgets/aln_score/scoring_method.hpp>
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< Uint8 > | TCounter |
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< TScore > | TScoreVector |
typedef CAttrRangeCollection< TScore, TSeqPos > | TScoreColl |
Public Member Functions | |
CTemplateScoringMethod () | |
CTemplateScoringMethod. More... | |
virtual | ~CTemplateScoringMethod () |
virtual bool | LoadInfo (CNcbiRegistry ®) |
loads only descriptive information More... | |
virtual bool | Load (CNcbiRegistry ®) |
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 ®) |
saves only descriptive information More... | |
virtual bool | Save (CNcbiRegistry ®) |
Public Member Functions inherited from CObject | |
CObject (void) | |
Constructor. More... | |
CObject (const CObject &src) | |
Copy constructor. More... | |
virtual | ~CObject (void) |
Destructor. More... | |
CObject & | operator= (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 CRgbaColor & | GetColorForScore (TScore score, EColorType type) const =0 |
returns a color corresponding to a given score value. More... | |
virtual const CRgbaColor & | GetColorForNoScore (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 IUITool * | Clone () const =0 |
Public Member Functions inherited from ITemplateUITool | |
virtual | ~ITemplateUITool () |
ITemplateUITool. More... | |
Protected Member Functions | |
CRgbaColor | x_GetColor (CNcbiRegistry ®, 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... | |
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.
Enumerator | |
---|---|
eTwoColorGradient | |
eThreeColorGradient |
Definition at line 198 of file scoring_method.hpp.
CTemplateScoringMethod::CTemplateScoringMethod | ( | ) |
Definition at line 96 of file scoring_method.cpp.
|
virtual |
Definition at line 103 of file scoring_method.cpp.
|
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.
|
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.
|
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.
|
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.
|
virtual |
return "true" if scores could be averaged
Implements IScoringMethod.
Definition at line 126 of file scoring_method.cpp.
References m_Averageable.
|
virtual |
Reimplemented from ITemplateUITool.
Reimplemented in CMatrixScoringMethod, CColumnScoringMethod, and CColorTableMethod.
Definition at line 196 of file scoring_method.cpp.
References LoadInfo().
|
virtual |
loads only descriptive information
Implements ITemplateUITool.
Definition at line 138 of file scoring_method.cpp.
References ERR_POST, eThreeColorGradient, eTwoColorGradient, IAlnExplorer::fDNA, IAlnExplorer::fProtein, NStr::fSplit_Tokenize, IRegistry::Get(), IRegistry::GetString(), ITERATE, m_ColorGradType, m_Descr, m_Name, m_Type, NStr::Split(), and val.
Referenced by Load(), CColorTableMethod::Load(), CColumnScoringMethod::Load(), and CMatrixScoringMethod::Load().
|
virtual |
Reimplemented from ITemplateUITool.
Reimplemented in CColorTableMethod.
Definition at line 214 of file scoring_method.cpp.
References SaveInfo().
|
virtual |
saves only descriptive information
Implements ITemplateUITool.
Definition at line 169 of file scoring_method.cpp.
References eThreeColorGradient, IAlnExplorer::fDNA, IRegistry::fPersistent, IAlnExplorer::fProtein, IRegistry::fTruncate, m_ColorGradType, m_Descr, m_Name, m_Type, IRWRegistry::Set(), and types.
Referenced by Save(), and CColorTableMethod::Save().
|
protected |
Definition at line 220 of file scoring_method.cpp.
References color, CRgbaColor::GetColor(), IRegistry::GetString(), ncbi::grid::netcache::search::fields::key, and str().
Referenced by CColumnScoringMethod::Load(), and CMatrixScoringMethod::Load().
|
protected |
Definition at line 243 of file scoring_method.hpp.
Referenced by CColumnScoringMethod::CColumnScoringMethod(), CMatrixScoringMethod::CMatrixScoringMethod(), and IsAverageable().
|
protected |
Definition at line 245 of file scoring_method.hpp.
Referenced by CColumnScoringMethod::CreateColorTable(), CMatrixScoringMethod::CreateColorTable(), CColumnScoringPanel::CreateControls(), CMatrixScoringPanel::CreateControls(), LoadInfo(), and SaveInfo().
|
protected |
Definition at line 241 of file scoring_method.hpp.
Referenced by GetDescription(), LoadInfo(), SaveInfo(), and SetDescription().
|
protected |
Definition at line 240 of file scoring_method.hpp.
Referenced by GetName(), LoadInfo(), SaveInfo(), and SetName().
|
protected |
Definition at line 242 of file scoring_method.hpp.
Referenced by GetType(), LoadInfo(), and SaveInfo().