Search Toolkit Book for CFeatureTrackFactory

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

Inheritance diagram for CFeatureTrackFactory:

Collaboration diagram for CFeatureTrackFactory:

Public Member Functions
	CFeatureTrackFactory ()

virtual TTrackMap	CreateTracks (SConstScopedObject &object, ISGDataSourceContext ds_context, CRenderingContext r_cntx, const SExtraParams &params=SExtraParams(), const TAnnotMetaDataList &src_annots=TAnnotMetaDataList()) const
	create a layout track based on the input objects and extra parameters. More...

virtual void	GetMatchedAnnots (const TAnnotMetaDataList &src_annots, const ILayoutTrackFactory::SExtraParams &params, TAnnotNameTitleMap &out_annots) const

virtual void	CloneTrack (const CLayoutTrack track, CTempTrackProxy track_proxy) const
	duplicate any track setting from a given track instance to a proxy. More...

virtual bool	UnderstandLevel () const
	Have any concept of level. More...

virtual bool	SupportsExportToAsn1 () const

virtual bool	NeedBackgroundInit () const
	Background track initialization. More...

virtual const CTrackTypeInfo &	GetThisTypeInfo () const

ITrackConfigurable interface implementation
virtual CRef< objects::CTrackConfigSet >	GetSettings (const string &profile, const TKeyValuePairs &settings, const CTempTrackProxy *track_proxy) const

IExtension interface implementation
virtual string	GetExtensionIdentifier () const
	returns the unique human-readable identifier for the extension the id should use lowercase letters separated by underscores - "like_this" More...

virtual string	GetExtensionLabel () const
	returns a displayable label for this extension ( please capitalize the key words - "My Extension" ) 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 ILayoutTrackFactory
virtual	~ILayoutTrackFactory ()

Public Member Functions inherited from ITrackConfigurable
virtual	~ITrackConfigurable ()

Public Member Functions inherited from IExtension
virtual	~IExtension ()

Static Public Member Functions
static const CTrackTypeInfo &	GetTypeInfo ()

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 Member Functions inherited from ILayoutTrackFactory
static void	GetMatchedAnnots (const TAnnotMetaDataList &src_annots, const vector< string > &target_annots, const string &annot_type, const string &track_type, TAnnotNameTitleMap &out_annots)
	Help function to find matched annotations. More...

static string	MergeAnnotAndFilter (const string &annot, const string &filter)
	create a new name based on annotation name and fitler string. More...

static string	ExtractAnnotName (const string &source)
	extract anntation name from a source string. More...

static string	ExtractFilterName (const string &source)
	extract filter name from a source string. More...

Protected Member Functions
CRef< objects::CTrackConfig >	x_GetSettings (const TKeyValuePairs &settings, const CTempTrackProxy *track_proxy, bool is_intron_track) const

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

Protected Attributes
CFeatureTrack::ELayout	m_DefaultLayout

ELinkedFeatDisplay	m_DefaultLinkedFeat

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

Public Types inherited from ILayoutTrackFactory
typedef map< string, CRef< CLayoutTrack > >	TTrackMap
	the tracks holding a list of annotation name and track pair. More...

typedef map< string, string >	TAnnotNameTitleMap
	List of annotations with the corresponding titles. More...

typedef map< string, CRef< CAnnotMetaData > >	TAnnotMetaDataList

Public Types inherited from ITrackConfigurable
typedef map< string, string >	TKeyValuePairs

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

CFeatureTrackFactory.

Definition at line 248 of file feature_track.hpp.

Constructor & Destructor Documentation

◆ CFeatureTrackFactory()

CFeatureTrackFactory::CFeatureTrackFactory ( )

inline

Definition at line 255 of file feature_track.hpp.

Member Function Documentation

◆ CloneTrack()

void CFeatureTrackFactory::CloneTrack	(	const CLayoutTrack *	,
		CTempTrackProxy *
	)		const

virtual

duplicate any track setting from a given track instance to a proxy.

by default, it does nothing.

Reimplemented from ILayoutTrackFactory.

Definition at line 1200 of file feature_track.cpp.

References GetExtensionIdentifier(), CSeqFeatData::GetFeatList(), CFeatureTrack::GetFeatSubtype(), CFeatList::GetStoragekey(), CTempTrackProxy::SetKey(), and CTempTrackProxy::SetSubkey().

◆ CreateTracks()

