NCBI C++ ToolKit
Public Types | Public Member Functions | Public Attributes | List of all members
ILayoutTrackFactory::SExtraParams Struct Reference

Search Toolkit Book for ILayoutTrackFactory::SExtraParams

extra parameter for initializing a track. More...

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

+ Collaboration diagram for ILayoutTrackFactory::SExtraParams:

Public Types

typedef vector< stringTAnnots
 
typedef vector< stringTSubTracks
 

Public Member Functions

 SExtraParams ()
 
 SExtraParams (int level, bool adaptive, const TAnnots *annots=NULL, const string &sub_key=NcbiEmptyString, const string &filter=NcbiEmptyString, const string &sort_by=NcbiEmptyString, const string &remote_path=NcbiEmptyString)
 

Public Attributes

int m_Level
 layout level that limits feature retrieving used by annotation selector. More...
 
bool m_Adaptive
 Adaptive/Exact selector. More...
 
TAnnots m_Annots
 particular annotations the track will be looking at. More...
 
string m_Filter
 potential track-specific filter. More...
 
string m_SortBy
 potential track-specific sort_by. More...
 
string m_Subkey
 A subkey for creating feature-specific layout track for a generic layout track type. More...
 
TSeqRange m_Range
 The requested range we want to look at. More...
 
bool m_SkipGenuineCheck
 Flag indicating if track verification is required. More...
 
bool m_FastConfig
 when set to true, indicates that that the factory is used by seqconfig this means that some operations taking a long time and not needed by seqconfig may be skipped while creating the track do not use this anywhere but in seqconfig! a track created with this flag is not usable for loading the track data! More...
 
bool m_CoverageGraphCheck
 Flag indicating if checking coverage graph is necessary. More...
 
bool m_DataTypeCheck
 Flag indicating if track data should be checked against declared track type. More...
 
TSubTracks m_SubTracks
 List of subTracks. More...
 
TAnnotNameTitleMap m_AnnotNameTitleMap
 map of known correspondencies between annots and full titles More...
 
set< stringm_UsedFeatureSubkeys
 Already used feature track subkeys To be used by CAllOtherFeaturesTrack container. More...
 
string m_TrackProfile
 Track setting profile for additionial parameters. More...
 
string m_RemotePath
 Track remote path. More...
 

Detailed Description

extra parameter for initializing a track.

the tracks with no concept of level and annotation can completely ignore the extra parameters.

Definition at line 100 of file layout_track.hpp.

Member Typedef Documentation

◆ TAnnots

Definition at line 102 of file layout_track.hpp.

◆ TSubTracks

Definition at line 103 of file layout_track.hpp.

Constructor & Destructor Documentation

◆ SExtraParams() [1/2]

ILayoutTrackFactory::SExtraParams::SExtraParams ( )
inline

Definition at line 184 of file layout_track.hpp.

◆ SExtraParams() [2/2]

ILayoutTrackFactory::SExtraParams::SExtraParams ( int  level,
bool  adaptive,
const TAnnots annots = NULL,
const string sub_key = NcbiEmptyString,
const string filter = NcbiEmptyString,
const string sort_by = NcbiEmptyString,
const string remote_path = NcbiEmptyString 
)
inline

Definition at line 193 of file layout_track.hpp.

References m_Annots.

Member Data Documentation

◆ m_Adaptive

bool ILayoutTrackFactory::SExtraParams::m_Adaptive

◆ m_AnnotNameTitleMap

TAnnotNameTitleMap ILayoutTrackFactory::SExtraParams::m_AnnotNameTitleMap

map of known correspondencies between annots and full titles

Definition at line 172 of file layout_track.hpp.

Referenced by CSnpTrackFactory::CreateTracks(), and CTrackInitializationJob::Run().

◆ m_Annots

TAnnots ILayoutTrackFactory::SExtraParams::m_Annots

◆ m_CoverageGraphCheck

bool ILayoutTrackFactory::SExtraParams::m_CoverageGraphCheck

Flag indicating if checking coverage graph is necessary.

By defult, it is true.

Definition at line 161 of file layout_track.hpp.

Referenced by CGraphTrackFactory::CreateTracks(), and CAlignmentTrackFactory::CreateTracks().

◆ m_DataTypeCheck

bool ILayoutTrackFactory::SExtraParams::m_DataTypeCheck

Flag indicating if track data should be checked against declared track type.

By default, it's true.

Definition at line 166 of file layout_track.hpp.

Referenced by CGeneModelFactory::CreateTracks().

◆ m_FastConfig

