NCBI C++ ToolKit
Public Types | Public Member Functions | Private Attributes | List of all members
CFeaturePanelDS Class Reference

Search Toolkit Book for CFeaturePanelDS

CFeaturePanelDS. More...

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

+ Inheritance diagram for CFeaturePanelDS:
+ Collaboration diagram for CFeaturePanelDS:

Public Types

typedef ILayoutTrackFactory::TAnnotMetaDataList TAnnotMetaDataList
 
- Public Types inherited from CSGGenBankDS
typedef CAppJobDispatcher::TJobID TJobID
 
typedef int TJobToken
 
- 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 Types inherited from ISGDataSource
typedef map< string, stringTAnnotNameTitleMap
 List of annotations with the corresponding titles. More...
 

Public Member Functions

 CFeaturePanelDS (objects::CScope &scope, const objects::CSeq_id &id)
 
 ~CFeaturePanelDS ()
 
bool IsMetaDataJob (TJobID id) const
 CFeaturePanelDS inline methods. More...
 
void DeleteMetaDataJob ()
 
void ClearMetaDataJobId ()
 
void CreateTrack (const string &desc, const ILayoutTrackFactory *factory, CTrackContainer *parent, CTempTrackProxy *params, const ILayoutTrackFactory::SExtraParams &extra_param)
 
void GetAnnotMetaData (const string &desc)
 retrieve a list of annotations with their meta data. More...
 
void GetAssemblies (const string &seqAcc)
 
void SetDSContext (ISGDataSourceContext *ds_context)
 
void SetRenderingContext (CRenderingContext *r_cntx)
 
void SetAssembly (const string &assembly)
 
const stringGetAssembly () const
 
void SetTMSContext (const string &tms_context)
 
void SetUseEUtils (bool use)
 
virtual bool AllJobsFinished () const
 
- Public Member Functions inherited from CSGGenBankDS
 CSGGenBankDS (objects::CScope &scope, const objects::CSeq_id &id)
 
virtual ~CSGGenBankDS ()
 
bool IsRefSeq () const
 
void SetDepth (int depth)
 Set the annotation selector resolving depth. More...
 
int GetDepth () const
 
void SetAdaptive (bool flag)
 
bool GetAdaptive () const
 
objects::CBioseq_Handle & GetBioseqHandle (void)
 Get the underlying bioseq handle. More...
 
const objects::CBioseq_Handle & GetBioseqHandle (void) const
 
objects::CScope & GetScope (void) const
 Get the scope from the handle. More...
 
void SetJobListener (CEventHandler *listener)
 Set JobDispatcher listener. More...
 
virtual void ClearJobID (TJobID job_id)
 
bool IsJobNeeded (TJobID job_id) const
 
virtual void DeleteAllJobs ()
 Remove waiting jobs from queue or cancel the unfinished jobs. More...
 
void SetCoordMapper (ICoordMapper *mapper)
 
void SetGraphLevels (const string &annot)
 
- Public Member Functions inherited from CObjectEx
 CObjectEx (void)
 
virtual ~CObjectEx (void)
 
- 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 CWeakObject
 CWeakObject (void)
 
virtual ~CWeakObject (void)
 
CPtrToObjectProxyGetPtrProxy (void) const
 Get pointer to proxy object containing pointer to this object. More...
 
- Public Member Functions inherited from ISGDataSource
virtual ~ISGDataSource ()
 

Private Member Functions

Forbidden methods
 CFeaturePanelDS (const CFeaturePanelDS &)
 
CFeaturePanelDSoperator= (const CFeaturePanelDS &)
 

Private Attributes

CIRef< ISGDataSourceContextm_DSContext
 
CRenderingContextm_RenderingCntx
 
string m_Assembly
 
string m_TMSContext
 
bool m_UseEUtils
 
TJobID m_MetaDataJob
 job id for annot meta-data job id. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from CSGDataSource
static void SetBackgroundJob (bool flag)
 
static bool IsBackgroundJob ()
 
- 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 Types inherited from CSGGenBankDS
typedef set< intTGraphLevels
 
- Protected Member Functions inherited from CSGGenBankDS
void x_ForegroundJob (IAppJob &job)
 
TJobID x_BackgroundJob (IAppJob &job, int report_period, const string &pool)
 Jobs on thread pool. More...
 
TJobID x_LaunchJob (IAppJob &job, int report_period=1, const string &pool="ObjManagerEngine")
 Launch either a background or foreground job. More...
 
- Protected Member Functions inherited from CObject
virtual void DeleteThis (void)
 Virtual method "deleting" this object. More...
 
- Protected Member Functions inherited from CWeakObject
void CleanWeakRefs (void) const
 Method cleaning all CWeakRefs referencing at this moment to the object After calling to this method all existing CWeakRefs referencing to the object will return NULL, so it effectively will be equal to deleting the object. More...
 
- Protected Attributes inherited from CSGGenBankDS
objects::CBioseq_Handle m_Handle
 
CEventHandlerm_JobListener
 our listener to JobDispatcher events More...
 
vector< TJobIDm_ActiveJobs
 all currently active jobs for this DS More...
 
int m_Depth
 annotation resolving depth More...
 
