NCBI C++ ToolKit
Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | Private Attributes | List of all members
CHistParams Class Reference

Search Toolkit Book for CHistParams

File Description: More...

#include <gui/widgets/seq_graphic/histogram_conf.hpp>

+ Inheritance diagram for CHistParams:
+ Collaboration diagram for CHistParams:

Public Types

enum  EType {
  eSmearBar , eHistogram , eMergedBar , eLineGraph ,
  eDefaultType = eHistogram
}
 
enum  EScale { eLinear , eLog10 , eLog2 , eLoge }
 
typedef map< string, CRgbaColorTColorSet
 
- 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 Member Functions

 CHistParams ()
 
void SetDirty (bool f)
 
bool GetDirty () 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
 

Static Public Member Functions

static EType TypeStrToValue (const string &type)
 
static const stringTypeValueToStr (CHistParams::EType type)
 
static EScale ScaleStrToValue (const string &scale)
 
static const stringScaleValueToStr (CHistParams::EScale scale)
 
static const stringScaleValueToName (CHistParams::EScale scale)
 
static string ScaleTMSToStr (const string &sScaleTMS)
 converts values returned in TMS "stored_scale" attribute (e.g. More...
 
static CRef< objects::CChoice > CreateScaleOptions (const string &option_name, CHistParams::EScale option_value)
 
- 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)
 

Public Attributes

EType m_Type = eHistogram
 
EScale m_Scale = eLinear
 requested scale More...
 
EScale m_StoredScale = eLinear
 stored scale of the underlying data (e.g. as reported by TMS) More...
 
bool m_NeedRuler = false
 
bool m_NeedRulerLabels = true
 
bool m_DrawBg = false
 
bool m_ClipOutliers = false
 
int m_SDeviationThreshold = 5
 
int m_NumBins = 0
 
bool m_RangeAutoscale = true
 
bool m_SmoothCurve = false
 
int m_FitStep = 4
 
CRange< float > m_ValueRange
 
Colors.
CRgbaColor m_fgColor
 
CRgbaColor m_fgNegColor
 
CRgbaColor m_bgColor
 
CRgbaColor m_LabelColor
 
CRgbaColor m_SmearColorMin
 
CRgbaColor m_SmearColorMax
 
CRgbaColor m_RulerColor
 
CRgbaColor m_OutlierColor {"red"}
 
TColorSet m_Colors
 
Sizes.
TModelUnit m_Height = 10
 

Private Attributes

bool m_Dirty = false
 

Additional Inherited Members

- 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

File Description:

CHistParams: the data structure holding feature rendering parameters.

Definition at line 49 of file histogram_conf.hpp.

Member Typedef Documentation

◆ TColorSet

Definition at line 52 of file histogram_conf.hpp.

Member Enumeration Documentation

◆ EScale

Enumerator
eLinear 
eLog10 
eLog2 
eLoge 

Definition at line 62 of file histogram_conf.hpp.

◆ EType

Enumerator
eSmearBar 
eHistogram 
eMergedBar 
eLineGraph 
eDefaultType 

Definition at line 54 of file histogram_conf.hpp.

Constructor & Destructor Documentation

◆ CHistParams()

CHistParams::CHistParams ( )
inline

Definition at line 71 of file histogram_conf.hpp.

Member Function Documentation

◆ CreateScaleOptions()

CRef< CChoice > CHistParams::CreateScaleOptions ( const string option_name,
CHistParams::EScale  option_value 
)
static

◆ GetDirty()

bool CHistParams::GetDirty ( ) const
inline

Definition at line 98 of file histogram_conf.hpp.

References m_Dirty.

Referenced by CHistParamsManager::SaveSettings().

◆ ScaleStrToValue()

CHistParams::EScale CHistParams::ScaleStrToValue ( const string scale)
static

◆ ScaleTMSToStr()

string CHistParams::ScaleTMSToStr ( const string sScaleTMS)
static

converts values returned in TMS "stored_scale" attribute (e.g.

"log2 scaled") to values understood by ScaleStrToValue() and JS code (e.g. "log2")

Definition at line 132 of file histogram_conf.cpp.

◆ ScaleValueToName()

const string & CHistParams::ScaleValueToName ( CHistParams::EScale  scale)
static

Definition at line 122 of file histogram_conf.cpp.

References kEmptyStr, and sm_ScaleNames.

Referenced by CreateScaleOptions(), s_GetLabel(), and CHistogramGlyph::x_GetLabel().

◆ ScaleValueToStr()

const string & CHistParams::ScaleValueToStr ( CHistParams::EScale  scale)
static

◆ SetDirty()

void CHistParams::SetDirty ( bool  f)
inline

Definition at line 97 of file histogram_conf.hpp.

References f(), and m_Dirty.

Referenced by CHistParamsManager::AddSettings().

◆ TypeStrToValue()

CHistParams::EType CHistParams::TypeStrToValue ( const string type)
static

◆ TypeValueToStr()

const string & CHistParams::TypeValueToStr ( CHistParams::EType  type)
static

Member Data Documentation

◆ m_bgColor

CRgbaColor CHistParams::m_bgColor

◆ m_ClipOutliers

bool CHistParams::m_ClipOutliers = false

◆ m_Colors

TColorSet CHistParams::m_Colors

◆ m_Dirty

bool CHistParams::m_Dirty = false
mutableprivate

Definition at line 137 of file histogram_conf.hpp.

Referenced by GetDirty(), and SetDirty().

◆ m_DrawBg

bool CHistParams::m_DrawBg = false

◆ m_fgColor

CRgbaColor CHistParams::m_fgColor

◆ m_fgNegColor

CRgbaColor CHistParams::m_fgNegColor

◆ m_FitStep

int CHistParams::m_FitStep = 4

◆ m_Height

TModelUnit CHistParams::m_Height = 10

◆ m_LabelColor

CRgbaColor CHistParams::m_LabelColor

◆ m_NeedRuler

bool CHistParams::m_NeedRuler = false

◆ m_NeedRulerLabels

bool CHistParams::m_NeedRulerLabels = true

◆ m_NumBins

int CHistParams::m_NumBins = 0

◆ m_OutlierColor

CRgbaColor CHistParams::m_OutlierColor {"red"}

◆ m_RangeAutoscale

bool CHistParams::m_RangeAutoscale = true

◆ m_RulerColor

CRgbaColor CHistParams::m_RulerColor

◆ m_Scale

EScale CHistParams::m_Scale = eLinear

◆ m_SDeviationThreshold

int CHistParams::m_SDeviationThreshold = 5

◆ m_SmearColorMax

CRgbaColor CHistParams::m_SmearColorMax

◆ m_SmearColorMin

CRgbaColor CHistParams::m_SmearColorMin

◆ m_SmoothCurve

bool CHistParams::m_SmoothCurve = false

◆ m_StoredScale

EScale CHistParams::m_StoredScale = eLinear

stored scale of the underlying data (e.g. as reported by TMS)

Definition at line 124 of file histogram_conf.hpp.

Referenced by CHistogramGlyph::SetAxisRange(), CGraphOverlay::x_LoadSettings(), CGraphTrack::x_LoadSettings(), CHistogramGlyph::x_MapValue(), and CGraphOverlay::x_SaveSettings().

◆ m_Type

EType CHistParams::m_Type = eHistogram

◆ m_ValueRange

CRange<float> CHistParams::m_ValueRange

The documentation for this class was generated from the following files:
Modified on Fri May 24 14:53:48 2024 by modify_doxy.py rev. 669887