ITaxon3 Class Reference

Search Toolkit Book for ITaxon3

#include <objects/taxon3/itaxon3.hpp>

Inheritance diagram for ITaxon3:

Public Types
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
virtual	~ITaxon3 ()
virtual void	Init ()=0
virtual void	Init (const STimeout *timeout, unsigned reconnect_attempts=5)=0
virtual CRef< CTaxon3_reply >	SendOrgRefList (const vector< CRef< COrg_ref > > &list, COrg_ref::fOrgref_parts result_parts=COrg_ref::eOrgref_default, fT3reply_parts t3result_parts=eT3reply_default)=0
virtual CRef< CTaxon3_reply >	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))=0
virtual CRef< CTaxon3_reply >	SendTaxidList (const vector< TTaxId > &list, COrg_ref::fOrgref_parts parts=(COrg_ref::eOrgref_taxname|COrg_ref::eOrgref_db_taxid), fT3reply_parts t3parts=eT3reply_org)=0
virtual CRef< CTaxon3_reply >	SendRequest (const CTaxon3_request &request)=0
virtual const string &	GetLastError () const =0

Detailed Description

Definition at line 62 of file itaxon3.hpp.

Member Typedef Documentation

fT3reply_parts

typedef unsigned int ITaxon3::fT3reply_parts

Definition at line 85 of file itaxon3.hpp.

Member Enumeration Documentation

ETaxon3_reply_part

enum ITaxon3::ETaxon3_reply_part

Enumerator
eT3reply_nothing
eT3reply_org
eT3reply_blast_lin
eT3reply_status
eT3reply_refresh
eT3reply_all
eT3reply_default

Definition at line 75 of file itaxon3.hpp.

Constructor & Destructor Documentation

~ITaxon3()

virtual ITaxon3::~ITaxon3 ( )

inlinevirtual

Definition at line 65 of file itaxon3.hpp.

Member Function Documentation

GetLastError()

virtual const string& ITaxon3::GetLastError ( ) const

pure virtual

Implemented in CMockTaxon, CMockTaxon, CTaxon3, and CCachedTaxon3.

Init() [1/2]

virtual void ITaxon3::Init ( )

pure virtual

Implemented in CMockTaxon, CMockTaxon, CCachedTaxon3, and CTaxon3.

Init() [2/2]

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

pure virtual

Implemented in CTaxon3, CCachedTaxon3, CMockTaxon, and CMockTaxon.

SendNameList()

virtual CRef< CTaxon3_reply > ITaxon3::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)  )

pure virtual

Implemented in CMockTaxon, and CTaxon3.

SendOrgRefList()

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

pure virtual

Implemented in CMockTaxon, and CTaxon3.

SendRequest()

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

pure virtual

Implemented in CMockTaxon, CMockTaxon, CTaxon3, and CCachedTaxon3.

Referenced by CCachedTaxon3::SendRequest(), and CCachedTaxon3::x_AddReplyToCache().

SendTaxidList()

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

pure virtual

Implemented in CMockTaxon, and CTaxon3.

---

The documentation for this class was generated from the following file:

• include/objects/taxon3/itaxon3.hpp