NCBI C++ ToolKit
Public Member Functions | Public Attributes | List of all members
SHitColoringParams Struct Reference

Search Toolkit Book for SHitColoringParams

#include <gui/widgets/hit_matrix/hit_coloring.hpp>

+ Inheritance diagram for SHitColoringParams:
+ Collaboration diagram for SHitColoringParams:

Public Member Functions

 SHitColoringParams ()
 
void SetValueRange (double min, double max)
 
double GetColorNorm (double value, bool precise=true) const
 
double GetMin (bool precise=true) const
 
double GetMax (bool precise=true) const
 
double GetPrecision () const
 
void SetPrecision (double prec)
 
const char * GetPrecisionFormat () const
 
- 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 Attributes

string m_ScoreName
 
double m_MinValue
 
double m_MaxValue
 
bool m_EnableMinGrad
 
bool m_EnableMaxGrad
 
double m_MinGrad
 
double m_MaxGrad
 
double m_Precision
 
char m_PreFormat [32]
 
CRgbaColor m_MinColor
 
CRgbaColor m_MaxColor
 
bool m_LogScale
 
int m_Steps
 

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

Detailed Description

Definition at line 43 of file hit_coloring.hpp.

Constructor & Destructor Documentation

◆ SHitColoringParams()

SHitColoringParams::SHitColoringParams ( )

Definition at line 40 of file hit_coloring.cpp.

References SetPrecision().

Member Function Documentation

◆ GetColorNorm()

double SHitColoringParams::GetColorNorm ( double  value,
bool  precise = true 
) const

◆ GetMax()

double SHitColoringParams::GetMax ( bool  precise = true) const

Definition at line 84 of file hit_coloring.cpp.

References Blur(), m_EnableMaxGrad, m_MaxGrad, m_MaxValue, and m_Precision.

Referenced by CHitMatrixGraph::AssignColorsByScore().

◆ GetMin()

double SHitColoringParams::GetMin ( bool  precise = true) const

Definition at line 74 of file hit_coloring.cpp.

References Blur(), m_EnableMinGrad, m_MinGrad, m_MinValue, and m_Precision.

Referenced by CHitMatrixGraph::AssignColorsByScore().

◆ GetPrecision()

double SHitColoringParams::GetPrecision ( ) const
inline

Definition at line 68 of file hit_coloring.hpp.

References m_Precision.

◆ GetPrecisionFormat()

const char* SHitColoringParams::GetPrecisionFormat ( ) const
inline

Definition at line 71 of file hit_coloring.hpp.

References m_PreFormat.

Referenced by CwxScoreDlg::TransferDataToWindow(), and CGradientPanel::x_DrawNumber().

◆ SetPrecision()

void SHitColoringParams::SetPrecision ( double  prec)

Definition at line 131 of file hit_coloring.cpp.

References int, log10(), m_Precision, and m_PreFormat.

Referenced by SHitColoringParams().

◆ SetValueRange()

void SHitColoringParams::SetValueRange ( double  min,
double  max 
)

Definition at line 56 of file hit_coloring.cpp.

References _ASSERT, m_MaxValue, m_MinValue, max(), and min().

Referenced by CHitMatrixWidget::OnColorByScore().

Member Data Documentation

◆ m_EnableMaxGrad

bool SHitColoringParams::m_EnableMaxGrad

◆ m_EnableMinGrad

bool SHitColoringParams::m_EnableMinGrad

◆ m_LogScale

bool SHitColoringParams::m_LogScale

Definition at line 57 of file hit_coloring.hpp.

Referenced by CwxScoreDlg::CreateControls(), and GetColorNorm().

◆ m_MaxColor

CRgbaColor SHitColoringParams::m_MaxColor

◆ m_MaxGrad

double SHitColoringParams::m_MaxGrad

◆ m_MaxValue

double SHitColoringParams::m_MaxValue

◆ m_MinColor

CRgbaColor SHitColoringParams::m_MinColor

◆ m_MinGrad

double SHitColoringParams::m_MinGrad

◆ m_MinValue

double SHitColoringParams::m_MinValue

◆ m_Precision

double SHitColoringParams::m_Precision

Definition at line 53 of file hit_coloring.hpp.

Referenced by GetColorNorm(), GetMax(), GetMin(), GetPrecision(), and SetPrecision().

◆ m_PreFormat

char SHitColoringParams::m_PreFormat[32]

Definition at line 54 of file hit_coloring.hpp.

Referenced by GetPrecisionFormat(), and SetPrecision().

◆ m_ScoreName

string SHitColoringParams::m_ScoreName

◆ m_Steps

int SHitColoringParams::m_Steps

The documentation for this struct was generated from the following files:
Modified on Sat Dec 02 09:22:22 2023 by modify_doxy.py rev. 669887