NCBI C++ ToolKit
Public Types | Public Member Functions | Private Member Functions | Private Attributes | Friends
SSeqMapSelector Struct Reference

Search Toolkit Book for SSeqMapSelector

Selector used in CSeqMap methods returning iterators. More...

#include <objmgr/seq_map_ci.hpp>

+ Collaboration diagram for SSeqMapSelector:

List of all members.

Public Types

typedef CSeqMap::TFlags TFlags
typedef CRange< TSeqPosTRange

Public Member Functions

 SSeqMapSelector (void)
 SSeqMapSelector (TFlags flags, size_t resolve_count=0)
SSeqMapSelectorSetPosition (TSeqPos pos)
 Find segment containing the position.
SSeqMapSelectorSetRange (TSeqPos start, TSeqPos length)
 Set range for iterator.
SSeqMapSelectorSetRange (const TRange &range)
 Set range for iterator - CRange<> version.
SSeqMapSelectorSetStrand (ENa_strand strand)
 Set strand to iterate over.
SSeqMapSelectorSetResolveCount (size_t res_cnt)
 Set max depth of resolving seq-map.
SSeqMapSelectorSetLinkUsedTSE (bool link=true)
SSeqMapSelectorSetLinkUsedTSE (const CTSE_Handle &top_tse)
SSeqMapSelectorSetLinkUsedTSE (vector< CTSE_Handle > &used_tses)
SSeqMapSelectorSetLimitTSE (const CSeq_entry_Handle &tse)
 Limit TSE to resolve references.
SSeqMapSelectorSetFlags (TFlags flags)
 Select segment type(s)
SSeqMapSelectorSetByFeaturePolicy (void)
size_t GetResolveCount (void) const
bool CanResolve (void) const
void PushResolve (void)
void PopResolve (void)
void AddUsedTSE (const CTSE_Handle &tse) const

Private Member Functions

bool x_HasLimitTSE (void) const
const CTSE_Handlex_GetLimitTSE (CScope *scope=0) const

Private Attributes

TSeqPos m_Position
TSeqPos m_Length
bool m_MinusStrand
bool m_LinkUsedTSE
CTSE_Handle m_TopTSE
size_t m_MaxResolveCount
CTSE_Handle m_LimitTSE
TFlags m_Flags
vector< CTSE_Handle > * m_UsedTSEs

Friends

class CSeqMap
class CSeqMap_CI

Detailed Description

Selector used in CSeqMap methods returning iterators.

Definition at line 110 of file seq_map_ci.hpp.


Member Typedef Documentation

Definition at line 112 of file seq_map_ci.hpp.

Definition at line 132 of file seq_map_ci.hpp.


Constructor & Destructor Documentation

Definition at line 56 of file seq_map_ci.cpp.

SSeqMapSelector::SSeqMapSelector ( TFlags  flags,
size_t  resolve_count = 0 
)

Definition at line 68 of file seq_map_ci.cpp.


Member Function Documentation

Definition at line 94 of file seq_map_ci.cpp.

References m_UsedTSEs.

Referenced by CSeqMap::CanResolveRange(), and CSeqMap_CI::x_Push().

bool SSeqMapSelector::CanResolve ( void  ) const [inline]
size_t SSeqMapSelector::GetResolveCount ( void  ) const [inline]

Definition at line 189 of file seq_map_ci.hpp.

Referenced by CSeqMap_CI::x_Found().

void SSeqMapSelector::PopResolve ( void  ) [inline]

Definition at line 203 of file seq_map_ci.hpp.

References _ASSERT.

Referenced by CSeqMap_CI::x_Pop().

void SSeqMapSelector::PushResolve ( void  ) [inline]

Definition at line 198 of file seq_map_ci.hpp.

References _ASSERT.

Referenced by CSeqMap_CI::x_Push().

Definition at line 160 of file seq_map_ci.hpp.

SSeqMapSelector& SSeqMapSelector::SetLinkUsedTSE ( vector< CTSE_Handle > &  used_tses) [inline]

Definition at line 166 of file seq_map_ci.hpp.

Find segment containing the position.

Definition at line 118 of file seq_map_ci.hpp.

Referenced by CSeqMap_CI::CSeqMap_CI().

SSeqMapSelector& SSeqMapSelector::SetRange ( TSeqPos  start,
TSeqPos  length 
) [inline]

Set range for iterator - CRange<> version.

Definition at line 134 of file seq_map_ci.hpp.

References COpenRange< Position >::GetFrom(), and COpenRange< Position >::GetLength().

SSeqMapSelector& SSeqMapSelector::SetResolveCount ( size_t  res_cnt) [inline]
const CTSE_Handle & SSeqMapSelector::x_GetLimitTSE ( CScope scope = 0) const [private]

Definition at line 87 of file seq_map_ci.cpp.

References _ASSERT, and m_LimitTSE.

Referenced by CSeqMap_CI::x_Push(), and CSeqMap_CI::x_RefTSEMatch().

bool SSeqMapSelector::x_HasLimitTSE ( void  ) const [inline, private]

Friends And Related Function Documentation

friend class CSeqMap [friend]

Definition at line 212 of file seq_map_ci.hpp.

friend class CSeqMap_CI [friend]

Definition at line 213 of file seq_map_ci.hpp.


Member Data Documentation

Definition at line 236 of file seq_map_ci.hpp.

Referenced by CSeqMap_CI::GetFlags().

Definition at line 234 of file seq_map_ci.hpp.

Referenced by SetLimitTSE(), and x_GetLimitTSE().

Definition at line 228 of file seq_map_ci.hpp.

Referenced by CSeqMap::CanResolveRange().

Definition at line 232 of file seq_map_ci.hpp.

Referenced by CSeqMap::CanResolveRange().

Definition at line 226 of file seq_map_ci.hpp.

Referenced by CSeqMap_CI::x_Select().

Definition at line 230 of file seq_map_ci.hpp.

Referenced by CSeqMap::CanResolveRange(), and CSeqMap_CI::x_Select().

Definition at line 238 of file seq_map_ci.hpp.

Referenced by AddUsedTSE().


The documentation for this struct was generated from the following files:
Modified on Wed May 06 12:01:57 2015 by modify_doxy.py rev. 426318