bool ILayoutTrackFactory::SExtraParams::m_FastConfig

when set to true, indicates that that the factory is used by seqconfig this means that some operations taking a long time and not needed by seqconfig may be skipped while creating the track do not use this anywhere but in seqconfig! a track created with this flag is not usable for loading the track data!

Definition at line 157 of file layout_track.hpp.

Referenced by CAggregateFeatureTrackFactory::CreateTracks(), and CAlignmentTrackFactory::CreateTracks().

◆ m_Filter

string ILayoutTrackFactory::SExtraParams::m_Filter

potential track-specific filter.

Any number of fitlers is supported using various logic operators. The operators include AND, OR, NOT, LIKE, =, !=, (), >, <, <=, and >= . For example: f1=f1_val1 and (f1=f1_val2 or f2>f2_val1) and not f3

Definition at line 122 of file layout_track.hpp.

Referenced by CSnpTrackFactory::CreateTracks(), CAggregateFeatureTrackFactory::CreateTracks(), CVarTrackFactory::CreateTracks(), CFeatureTrackFactory::CreateTracks(), CGeneModelFactory::CreateTracks(), CSGSnpDS::GetAnnotNames(), CGeneModelFactory::GetMatchedAnnots(), and CGeneModelFactory::x_CreateTracksWithFilters().

◆ m_Level

int ILayoutTrackFactory::SExtraParams::m_Level

◆ m_Range

TSeqRange ILayoutTrackFactory::SExtraParams::m_Range

The requested range we want to look at.

This is optional since the visible range can also be got from the rendering context for most cases. The range need to be specified for projecting features from another feature, such as alginments.

Definition at line 145 of file layout_track.hpp.

Referenced by CComponentTrackFactory::CreateTracks(), CVarTrackFactory::CreateTracks(), CFeatureTrackFactory::CreateTracks(), CScaffoldTrackFactory::CreateTracks(), CSegmentMapTrackFactory::CreateTracks(), CGeneModelFactory::CreateTracks(), CVcfTrackFactory::CreateTracks(), and CGeneModelFactory::x_CreateTracksWithFilters().

◆ m_RemotePath

string ILayoutTrackFactory::SExtraParams::m_RemotePath

◆ m_SkipGenuineCheck

bool ILayoutTrackFactory::SExtraParams::m_SkipGenuineCheck

◆ m_SortBy

string ILayoutTrackFactory::SExtraParams::m_SortBy

potential track-specific sort_by.

Rules for specifying sort_by: 1. Only one sorting critero is supported at one time 2. Sort_by name and values should be in this format: sort_by=sort_name[|sort_value1|sort_value2...] Sort_name should come at the beginning of the string. Sort_values are options, but if there is any, '|' is used to separate them from sort_name and from each other.

Definition at line 132 of file layout_track.hpp.

Referenced by CAggregateFeatureTrackFactory::CreateTracks(), CVarTrackFactory::CreateTracks(), CFeatureTrackFactory::CreateTracks(), CAlignmentTrackFactory::CreateTracks(), and CGeneModelFactory::x_CreateTracksWithFilters().

◆ m_Subkey

string ILayoutTrackFactory::SExtraParams::m_Subkey

A subkey for creating feature-specific layout track for a generic layout track type.

The example of usage is the layout track for a subtype of seq-feat.

Definition at line 138 of file layout_track.hpp.

Referenced by CAggregateFeatureTrackFactory::CreateTracks(), CVarTrackFactory::CreateTracks(), CFeatureTrackFactory::CreateTracks(), CGeneModelFactory::CreateTracks(), CAggregateFeatureTrackFactory::GetMatchedAnnots(), CVarTrackFactory::GetMatchedAnnots(), and CFeatureTrackFactory::GetMatchedAnnots().

◆ m_SubTracks

TSubTracks ILayoutTrackFactory::SExtraParams::m_SubTracks

◆ m_TrackProfile

string ILayoutTrackFactory::SExtraParams::m_TrackProfile

◆ m_UsedFeatureSubkeys

set<string> ILayoutTrackFactory::SExtraParams::m_UsedFeatureSubkeys

Already used feature track subkeys To be used by CAllOtherFeaturesTrack container.

Definition at line 176 of file layout_track.hpp.

Referenced by CAllOtherFeaturesTrackFactory::CreateTracks(), and CFeaturePanel::x_ConfigureSubtracks().


The documentation for this struct was generated from the following file:
Modified on Sun Mar 03 03:12:31 2024 by modify_doxy.py rev. 669887