NCBI C++ ToolKit
Classes | Public Types | Public Member Functions | Static Public Member Functions | Private Attributes | Friends | List of all members
CSeq_id_Handle Class Reference

Search Toolkit Book for CSeq_id_Handle

#include <objects/seq/seq_id_handle.hpp>

+ Inheritance diagram for CSeq_id_Handle:
+ Collaboration diagram for CSeq_id_Handle:


struct  PLessOrdered
 Predicate for sorting CSeq_id_Handles in a defined order. More...

Public Types

typedef CSeq_id_Info::TPacked TPacked
typedef CSeq_id_Info::TVariant TVariant
typedef set< CSeq_id_HandleTMatches

Public Member Functions

 CSeq_id_Handle (void)
 CSeq_id_Handle (const CSeq_id_Info *info, TPacked packed=0, TVariant variant=0)
 CSeq_id_Handle (ENull)
bool operator== (const CSeq_id_Handle &handle) const
bool operator!= (const CSeq_id_Handle &handle) const
bool operator< (const CSeq_id_Handle &handle) const
bool operator== (const CSeq_id &id) const
int CompareOrdered (const CSeq_id_Handle &id) const
 Compare ids in a defined order (see CSeq_id::CompareOrdered()) More...
 Check if the handle is a valid or an empty one. More...
void Reset (void)
 Reset the handle (remove seq-id reference) More...
bool HaveMatchingHandles (void) const
bool HaveReverseMatch (void) const
bool HaveMatchingHandles (EAllowWeakMatch allow_weak_match) const
bool HaveReverseMatch (EAllowWeakMatch allow_weak_match) const
void GetMatchingHandles (TMatches &matches) const
void GetReverseMatchingHandles (TMatches &matches) const
void GetMatchingHandles (TMatches &matches, EAllowWeakMatch allow_weak_match) const
void GetReverseMatchingHandles (TMatches &matches, EAllowWeakMatch allow_weak_match) const
bool MatchesTo (const CSeq_id_Handle &h) const
 True if *this matches to h. More...
bool IsBetter (const CSeq_id_Handle &h) const
 True if "this" is a better bioseq than "h". More...
string AsString (void) const
CSeq_id::E_Choice Which (void) const
bool IsPacked (void) const
TPacked GetPacked (void) const
bool IsSetVariant (void) const
TVariant GetVariant (void) const
bool IsGi (void) const
TGi GetGi (void) const
bool IsAccVer (void) const
unsigned GetHash (void) const
CSeq_id::EAccessionInfo IdentifyAccession (void) const
CConstRef< CSeq_idGetSeqId (void) const
CConstRef< CSeq_idGetSeqIdOrNull (void) const
CSeq_id_MapperGetMapper (void) const
void Swap (CSeq_id_Handle &idh)
bool IsAllowedSNPScaleLimit (CSeq_id::ESNPScaleLimit scale_limit) const
const CSeq_id_Infox_GetInfo (void) const

Static Public Member Functions

static CSeq_id_Handle GetHandle (const CSeq_id &id)
 Normal way of getting a handle, works for any seq-id. More...
static CSeq_id_Handle GetHandle (const string &str_id)
 Construct CSeq_id from string representation and return handle for it. More...
static CSeq_id_Handle GetHandle (TGi gi)
 Faster way to create a handle for a gi. More...
static CSeq_id_Handle GetGiHandle (TGi gi)
 Faster way to create a handle for a gi. More...

Private Attributes

CConstRef< CSeq_id_Info, CSeq_id_InfoLockerm_Info
TPacked m_Packed
TVariant m_Variant


class CSeq_id_Mapper
class CSeq_id_Which_Tree

Detailed Description

Definition at line 157 of file seq_id_handle.hpp.

The documentation for this class was generated from the following files:
Modified on Wed Apr 17 13:08:34 2024 by rev. 669887