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

Search Toolkit Book for CPSG_BioId

Bio-id (such as accession) More...

#include <objtools/pubseq_gateway/client/psg_client.hpp>

Public Types

using CSeq_id = objects::CSeq_id
 
using TType = CSeq_id::E_Choice
 

Public Member Functions

 CPSG_BioId (string id, TType type={})
 
 CPSG_BioId (const CSeq_id &seq_id)
 
 CPSG_BioId (const objects::CSeq_id_Handle &seq_id_handle)
 
string Repr () const
 Get tilde-separated string representation of this bio ID (e.g. for logging) More...
 
const stringGetId () const
 Get ID. More...
 
TType GetType () const
 Get type. More...
 

Private Attributes

string m_Id
 
TType m_Type
 

Detailed Description

Bio-id (such as accession)

Definition at line 174 of file psg_client.hpp.

Member Typedef Documentation

◆ CSeq_id

using CPSG_BioId::CSeq_id = objects::CSeq_id

Definition at line 177 of file psg_client.hpp.

◆ TType

Definition at line 178 of file psg_client.hpp.

Constructor & Destructor Documentation

◆ CPSG_BioId() [1/3]

CPSG_BioId::CPSG_BioId ( string  id,
TType  type = {} 
)
inline
Parameters
idBio ID (like accession)

Definition at line 182 of file psg_client.hpp.

◆ CPSG_BioId() [2/3]

CPSG_BioId::CPSG_BioId ( const CSeq_id seq_id)
inline
Parameters
seq_idSeq ID

Definition at line 186 of file psg_client.hpp.

References CSeq_id::eFastaContent, CSeq_id::GetLabel(), and m_Id.

◆ CPSG_BioId() [3/3]

CPSG_BioId::CPSG_BioId ( const objects::CSeq_id_Handle &  seq_id_handle)
inline
Parameters
seq_id_handleSeq ID handle

Definition at line 190 of file psg_client.hpp.

Member Function Documentation

◆ GetId()

const string& CPSG_BioId::GetId ( void  ) const
inline

◆ GetType()

TType CPSG_BioId::GetType ( void  ) const
inline

Get type.

Definition at line 199 of file psg_client.hpp.

References m_Type.

Referenced by operator<<(), s_GetFastaString(), and CJsonResponse::Set().

◆ Repr()

string CPSG_BioId::Repr ( ) const

Get tilde-separated string representation of this bio ID (e.g. for logging)

Definition at line 190 of file psg_client.cpp.

References e_not_set, m_Id, and m_Type.

Referenced by CPSG_Request_Biodata::x_GetId(), CPSG_Request_Resolve::x_GetId(), CPSG_Request_NamedAnnotInfo::x_GetId(), and CPSGDataLoader_Impl::x_MakeLoadLocalCDDEntryRequest().

Member Data Documentation

◆ m_Id

string CPSG_BioId::m_Id
private

Definition at line 202 of file psg_client.hpp.

Referenced by CPSG_BioId(), GetId(), and Repr().

◆ m_Type

TType CPSG_BioId::m_Type
private

Definition at line 203 of file psg_client.hpp.

Referenced by GetType(), and Repr().


The documentation for this class was generated from the following files:
Modified on Wed Feb 28 07:13:40 2024 by modify_doxy.py rev. 669887