NCBI C++ ToolKit
Classes | Public Types | Public Member Functions | List of all members
IHitMatrixDataSource Class Referenceabstract

Search Toolkit Book for IHitMatrixDataSource

IHitMatrixDataSource - abstract Data Source for Hit Matrix Widget. More...

#include <gui/widgets/hit_matrix/hit_matrix_ds.hpp>

+ Inheritance diagram for IHitMatrixDataSource:

Classes

struct  SParams
 

Public Types

typedef vector< CConstRef< objects::CSeq_align > > TAlignVector
 
typedef vector< IHitSeqId * > TIdVector
 
typedef vector< IHit * > THitAdapterCont
 
typedef pair< double, double > TValueRange
 
typedef IHit::TDirection TDirection
 

Public Member Functions

virtual ~IHitMatrixDataSource ()
 
virtual void Init (objects::CScope &scope, TAlignVector &aligns)=0
 
virtual bool CanCreateRowBased () const =0
 
virtual void SetParams (const SParams &params, bool create_hits)=0
 
virtual void GetParams (SParams &params) const =0
 
virtual bool SelectIds (const IHitSeqId &q_id, const IHitSeqId &s_id)=0
 selects hits by query and subject IDs More...
 
virtual bool SelectDefaultIds ()=0
 selects default query and subject More...
 
virtual const TIdVectorGetHitSeqIds ()=0
 returns list of all seq ids in the Data Source More...
 
virtual void GetHitSeqIdsForParams (TIdVector &ids, const SParams &params) const =0
 returns a list of ids that Data Source will create if the given params are applied. More...
 
virtual void GetAlignedIds (const IHitSeqId &id, TIdVector &aligned)=0
 
virtual void GetAlignedIdsForParams (const IHitSeqId &id, const TIdVector &ids, TIdVector &aligned, const SParams &params)=0
 returns a list of ids that will be aligned with the specified id if the given params are applied. More...
 
virtual objects::CScope & GetScope ()=0
 
virtual IHitSeqIdGetQueryId () const =0
 
virtual IHitSeqIdGetSubjectId () const =0
 
virtual objects::CBioseq_Handle GetQueryHandle ()=0
 
virtual objects::CBioseq_Handle GetSubjectHandle ()=0
 
virtual objects::CBioseq_Handle GetBioseqHandle (const IHitSeqId &id)=0
 
virtual string GetLabel (const IHitSeqId &id)=0
 
virtual void GetScoreNames (vector< string > &names) const =0
 
virtual TValueRange GetScoreRange (const string &name) const =0
 
virtual const THitAdapterContGetHits () const =0
 
virtual TSeqRange GetQueryHitsRange ()=0
 
virtual TSeqRange GetSubjectHitsRange ()=0
 

Detailed Description

IHitMatrixDataSource - abstract Data Source for Hit Matrix Widget.

Definition at line 70 of file hit_matrix_ds.hpp.

Member Typedef Documentation

◆ TAlignVector

typedef vector< CConstRef<objects::CSeq_align> > IHitMatrixDataSource::TAlignVector

Definition at line 73 of file hit_matrix_ds.hpp.

◆ TDirection

Definition at line 77 of file hit_matrix_ds.hpp.

◆ THitAdapterCont

Definition at line 75 of file hit_matrix_ds.hpp.

◆ TIdVector

Definition at line 74 of file hit_matrix_ds.hpp.

◆ TValueRange

typedef pair<double, double> IHitMatrixDataSource::TValueRange

Definition at line 76 of file hit_matrix_ds.hpp.

Constructor & Destructor Documentation

◆ ~IHitMatrixDataSource()

virtual IHitMatrixDataSource::~IHitMatrixDataSource ( )
inlinevirtual

Definition at line 89 of file hit_matrix_ds.hpp.

Member Function Documentation

◆ CanCreateRowBased()

virtual bool IHitMatrixDataSource::CanCreateRowBased ( ) const
pure virtual

Implemented in CHitMatrixDataSource.

◆ GetAlignedIds()

