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

Search Toolkit Book for CBioObjectId

#include <objmgr/bio_object_id.hpp>

+ Collaboration diagram for CBioObjectId:

Public Types

enum  EType { eSeqId , eSetId , eUniqNumber , eUnSet }
 

Public Member Functions

 CBioObjectId ()
 
 CBioObjectId (const CSeq_id_Handle &id)
 
 CBioObjectId (EType type, TIntId id)
 
const CSeq_id_HandleGetSeqId () const
 
TIntId GetSetId () const
 
TIntId GetUniqNumber () const
 
bool operator== (const CBioObjectId &other) const
 
bool operator!= (const CBioObjectId &other) const
 
bool operator< (const CBioObjectId &other) const
 
EType GetType () const
 
const CSeq_id_Handlex_GetSeqIdNoCheck () const
 

Private Attributes

pair< EType, CSeq_id_Handlem_Id
 

Detailed Description

Definition at line 42 of file bio_object_id.hpp.

Member Enumeration Documentation

◆ EType

enum CBioObjectId::EType ( void  )
Enumerator
eSeqId 
eSetId 
eUniqNumber 
eUnSet 

Definition at line 45 of file bio_object_id.hpp.

Constructor & Destructor Documentation

◆ CBioObjectId() [1/3]

CBioObjectId::CBioObjectId ( )
inline

Definition at line 51 of file bio_object_id.hpp.

◆ CBioObjectId() [2/3]

CBioObjectId::CBioObjectId ( const CSeq_id_Handle id)
inlineexplicit

Definition at line 52 of file bio_object_id.hpp.

◆ CBioObjectId() [3/3]

CBioObjectId::CBioObjectId ( EType  type,
TIntId  id 
)
inline

Definition at line 53 of file bio_object_id.hpp.

References _ASSERT.

Member Function Documentation

◆ GetSeqId()

const CSeq_id_Handle& CBioObjectId::GetSeqId ( void  ) const
inline

Definition at line 59 of file bio_object_id.hpp.

References _ASSERT.

Referenced by CTSE_Info::x_FindBioObject().

◆ GetSetId()

TIntId CBioObjectId::GetSetId ( ) const
inline

Definition at line 63 of file bio_object_id.hpp.

References _ASSERT, and GI_TO.

Referenced by CTSE_Info::x_FindBioObject().

◆ GetType()

EType CBioObjectId::GetType ( void  ) const
inline

◆ GetUniqNumber()

TIntId CBioObjectId::GetUniqNumber ( ) const
inline

Definition at line 67 of file bio_object_id.hpp.

References _ASSERT, and GI_TO.

◆ operator!=()

bool CBioObjectId::operator!= ( const CBioObjectId other) const
inline

Definition at line 74 of file bio_object_id.hpp.

References m_Id.

◆ operator<()

bool CBioObjectId::operator< ( const CBioObjectId other) const
inline

Definition at line 77 of file bio_object_id.hpp.

References m_Id.

◆ operator==()

bool CBioObjectId::operator== ( const CBioObjectId other) const
inline

Definition at line 71 of file bio_object_id.hpp.

References m_Id.

◆ x_GetSeqIdNoCheck()

const CSeq_id_Handle& CBioObjectId::x_GetSeqIdNoCheck ( ) const
inline

Definition at line 82 of file bio_object_id.hpp.

Member Data Documentation

◆ m_Id

pair<EType, CSeq_id_Handle> CBioObjectId::m_Id
private

Definition at line 85 of file bio_object_id.hpp.

Referenced by operator!=(), operator<(), and operator==().


The documentation for this class was generated from the following file:
Modified on Fri May 24 14:56:36 2024 by modify_doxy.py rev. 669887