bool m_Adaptive
 adaptive/exact annot selector More...
 
CIRef< ICoordMapperm_Mapper
 coordinate mapper between mapped features coord. and sequence coord. More...
 
TGraphLevels m_GraphLevels
 Existing coverage graph levels. More...
 
- Static Protected Attributes inherited from CSGDataSource
static bool m_Background = true
 

Detailed Description

CFeaturePanelDS.

Definition at line 49 of file feature_panel_ds.hpp.

Member Typedef Documentation

◆ TAnnotMetaDataList

Definition at line 53 of file feature_panel_ds.hpp.

Constructor & Destructor Documentation

◆ CFeaturePanelDS() [1/2]

CFeaturePanelDS::CFeaturePanelDS ( objects::CScope &  scope,
const objects::CSeq_id &  id 
)

◆ ~CFeaturePanelDS()

CFeaturePanelDS::~CFeaturePanelDS ( )

Definition at line 386 of file feature_panel_ds.cpp.

References DeleteMetaDataJob().

◆ CFeaturePanelDS() [2/2]

CFeaturePanelDS::CFeaturePanelDS ( const CFeaturePanelDS )
private

Member Function Documentation

◆ AllJobsFinished()

bool CFeaturePanelDS::AllJobsFinished ( ) const
virtual

◆ ClearMetaDataJobId()

void CFeaturePanelDS::ClearMetaDataJobId ( )

Definition at line 440 of file feature_panel_ds.cpp.

References m_MetaDataJob.

Referenced by CFeaturePanel::x_OnJobCompleted().

◆ CreateTrack()

void CFeaturePanelDS::CreateTrack ( const string desc,
const ILayoutTrackFactory factory,
CTrackContainer parent,
CTempTrackProxy params,
const ILayoutTrackFactory::SExtraParams extra_param 
)

◆ DeleteMetaDataJob()

void CFeaturePanelDS::DeleteMetaDataJob ( )

◆ GetAnnotMetaData()

void CFeaturePanelDS::GetAnnotMetaData ( const string desc)

◆ GetAssemblies()

void CFeaturePanelDS::GetAssemblies ( const string seqAcc)

◆ GetAssembly()

const string& CFeaturePanelDS::GetAssembly ( ) const
inline

◆ IsMetaDataJob()

bool CFeaturePanelDS::IsMetaDataJob ( TJobID  id) const
inline

CFeaturePanelDS inline methods.

Definition at line 163 of file feature_panel_ds.hpp.

References m_MetaDataJob.

Referenced by CFeaturePanel::x_IsJobNeeded().

◆ operator=()

CFeaturePanelDS& CFeaturePanelDS::operator= ( const CFeaturePanelDS )
private

◆ SetAssembly()

void CFeaturePanelDS::SetAssembly ( const string assembly)

◆ SetDSContext()

void CFeaturePanelDS::SetDSContext ( ISGDataSourceContext ds_context)
inline

◆ SetRenderingContext()

void CFeaturePanelDS::SetRenderingContext ( CRenderingContext r_cntx)
inline

◆ SetTMSContext()

void CFeaturePanelDS::SetTMSContext ( const string tms_context)

Definition at line 397 of file feature_panel_ds.cpp.

References DeleteMetaDataJob(), and m_TMSContext.

Referenced by CFeaturePanel::SetInputObject().

◆ SetUseEUtils()

void CFeaturePanelDS::SetUseEUtils ( bool  use)

Definition at line 403 of file feature_panel_ds.cpp.

References DeleteMetaDataJob(), and m_UseEUtils.

Referenced by CFeaturePanel::SetInputObject().

Member Data Documentation

◆ m_Assembly

string CFeaturePanelDS::m_Assembly
private

Definition at line 89 of file feature_panel_ds.hpp.

Referenced by GetAnnotMetaData(), GetAssembly(), and SetAssembly().

◆ m_DSContext

CIRef<ISGDataSourceContext> CFeaturePanelDS::m_DSContext
private

Definition at line 86 of file feature_panel_ds.hpp.

Referenced by CreateTrack(), and SetDSContext().

◆ m_MetaDataJob

TJobID CFeaturePanelDS::m_MetaDataJob
private

job id for annot meta-data job id.

Definition at line 94 of file feature_panel_ds.hpp.

Referenced by AllJobsFinished(), ClearMetaDataJobId(), DeleteMetaDataJob(), GetAnnotMetaData(), GetAssemblies(), and IsMetaDataJob().

◆ m_RenderingCntx

CRenderingContext* CFeaturePanelDS::m_RenderingCntx
private

Definition at line 87 of file feature_panel_ds.hpp.

Referenced by CreateTrack(), and SetRenderingContext().

◆ m_TMSContext

string CFeaturePanelDS::m_TMSContext
private

Definition at line 90 of file feature_panel_ds.hpp.

Referenced by GetAnnotMetaData(), and SetTMSContext().

◆ m_UseEUtils

bool CFeaturePanelDS::m_UseEUtils
private

Definition at line 91 of file feature_panel_ds.hpp.

Referenced by SetUseEUtils().


The documentation for this class was generated from the following files:
Modified on Fri Jul 12 16:23:09 2024 by modify_doxy.py rev. 669887