Search Toolkit Book for CAlignSorterByField

CAlignSorterByField is a sorter used to sort alignments based on user fields. More...

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

Inheritance diagram for CAlignSorterByField< T >:

Collaboration diagram for CAlignSorterByField< T >:

Public Member Functions
	CAlignSorterByField (std::string const &field, std::string const &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...

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 IObjectSorter
virtual	~IObjectSorter ()

Public Attributes
const int	NotSet = 0xffff

Protected Member Functions
bool	x_HasData (objects::CUser_object const &objects) const

T	x_GetData (objects::CUser_object const &objects) const

bool	x_HasData (objects::CUser_object const &objects) const

bool	x_HasData (objects::CUser_object const &objects) const

bool	x_HasData (objects::CUser_object const &objects) const

std::string	x_GetData (objects::CUser_object const &objects) const

int	x_GetData (objects::CUser_object const &objects) const

bool	x_GetData (objects::CUser_object const &objects) const

Protected Member Functions inherited from CObject
virtual void	DeleteThis (void)
	Virtual method "deleting" this object. More...

Private Attributes
std::map< T, int >	m_SortGroups
	Curently intended sorting groups. More...

const std::string	m_Field

const std::string	m_Id

const std::string	m_GroupName

const std::string	m_Description

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

Detailed Description

template<typename T>
class CAlignSorterByField< T >

CAlignSorterByField is a sorter used to sort alignments based on user fields.

Definition at line 50 of file alignment_sorter_by_field.hpp.

Constructor & Destructor Documentation

◆ CAlignSorterByField()

template<typename T >

CAlignSorterByField< T >::CAlignSorterByField	(	std::string const &	field,
		std::string const &	id,
		const std::string &	group_name,
		std::string const &	description
	)