virtual void IHitMatrixDataSource::GetAlignedIds ( const IHitSeqId id,
TIdVector aligned 
)
pure virtual

Implemented in CHitMatrixDataSource.

◆ GetAlignedIdsForParams()

virtual void IHitMatrixDataSource::GetAlignedIdsForParams ( const IHitSeqId id,
const TIdVector ids,
TIdVector aligned,
const SParams params 
)
pure virtual

returns a list of ids that will be aligned with the specified id if the given params are applied.

Implemented in CHitMatrixDataSource.

◆ GetBioseqHandle()

virtual objects::CBioseq_Handle IHitMatrixDataSource::GetBioseqHandle ( const IHitSeqId id)
pure virtual

Implemented in CHitMatrixDataSource.

Referenced by CAlignSeqTableModel::Init().

◆ GetHits()

virtual const THitAdapterCont& IHitMatrixDataSource::GetHits ( ) const
pure virtual

◆ GetHitSeqIds()

virtual const TIdVector& IHitMatrixDataSource::GetHitSeqIds ( )
pure virtual

returns list of all seq ids in the Data Source

Implemented in CHitMatrixDataSource.

◆ GetHitSeqIdsForParams()

virtual void IHitMatrixDataSource::GetHitSeqIdsForParams ( TIdVector ids,
const SParams params 
) const
pure virtual

returns a list of ids that Data Source will create if the given params are applied.

The caller is responsible for deleting ids.

Implemented in CHitMatrixDataSource.

◆ GetLabel()

virtual string IHitMatrixDataSource::GetLabel ( const IHitSeqId id)
pure virtual

◆ GetParams()

virtual void IHitMatrixDataSource::GetParams ( SParams params) const
pure virtual

Implemented in CHitMatrixDataSource.

◆ GetQueryHandle()

virtual objects::CBioseq_Handle IHitMatrixDataSource::GetQueryHandle ( )
pure virtual

◆ GetQueryHitsRange()

virtual TSeqRange IHitMatrixDataSource::GetQueryHitsRange ( )
pure virtual

◆ GetQueryId()

virtual IHitSeqId& IHitMatrixDataSource::GetQueryId ( ) const
pure virtual

◆ GetScope()

virtual objects::CScope& IHitMatrixDataSource::GetScope ( )
pure virtual

Implemented in CHitMatrixDataSource.

◆ GetScoreNames()

virtual void IHitMatrixDataSource::GetScoreNames ( vector< string > &  names) const
pure virtual

Implemented in CHitMatrixDataSource.

◆ GetScoreRange()

virtual TValueRange IHitMatrixDataSource::GetScoreRange ( const string name) const
pure virtual

Implemented in CHitMatrixDataSource.

◆ GetSubjectHandle()

virtual objects::CBioseq_Handle IHitMatrixDataSource::GetSubjectHandle ( )
pure virtual

◆ GetSubjectHitsRange()

virtual TSeqRange IHitMatrixDataSource::GetSubjectHitsRange ( )
pure virtual

◆ GetSubjectId()

virtual IHitSeqId& IHitMatrixDataSource::GetSubjectId ( ) const
pure virtual

◆ Init()

virtual void IHitMatrixDataSource::Init ( objects::CScope &  scope,
TAlignVector aligns 
)
pure virtual

Implemented in CHitMatrixDataSource.

◆ SelectDefaultIds()

virtual bool IHitMatrixDataSource::SelectDefaultIds ( )
pure virtual

selects default query and subject

Implemented in CHitMatrixDataSource.

◆ SelectIds()

virtual bool IHitMatrixDataSource::SelectIds ( const IHitSeqId q_id,
const IHitSeqId s_id 
)
pure virtual

selects hits by query and subject IDs

Implemented in CHitMatrixDataSource.

◆ SetParams()

virtual void IHitMatrixDataSource::SetParams ( const SParams params,
bool  create_hits 
)
pure virtual

Implemented in CHitMatrixDataSource.


The documentation for this class was generated from the following file:
Modified on Sun Feb 25 03:00:12 2024 by modify_doxy.py rev. 669887