NCBI C++ ToolKit
Public Types | Public Member Functions | Public Attributes | Private Attributes | List of all members
CAlignSorterByScore< T > Class Template Reference

Search Toolkit Book for CAlignSorterByScore

CAlignSorterByScore is a sorter used to sort alignments by scores. More...

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

+ Inheritance diagram for CAlignSorterByScore< T >:
+ Collaboration diagram for CAlignSorterByScore< T >:

Public Types

using TScoreMapper = std::function< string(const T &)>
 
- 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

 CAlignSorterByScore (std::string const &score_name, std::string const &score_id, const std::string &group_name, std::string const &description)
 
virtual std::string GroupIdxToName (int idx) const
 Convert group index into group name. More...
 
virtual int GetGroupIdx (const objects::CSeq_align &align) const
 Get the sorted group index for a given feature. More...
 
virtual SSorterDescriptor GetThisDescr () const
 Return a name for the sorter. More...
 
void SetMapper (TScoreMapper &score_mapper)
 
- 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 IObjectSorter
virtual ~IObjectSorter ()
 

Public Attributes

const int NotSet = 0xffff
 

Private Attributes

std::map< string, intm_SortGroups
 Curently intended sorting groups. More...
 
const std::string m_ScoreName
 
const std::string m_ScoreId
 
const std::string m_GroupName
 
const std::string m_Description
 
TScoreMapper m_ScoreMapper
 

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

template<typename T>
class CAlignSorterByScore< T >

CAlignSorterByScore is a sorter used to sort alignments by scores.

Definition at line 47 of file alignment_sorter_by_score.hpp.

Member Typedef Documentation

◆ TScoreMapper

template<typename T >
using CAlignSorterByScore< T >::TScoreMapper = std::function<string(const T&)>

Definition at line 53 of file alignment_sorter_by_score.hpp.

Constructor & Destructor Documentation

◆ CAlignSorterByScore()

template<typename T >
CAlignSorterByScore< T >::CAlignSorterByScore ( std::string const score_name,
std::string const score_id,
const std::string group_name,
std::string const description 
)
inline

Definition at line 55 of file alignment_sorter_by_score.hpp.

Member Function Documentation

◆ GetGroupIdx()

template<typename T >
virtual int CAlignSorterByScore< T >::GetGroupIdx ( const objects::CSeq_align &  align) const
inlinevirtual

Get the sorted group index for a given feature.

@ret any index >=0 will be considered as a valid index. Otherwise, it is an invalid index.

Implements IAlignSorter.

Definition at line 83 of file alignment_sorter_by_score.hpp.

References int, CAlignSorterByScore< T >::m_ScoreMapper, CAlignSorterByScore< T >::m_ScoreName, CAlignSorterByScore< T >::m_SortGroups, CAlignSorterByScore< T >::NotSet, and T.

◆ GetThisDescr()

template<typename T >
virtual SSorterDescriptor CAlignSorterByScore< T >::GetThisDescr ( ) const
inlinevirtual

◆ GroupIdxToName()

template<typename T >
virtual std::string CAlignSorterByScore< T >::GroupIdxToName ( int  idx) const
inlinevirtual

◆ SetMapper()

template<typename T >
void CAlignSorterByScore< T >::SetMapper ( TScoreMapper score_mapper)
inline

Member Data Documentation

◆ m_Description

template<typename T >
const std::string CAlignSorterByScore< T >::m_Description
private

◆ m_GroupName

template<typename T >
const std::string CAlignSorterByScore< T >::m_GroupName
private

◆ m_ScoreId

template<typename T >
const std::string CAlignSorterByScore< T >::m_ScoreId
private

◆ m_ScoreMapper

template<typename T >
TScoreMapper CAlignSorterByScore< T >::m_ScoreMapper
private

◆ m_ScoreName

template<typename T >
const std::string CAlignSorterByScore< T >::m_ScoreName
private

◆ m_SortGroups

template<typename T >
std::map<string, int> CAlignSorterByScore< T >::m_SortGroups
mutableprivate

Curently intended sorting groups.

Any feature that doesn't have the field set will be assigned to an invalid group index

Definition at line 114 of file alignment_sorter_by_score.hpp.

Referenced by CAlignSorterByScore< T >::GetGroupIdx(), and CAlignSorterByScore< T >::GroupIdxToName().

◆ NotSet

template<typename T >
const int CAlignSorterByScore< T >::NotSet = 0xffff

The documentation for this class was generated from the following file:
Modified on Fri Sep 20 14:58:01 2024 by modify_doxy.py rev. 669887