Search Toolkit Book for CTMgr_LengthStats

#include <objects/trackmgr/TMgr_LengthStats.hpp>

Inheritance diagram for CTMgr_LengthStats:

Collaboration diagram for CTMgr_LengthStats:

Public Member Functions
	CTMgr_LengthStats (void)

	~CTMgr_LengthStats (void)

void	Add (TSeqPos length, Uint8 prior_count=0)

Public Member Functions inherited from CTMgr_LengthStats_Base
	CTMgr_LengthStats_Base (void)

virtual	~CTMgr_LengthStats_Base (void)

	DECLARE_INTERNAL_TYPE_INFO ()

bool	IsSetMin (void) const
	Check if a value has been assigned to Min data member. More...

bool	CanGetMin (void) const
	Check if it is safe to call GetMin method. More...

void	ResetMin (void)
	Reset Min data member. More...

TMin	GetMin (void) const
	Get the Min member data. More...

void	SetMin (TMin value)
	Assign a value to Min data member. More...

TMin &	SetMin (void)
	Assign a value to Min data member. More...

bool	IsSetMax (void) const
	Check if a value has been assigned to Max data member. More...

bool	CanGetMax (void) const
	Check if it is safe to call GetMax method. More...

void	ResetMax (void)
	Reset Max data member. More...

TMax	GetMax (void) const
	Get the Max member data. More...

void	SetMax (TMax value)
	Assign a value to Max data member. More...

TMax &	SetMax (void)
	Assign a value to Max data member. More...

bool	IsSetMean (void) const
	Check if a value has been assigned to Mean data member. More...

bool	CanGetMean (void) const
	Check if it is safe to call GetMean method. More...

void	ResetMean (void)
	Reset Mean data member. More...

TMean	GetMean (void) const
	Get the Mean member data. More...

void	SetMean (TMean value)
	Assign a value to Mean data member. More...

TMean &	SetMean (void)
	Assign a value to Mean data member. More...

virtual void	Reset (void)
	Reset the whole object. More...

Public Member Functions inherited from CSerialObject
	CSerialObject (void)

virtual	~CSerialObject (void)

virtual const CTypeInfo *	GetThisTypeInfo (void) const =0

virtual void	Assign (const CSerialObject &source, ESerialRecursionMode how=eRecursive)
	Set object to copy of another one. More...

virtual bool	Equals (const CSerialObject &object, ESerialRecursionMode how=eRecursive) const
	Check if both objects contain the same values. More...

virtual void	DebugDump (CDebugDumpContext ddc, unsigned int depth) const
	Define method for dumping debug information. More...

void	ThrowUnassigned (TMemberIndex index) const

void	ThrowUnassigned (TMemberIndex index, const char *file_name, int file_line) const

bool	HasNamespaceName (void) const
	Check if object data type has namespace name. More...

const string &	GetNamespaceName (void) const
	Get namespace name. More...

bool	HasNamespacePrefix (void) const
	Check if data type has namespace prefix. More...

const string &	GetNamespacePrefix (void) const
	Get namespace prefix. More...

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

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

Private Types
typedef CTMgr_LengthStats_Base	Tparent

Private Member Functions
	CTMgr_LengthStats (const CTMgr_LengthStats &value)

CTMgr_LengthStats &	operator= (const CTMgr_LengthStats &value)

Additional Inherited Members
Public Types inherited from CTMgr_LengthStats_Base
enum class	E_memberIndex { e__allMandatory = 0 , e_min , e_max , e_mean }

typedef TSeqPos	TMin

typedef TSeqPos	TMax

typedef TSeqPos	TMean

typedef Tparent::CMemberIndex< E_memberIndex, 4 >	TmemberIndex

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

Static Public Member Functions inherited from CSerialObject
static void	SetVerifyDataThread (ESerialVerifyData verify)

static void	SetVerifyDataGlobal (ESerialVerifyData verify)

static string	UnassignedString (void)

static CStringUTF8	UnassignedStringUTF8 (void)

static char	UnassignedByte (void)

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 CSerialObject
static const char *	ms_UnassignedStr = "<unassigned>"

static const char	ms_UnassignedByte = char(0xcd)

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 49 of file TMgr_LengthStats.hpp.

Member Typedef Documentation

◆ Tparent

typedef CTMgr_LengthStats_Base CTMgr_LengthStats::Tparent

private

Definition at line 51 of file TMgr_LengthStats.hpp.

Constructor & Destructor Documentation

◆ CTMgr_LengthStats() [1/2]

CTMgr_LengthStats::CTMgr_LengthStats ( void )

Definition at line 46 of file TMgr_LengthStats.cpp.

◆ ~CTMgr_LengthStats()

CTMgr_LengthStats::~CTMgr_LengthStats ( void )

Definition at line 50 of file TMgr_LengthStats.cpp.

◆ CTMgr_LengthStats() [2/2]

CTMgr_LengthStats::CTMgr_LengthStats ( const CTMgr_LengthStats & value )

private

Member Function Documentation

◆ Add()

void CTMgr_LengthStats::Add	(	TSeqPos	length,
		Uint8	prior_count = `0`
	)

Definition at line 55 of file TMgr_LengthStats.cpp.

References CTMgr_LengthStats_Base::GetMax(), CTMgr_LengthStats_Base::GetMean(), CTMgr_LengthStats_Base::GetMin(), max(), min(), CTMgr_LengthStats_Base::SetMax(), CTMgr_LengthStats_Base::SetMean(), and CTMgr_LengthStats_Base::SetMin().

◆ operator=()

CTMgr_LengthStats& CTMgr_LengthStats::operator= ( const CTMgr_LengthStats & value )

private

The documentation for this class was generated from the following files:

include/objects/trackmgr/TMgr_LengthStats.hpp
src/objects/trackmgr/TMgr_LengthStats.cpp

Public Member Functions

Private Types

Private Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Tparent

Constructor & Destructor Documentation

◆ CTMgr_LengthStats() [1/2]

◆ ~CTMgr_LengthStats()

◆ CTMgr_LengthStats() [2/2]

Member Function Documentation

◆ Add()

◆ operator=()