NCBI C++ ToolKit
Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
CSegmentMapTrackFactory Class Reference

Search Toolkit Book for CSegmentMapTrackFactory

CSegmentMapTrackFactory. More...

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

+ Inheritance diagram for CSegmentMapTrackFactory:
+ Collaboration diagram for CSegmentMapTrackFactory:

Public Member Functions

 CSegmentMapTrackFactory ()
 
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 bool UnderstandLevel () const
 Have any concept of level. More...
 
virtual bool NeedBackgroundInit () const
 Background track initialization. More...
 
virtual const CTrackTypeInfoGetThisTypeInfo () 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...
 
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 ILayoutTrackFactory
virtual void GetMatchedAnnots (const TAnnotMetaDataList &, const ILayoutTrackFactory::SExtraParams &, TAnnotNameTitleMap &) const
 
virtual void CloneTrack (const CLayoutTrack *, CTempTrackProxy *) const
 duplicate any track setting from a given track instance to a proxy. More...
 
virtual ~ILayoutTrackFactory ()
 
- Public Member Functions inherited from ITrackConfigurable
virtual ~ITrackConfigurable ()
 
- Public Member Functions inherited from IExtension
virtual ~IExtension ()
 

Static Public Member Functions

static const CTrackTypeInfoGetTypeInfo ()
 
- Static Public Member Functions inherited from CObject
static NCBI_NORETURN void ThrowNullPointerException (void)
 Define method to throw null pointer exception. More...
 
static NCBI_NORETURN 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

bool x_IsChromosome (CSGSegmentMapDS &ds) const
 
- Protected Member Functions inherited from CObject
virtual void DeleteThis (void)
 Virtual method "deleting" this object. More...
 

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 CAtomicCounter TCounter
 Counter type is CAtomiCounter. More...
 
typedef TCounter::TValue 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, stringTAnnotNameTitleMap
 List of annotations with the corresponding titles. More...
 
typedef map< string, CRef< CAnnotMetaData > > TAnnotMetaDataList
 
- Public Types inherited from ITrackConfigurable
typedef map< string, stringTKeyValuePairs
 
- 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

CSegmentMapTrackFactory.

Definition at line 133 of file segment_map_track.hpp.

Constructor & Destructor Documentation

CSegmentMapTrackFactory::CSegmentMapTrackFactory ( )
inline

Definition at line 140 of file segment_map_track.hpp.

Member Function Documentation

ILayoutTrackFactory::TTrackMap CSegmentMapTrackFactory::CreateTracks ( SConstScopedObject object,
ISGDataSourceContext ds_context,
CRenderingContext r_cntx,
const SExtraParams params = SExtraParams(),
const TAnnotMetaDataList src_annots = TAnnotMetaDataList() 
) const
virtual
string CSegmentMapTrackFactory::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 CComponentTrackFactory, and CScaffoldTrackFactory.

Definition at line 537 of file segment_map_track.cpp.

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

string CSegmentMapTrackFactory::GetExtensionLabel ( ) const
virtual

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

Implements IExtension.

Reimplemented in CComponentTrackFactory, and CScaffoldTrackFactory.

Definition at line 543 of file segment_map_track.cpp.

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

CRef< CTrackConfigSet > CSegmentMapTrackFactory::GetSettings ( const string profile,
const TKeyValuePairs settings,
const CTempTrackProxy track_proxy 
) const
virtual
virtual const CTrackTypeInfo& CSegmentMapTrackFactory::GetThisTypeInfo ( ) const
inlinevirtual

Implements ILayoutTrackFactory.

Reimplemented in CComponentTrackFactory, and CScaffoldTrackFactory.

Definition at line 156 of file segment_map_track.hpp.

References GetTypeInfo().

static const CTrackTypeInfo& CSegmentMapTrackFactory::GetTypeInfo ( void  )
inlinestatic

Definition at line 159 of file segment_map_track.hpp.

References CSegmentMapTrack::m_TypeInfo.

Referenced by GetThisTypeInfo().

virtual bool CSegmentMapTrackFactory::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 153 of file segment_map_track.hpp.

virtual bool CSegmentMapTrackFactory::UnderstandLevel ( ) const
inlinevirtual

Have any concept of level.

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

Implements ILayoutTrackFactory.

Definition at line 150 of file segment_map_track.hpp.

bool CSegmentMapTrackFactory::x_IsChromosome ( CSGSegmentMapDS ds) const
protected

The documentation for this class was generated from the following files:
Modified on Wed Aug 16 05:44:57 2017 by modify_doxy.py rev. 533848