ILayoutTrackFactory::TTrackMap CFeatureTrackFactory::CreateTracks	(	SConstScopedObject &	object,
		ISGDataSourceContext *	ds_context,
		CRenderingContext *	r_cntx,
		const SExtraParams &	params = `SExtraParams()`,
		const TAnnotMetaDataList &	src_annots = `TAnnotMetaDataList()`
	)		const

virtual

create a layout track based on the input objects and extra parameters.

CFeatureTrackFactory.

Implements ILayoutTrackFactory.

Reimplemented in CVcfTrackFactory, CVarTrackFactory, and CAggregateFeatureTrackFactory.

Definition at line 1109 of file feature_track.cpp.

Referenced by CGeneModelFactory::CreateTracks().

◆ GetExtensionIdentifier()

string CFeatureTrackFactory::GetExtensionIdentifier ( ) const

virtual

returns the unique human-readable identifier for the extension the id should use lowercase letters separated by underscores - "like_this"

Implements IExtension.

Reimplemented in CVcfTrackFactory, CVarTrackFactory, and CAggregateFeatureTrackFactory.

Definition at line 1213 of file feature_track.cpp.

References CTrackTypeInfo::GetId(), and CFeatureTrack::m_TypeInfo.

Referenced by CloneTrack().

◆ GetExtensionLabel()

string CFeatureTrackFactory::GetExtensionLabel ( ) const

virtual

returns a displayable label for this extension ( please capitalize the key words - "My Extension" )

Implements IExtension.

Reimplemented in CVcfTrackFactory, CVarTrackFactory, and CAggregateFeatureTrackFactory.

Definition at line 1219 of file feature_track.cpp.

References CTrackTypeInfo::GetDescr(), and CFeatureTrack::m_TypeInfo.

◆ GetMatchedAnnots()

void CFeatureTrackFactory::GetMatchedAnnots	(	const TAnnotMetaDataList &	src_annots,
		const ILayoutTrackFactory::SExtraParams &	params,
		TAnnotNameTitleMap &	out_annots
	)		const

virtual

Reimplemented from ILayoutTrackFactory.

Reimplemented in CVcfTrackFactory, CVarTrackFactory, and CAggregateFeatureTrackFactory.

Definition at line 1192 of file feature_track.cpp.

References ILayoutTrackFactory::GetMatchedAnnots(), ILayoutTrackFactory::SExtraParams::m_Annots, and ILayoutTrackFactory::SExtraParams::m_Subkey.

Referenced by CreateTracks().

◆ GetSettings()

CRef< CTrackConfigSet > CFeatureTrackFactory::GetSettings	(	const string &	profile,
		const TKeyValuePairs &	settings,
		const CTempTrackProxy *	track_proxy
	)		const

virtual

Implements ITrackConfigurable.

Reimplemented in CVcfTrackFactory, CVarTrackFactory, and CAggregateFeatureTrackFactory.

Definition at line 1226 of file feature_track.cpp.

References CSeqFeatData::eSubtype_intron, CSeqFeatData::GetFeatList(), CFeatList::GetItemByKey(), CTempTrackProxy::GetSubkey(), CFeatListItem::GetSubtype(), CTrackConfigSet_Base::Set(), ncbi::grid::netcache::search::fields::subkey, and x_GetSettings().

Referenced by CAllOtherFeaturesTrackFactory::GetSettings().

◆ GetThisTypeInfo()

virtual const CTrackTypeInfo& CFeatureTrackFactory::GetThisTypeInfo ( ) const

inlinevirtual

Implements ILayoutTrackFactory.

Reimplemented in CVcfTrackFactory, CVarTrackFactory, and CAggregateFeatureTrackFactory.

Definition at line 288 of file feature_track.hpp.

References GetTypeInfo().

Referenced by x_GetSettings().

◆ GetTypeInfo()

static const CTrackTypeInfo& CFeatureTrackFactory::GetTypeInfo ( void )

inlinestatic

Definition at line 291 of file feature_track.hpp.

References CFeatureTrack::m_TypeInfo.

Referenced by CTrackConfigManager::CreateTrackConfig(), CAllOtherFeaturesTrackFactory::GetSettings(), GetThisTypeInfo(), CTrackConfigManager::GetUsedFeatureKeys(), CSeqGraphicWidget::OnAddTrack(), CwxTrackSettingsDlg::OnTrackTypeChanged(), CAllOtherFeaturesTrack::ReinitNASubtracks(), and CAllOtherFeaturesTrack::x_ReinitSubtracks().

