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

Search Toolkit Book for CTaxon3

#include <objects/taxon3/taxon3.hpp>

+ Inheritance diagram for CTaxon3:
+ Collaboration diagram for CTaxon3:

Public Types

enum class  initialize { yes , no }
 
- Public Types inherited from ITaxon3
enum  ETaxon3_reply_part {
  eT3reply_nothing = 0 , eT3reply_org = 0x0001 , eT3reply_blast_lin = 0x0002 , eT3reply_status = 0x0004 ,
  eT3reply_refresh = 0x0008 , eT3reply_all = (eT3reply_org | eT3reply_blast_lin | eT3reply_status | eT3reply_refresh) , eT3reply_default = eT3reply_all
}
 
typedef unsigned int fT3reply_parts
 

Public Member Functions

 CTaxon3 (initialize=initialize::no)
 
 CTaxon3 (const STimeout &timeout, unsigned reconnect_attempts=5, bool exponential=false)
 
virtual ~CTaxon3 ()
 
virtual void Init ()
 
virtual void Init (const STimeout *timeout, unsigned reconnect_attempts=5)
 
virtual CRef< CTaxon3_replySendOrgRefList (const vector< CRef< COrg_ref > > &list, COrg_ref::fOrgref_parts result_parts=COrg_ref::eOrgref_default, fT3reply_parts t3result_parts=eT3reply_default)
 
virtual CRef< CTaxon3_replySendNameList (const vector< std::string > &list, COrg_ref::fOrgref_parts parts=(COrg_ref::eOrgref_taxname|COrg_ref::eOrgref_db_taxid), fT3reply_parts t3parts=(eT3reply_org|eT3reply_status))
 
virtual CRef< CTaxon3_replySendTaxidList (const vector< TTaxId > &list, COrg_ref::fOrgref_parts parts=(COrg_ref::eOrgref_taxname|COrg_ref::eOrgref_db_taxid), fT3reply_parts t3parts=eT3reply_org)
 
virtual CRef< CTaxon3_replySendRequest (const CTaxon3_request &request)
 
virtual const stringGetLastError () const
 
- Public Member Functions inherited from ITaxon3
virtual ~ITaxon3 ()
 

Private Member Functions

void SetLastError (const char *err_msg)
 

Private Attributes

ESerialDataFormat m_eDataFormat
 
string m_sService
 
const STimeoutm_timeout
 
STimeout m_timeout_value
 
unsigned m_nReconnectAttempts
 
bool m_exponential { false }
 
string m_sLastError
 

Detailed Description

Definition at line 57 of file taxon3.hpp.

Member Enumeration Documentation

◆ initialize

enum CTaxon3::initialize
strong
Enumerator
yes 
no 

Definition at line 60 of file taxon3.hpp.

Constructor & Destructor Documentation

◆ CTaxon3() [1/2]

CTaxon3::CTaxon3 ( initialize  init = initialize::no)

Definition at line 55 of file taxon3.cpp.

References Init(), init(), and yes.

◆ CTaxon3() [2/2]

CTaxon3::CTaxon3 ( const STimeout timeout,
unsigned  reconnect_attempts = 5,
bool  exponential = false 
)

Definition at line 62 of file taxon3.cpp.

References Init().

◆ ~CTaxon3()

CTaxon3::~CTaxon3 ( )
virtual

Definition at line 68 of file taxon3.cpp.

Member Function Documentation

◆ GetLastError()

virtual const string& CTaxon3::GetLastError ( void  ) const
inlinevirtual

Implements ITaxon3.

Definition at line 96 of file taxon3.hpp.

References m_sLastError.

◆ Init() [1/2]

void CTaxon3::Init ( void  )
virtual

◆ Init() [2/2]

void CTaxon3::Init ( const STimeout timeout,
unsigned  reconnect_attempts = 5 
)
virtual

◆ SendNameList()

CRef< CTaxon3_reply > CTaxon3::SendNameList ( const vector< std::string > &  list,
COrg_ref::fOrgref_parts  parts = (COrg_ref::eOrgref_taxname |                                                                                COrg_ref::eOrgref_db_taxid),
fT3reply_parts  t3parts = (eT3reply_org|eT3reply_status) 
)
virtual

◆ SendOrgRefList()

CRef< CTaxon3_reply > CTaxon3::SendOrgRefList ( const vector< CRef< COrg_ref > > &  list,
COrg_ref::fOrgref_parts  result_parts = COrg_ref::eOrgref_default,
fT3reply_parts  t3result_parts = eT3reply_default 
)
virtual

◆ SendRequest()

CRef< CTaxon3_reply > CTaxon3::SendRequest ( const CTaxon3_request request)
virtual

◆ SendTaxidList()

CRef< CTaxon3_reply > CTaxon3::SendTaxidList ( const vector< TTaxId > &  list,
COrg_ref::fOrgref_parts  parts = (COrg_ref::eOrgref_taxname |                                                                                 COrg_ref::eOrgref_db_taxid),
fT3reply_parts  t3parts = eT3reply_org 
)
virtual

◆ SetLastError()

void CTaxon3::SetLastError ( const char *  err_msg)
private

Definition at line 181 of file taxon3.cpp.

References m_sLastError.

Referenced by Init(), and SendRequest().

Member Data Documentation

◆ m_eDataFormat

ESerialDataFormat CTaxon3::m_eDataFormat
private

Definition at line 100 of file taxon3.hpp.

Referenced by Init(), and SendRequest().

◆ m_exponential

bool CTaxon3::m_exponential { false }
private

Definition at line 106 of file taxon3.hpp.

Referenced by SendRequest().

◆ m_nReconnectAttempts

unsigned CTaxon3::m_nReconnectAttempts
private

Definition at line 105 of file taxon3.hpp.

Referenced by Init(), and SendRequest().

◆ m_sLastError

string CTaxon3::m_sLastError
private

Definition at line 108 of file taxon3.hpp.

Referenced by GetLastError(), and SetLastError().

◆ m_sService

string CTaxon3::m_sService
private

Definition at line 101 of file taxon3.hpp.

Referenced by Init(), and SendRequest().

◆ m_timeout

const STimeout* CTaxon3::m_timeout
private

Definition at line 102 of file taxon3.hpp.

Referenced by Init(), and SendRequest().

◆ m_timeout_value

STimeout CTaxon3::m_timeout_value
private

Definition at line 103 of file taxon3.hpp.

Referenced by Init(), and SendRequest().


The documentation for this class was generated from the following files:
Modified on Mon Jul 22 05:03:16 2024 by modify_doxy.py rev. 669887