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

Search Toolkit Book for CSeq_loc_CI

Seq-loc iterator class – iterates all intervals from a seq-loc in the correct order. More...

#include <objects/seqloc/Seq_loc.hpp>

+ Inheritance diagram for CSeq_loc_CI:
+ Collaboration diagram for CSeq_loc_CI:

Public Types

enum  EEmptyFlag { eEmpty_Skip , eEmpty_Allow }
 Options for empty locations processing. More...
 
enum  ESeqLocOrder { eOrder_Positional , eOrder_Biological }
 
typedef CSeq_loc::TRange TRange
 

Public Member Functions

 CSeq_loc_CI (void)
 constructors More...
 
 CSeq_loc_CI (const CSeq_loc &loc, EEmptyFlag empty_flag=eEmpty_Skip, ESeqLocOrder order=eOrder_Biological)
 
 CSeq_loc_CI (const CSeq_loc_CI &iter, size_t pos)
 construct iterator at a different position in the same location More...
 
virtual ~CSeq_loc_CI (void)
 destructor More...
 
 CSeq_loc_CI (const CSeq_loc_CI &iter)
 
CSeq_loc_CIoperator= (const CSeq_loc_CI &iter)
 
CSeq_loc_CIoperator++ (void)
 
 DECLARE_OPERATOR_BOOL (x_IsValid())
 
bool operator== (const CSeq_loc_CI &iter) const
 
bool operator!= (const CSeq_loc_CI &iter) const
 
bool IsInBond (void) const
 Location of type equiv define set of equivalent locations. More...
 
bool IsBondA (void) const
 Return true if current position is A part of a bond. More...
 
bool IsBondB (void) const
 Return true if current position is B part of a bond. More...
 
pair< CSeq_loc_CI, CSeq_loc_CIGetBondRange (void) const
 Return iterators that cover bond of current position result.first is the first segment in the equiv set result.second is the first segment after the equiv set. More...
 
bool HasEquivSets (void) const
 Return true if location has equiv parts. More...
 
bool IsInEquivSet (void) const
 Return true if current position is in some equiv part. More...
 
size_t GetEquivSetsCount (void) const
 Return number of recursuve equiv parts current position in. More...
 
pair< CSeq_loc_CI, CSeq_loc_CIGetEquivSetRange (size_t level=0) const
 Return iterators that cover equiv set of current position result.first is the first segment in the equiv set result.second is the first segment after the equiv set level specify equiv set if there are more than one of them level = 0 is the smallest equiv set (innermost) More...
 
pair< CSeq_loc_CI, CSeq_loc_CIGetEquivPartRange (size_t level=0) const
 Return iterators that cover equiv part of current position result.first is the first segment in the equiv part result.second is the first segment after the equiv part level specify equiv set if there are more than one of them level = 0 is the smallest equiv set (innermost) More...
 
const CSeq_idGetSeq_id (void) const
 Get seq_id of the current location. More...
 
CSeq_id_Handle GetSeq_id_Handle (void) const
 
TRange GetRange (void) const
 Get the range. More...
 
bool IsSetStrand (void) const
 Get strand. More...
 
ENa_strand GetStrand (void) const
 
CConstRef< CSeq_locGetRangeAsSeq_loc (void) const
 Get seq-loc for the current iterator position. More...
 
const CSeq_locGetEmbeddingSeq_loc (void) const
 Get the nearest seq-loc containing the current range. More...
 
const CSeq_locGetSeq_loc (void) const
 
const CInt_fuzzGetFuzzFrom (void) const
 
const CInt_fuzzGetFuzzTo (void) const
 
bool IsWhole (void) const
 True if the current location is a whole sequence. More...
 
bool IsEmpty (void) const
 True if the current location is empty. More...
 
bool IsPoint (void) const
 True if the current location is a single point. More...
 
void Rewind (void)
 Reset the iterator to the initial state. More...
 
size_t GetSize (void) const
 Get number of ranges. More...
 
size_t GetPos (void) const
 Get iterator's position. More...
 
void SetPos (size_t pos)
 Set iterator's position. More...
 
const CSeq_loc_CIoperator* () const
 

Protected Member Functions

const SSeq_loc_CI_RangeInfox_GetRangeInfo (void) const
 
bool x_IsValid (void) const
 
virtual const char * x_GetIteratorType (void) const
 
void x_CheckValid (const char *where) const
 
void x_ThrowNotValid (const char *where) const
 

Protected Attributes

CRef< CSeq_loc_CI_Implm_Impl
 
size_t m_Index
 

Detailed Description

Seq-loc iterator class – iterates all intervals from a seq-loc in the correct order.

Definition at line 452 of file Seq_loc.hpp.


The documentation for this class was generated from the following files:
Modified on Tue Apr 23 07:38:14 2024 by modify_doxy.py rev. 669887