◆ NeedBackgroundInit()

virtual bool CFeatureTrackFactory::NeedBackgroundInit ( ) const

inlinevirtual

Background track initialization.

Since some of track initializations will be time consumming, but others are not, we need to know if there is a need to do background track initialization.

Implements ILayoutTrackFactory.

Definition at line 285 of file feature_track.hpp.

◆ SupportsExportToAsn1()

virtual bool CFeatureTrackFactory::SupportsExportToAsn1 ( ) const

inlinevirtual

Reimplemented from ILayoutTrackFactory.

Definition at line 283 of file feature_track.hpp.

◆ UnderstandLevel()

virtual bool CFeatureTrackFactory::UnderstandLevel ( ) const

inlinevirtual

Have any concept of level.

Feature retrieving level (adaptive or exact level) for annotation selector.

Implements ILayoutTrackFactory.

Definition at line 275 of file feature_track.hpp.

◆ x_GetSettings()

CRef< CTrackConfig > CFeatureTrackFactory::x_GetSettings	(	const TKeyValuePairs &	settings,
		const CTempTrackProxy *	track_proxy,
		bool	is_intron_track
	)		const

protected

Definition at line 1249 of file feature_track.cpp.

References CTrackConfigUtils::CreateCheckBox(), CTrackConfigUtils::CreateChoice(), CTrackConfigUtils::CreateChoiceItem(), CTrackConfigUtils::CreateHiddenSetting(), CTrackConfigUtils::CreateRangeControl(), CTrackConfigUtils::DecodeValueRange(), CFeatureTrack::eLayout_AdaptiveLayered, CFeatureTrack::eLayout_ExpandedLayered, CFeatureTrack::eLayout_Packed, eLFD_Default, eLFD_Hidden, eLFD_Packed, eLFD_PackedWithParent, eLFD_ParentHidden, NStr::EqualNocase(), CTrackProxy::GetDB(), CTrackTypeInfo::GetDescr(), CException::GetMsg(), CTempTrackProxy::GetSortBy(), CCloneConcordancySorter::GetSorterDescr(), CGRCStatusSorter::GetSorterDescr(), GetThisTypeInfo(), CSeqUtils::isRmtPipelineFileType(), ITERATE, CFeatureTrack::LayoutStrToValue(), CFeatureTrack::LayoutValueToStr(), CFeatureTrack::LinkedFeatDisplayStrToValue(), CFeatureTrack::LinkedFeatDisplayValueToStr(), LOG_POST, m_DefaultLayout, m_DefaultLinkedFeat, IObjectSorter::SSorterDescriptor::m_Descr, IObjectSorter::SSorterDescriptor::m_DisplayName, IObjectSorter::SSorterDescriptor::m_Name, NStr::StringToBool(), and Warning().

Referenced by CAggregateFeatureTrackFactory::GetSettings(), and GetSettings().

Member Data Documentation

◆ m_DefaultLayout

CFeatureTrack::ELayout CFeatureTrackFactory::m_DefaultLayout

protected

Definition at line 310 of file feature_track.hpp.

Referenced by CAggregateFeatureTrackFactory::CAggregateFeatureTrackFactory(), and x_GetSettings().

◆ m_DefaultLinkedFeat

ELinkedFeatDisplay CFeatureTrackFactory::m_DefaultLinkedFeat

protected

Definition at line 311 of file feature_track.hpp.

Referenced by CAggregateFeatureTrackFactory::CAggregateFeatureTrackFactory(), and x_GetSettings().

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

include/gui/widgets/seq_graphic/feature_track.hpp
src/gui/widgets/seq_graphic/feature_track.cpp

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ CFeatureTrackFactory()

Member Function Documentation

◆ CloneTrack()

◆ CreateTracks()

◆ GetExtensionIdentifier()

◆ GetExtensionLabel()

◆ GetMatchedAnnots()

◆ GetSettings()

◆ GetThisTypeInfo()

◆ GetTypeInfo()

◆ NeedBackgroundInit()

◆ SupportsExportToAsn1()

◆ UnderstandLevel()

◆ x_GetSettings()

Member Data Documentation

◆ m_DefaultLayout

◆ m_DefaultLinkedFeat