NCBI C++ ToolKit
Classes | Typedefs | Enumerations | Enumerator | Functions | Variables
EUtils

Classes

class  CEFetch_Request
 CEFetch_Request. More...
 
class  CEFetch_Literature_Request
 CEFetch_Literature_Request. More...
 
class  CEFetch_Sequence_Request
 CEFetch_Sequence_Request. More...
 
class  CEFetch_Taxonomy_Request
 CEFetch_Taxonomy_Request. More...
 
class  CEGQuery_Request
 CEGQuery_Request. More...
 
class  CEHistory_Request
 CEHistory_Request. More...
 
class  CEInfo_Request
 CEInfo_Request. More...
 
class  CELink_Request
 CELink_Request. More...
 
class  CEPost_Request
 CEPost_Request. More...
 
class  CESearch_Request
 CESearch_Request. More...
 
class  CESpell_Request
 CESpell_Request. More...
 
class  CESummary_Request
 CESummary_Request. More...
 
class  CEUtils_ConnContext
 CEUtils_ConnContext. More...
 
class  CEUtils_Request
 CEUtils_Request. More...
 
class  CEUtils_IdGroup
 CEUtils_IdGroup. More...
 
class  CEUtils_IdGroupSet
 CEUtils_IdGroupSet. More...
 

Typedefs

typedef CEUtils_Request CEFetch_Request::TParent
 
typedef CEFetch_Request CEFetch_Literature_Request::TParent
 
typedef CEFetch_Request CEFetch_Sequence_Request::TParent
 
typedef CEFetch_Request CEFetch_Taxonomy_Request::TParent
 
typedef CEUtils_Request CEGQuery_Request::TParent
 
typedef CEUtils_Request CEHistory_Request::TParent
 
typedef CEUtils_Request CELink_Request::TParent
 
typedef CEUtils_Request CEPost_Request::TParent
 
typedef CEUtils_Request CESearch_Request::TParent
 
typedef CEUtils_Request CESpell_Request::TParent
 
typedef CEUtils_Request CESummary_Request::TParent
 
typedef map< string, stringCEUtils_Request::TRequestArgs
 
typedef vector< stringCEUtils_IdGroup::TIdList
 
typedef vector< CEUtils_IdGroupCEUtils_IdGroupSet::TIdGroupSet
 

Enumerations

enum  CEFetch_Request::ERetMode {
  CEFetch_Request::eRetMode_none = 0 , CEFetch_Request::eRetMode_xml , CEFetch_Request::eRetMode_html , CEFetch_Request::eRetMode_text ,
  CEFetch_Request::eRetMode_asn
}
 Output format for efetch requests. More...
 
enum  CEFetch_Literature_Request::ELiteratureDB { CEFetch_Literature_Request::eDB_pubmed = 0 , CEFetch_Literature_Request::eDB_pmc , CEFetch_Literature_Request::eDB_journals , CEFetch_Literature_Request::eDB_omim }
 Literature databases. More...
 
enum  CEFetch_Literature_Request::ERetType {
  CEFetch_Literature_Request::eRetType_none = 0 , CEFetch_Literature_Request::eRetType_uilist , CEFetch_Literature_Request::eRetType_abstract , CEFetch_Literature_Request::eRetType_citation ,
  CEFetch_Literature_Request::eRetType_medline , CEFetch_Literature_Request::eRetType_full
}
 Output types based on database. More...
 
enum  CEFetch_Sequence_Request::ESequenceDB {
  CEFetch_Sequence_Request::eDB_gene = 0 , CEFetch_Sequence_Request::eDB_genome , CEFetch_Sequence_Request::eDB_nucleotide , CEFetch_Sequence_Request::eDB_nuccore ,
  CEFetch_Sequence_Request::eDB_nucest , CEFetch_Sequence_Request::eDB_nucgss , CEFetch_Sequence_Request::eDB_protein , CEFetch_Sequence_Request::eDB_popset ,
  CEFetch_Sequence_Request::eDB_snp , CEFetch_Sequence_Request::eDB_sequences
}
 Sequence databases. More...
 
enum  CEFetch_Sequence_Request::ERetType {
  CEFetch_Sequence_Request::eRetType_none = 0 , CEFetch_Sequence_Request::eRetType_native , CEFetch_Sequence_Request::eRetType_fasta , CEFetch_Sequence_Request::eRetType_gb ,
  CEFetch_Sequence_Request::eRetType_gbc , CEFetch_Sequence_Request::eRetType_gbwithparts , CEFetch_Sequence_Request::eRetType_est , CEFetch_Sequence_Request::eRetType_gss ,
  CEFetch_Sequence_Request::eRetType_gp , CEFetch_Sequence_Request::eRetType_gpc , CEFetch_Sequence_Request::eRetType_seqid , CEFetch_Sequence_Request::eRetType_acc ,
  CEFetch_Sequence_Request::eRetType_chr , CEFetch_Sequence_Request::eRetType_flt , CEFetch_Sequence_Request::eRetType_rsr , CEFetch_Sequence_Request::eRetType_brief ,
  CEFetch_Sequence_Request::eRetType_docset
}
 Output types based on database. More...
 
enum  CEFetch_Sequence_Request::EStrand { CEFetch_Sequence_Request::eStrand_none = 0 , CEFetch_Sequence_Request::eStrand_plus = 1 , CEFetch_Sequence_Request::eStrand_minus = 2 }
 Strand of DNA to show. More...
 
enum  CEFetch_Sequence_Request::EComplexity {
  CEFetch_Sequence_Request::eComplexity_none = -1 , CEFetch_Sequence_Request::eComplexity_WholeBlob = 0 , CEFetch_Sequence_Request::eComplexity_Bioseq = 1 , CEFetch_Sequence_Request::eComplexity_BioseqSet = 2 ,
  CEFetch_Sequence_Request::eComplexity_NucProt = 3 , CEFetch_Sequence_Request::eComplexity_PubSet = 4
}
 Complexity level. More...
 
enum  CEFetch_Taxonomy_Request::EReport {
  CEFetch_Taxonomy_Request::eReport_none = 0 , CEFetch_Taxonomy_Request::eReport_uilist , CEFetch_Taxonomy_Request::eReport_brief , CEFetch_Taxonomy_Request::eReport_docsum ,
  CEFetch_Taxonomy_Request::eReport_xml
}
 Output data format. More...
 
enum  CELink_Request::ERetMode { CELink_Request::eRetMode_none , CELink_Request::eRetMode_xml , CELink_Request::eRetMode_ref }
 Output data types. More...
 
enum  CELink_Request::ECommand {
  CELink_Request::eCmd_none , CELink_Request::eCmd_prlinks , CELink_Request::eCmd_llinks , CELink_Request::eCmd_llinkslib ,
  CELink_Request::eCmd_lcheck , CELink_Request::eCmd_ncheck , CELink_Request::eCmd_neighbor , CELink_Request::eCmd_neighbor_score ,
  CELink_Request::eCmd_neighbor_history , CELink_Request::eCmd_acheck
}
 ELink commands. More...
 
enum  CESearch_Request::ERetType { CESearch_Request::eRetType_none , CESearch_Request::eRetType_count , CESearch_Request::eRetType_uilist }
 Output data types. More...
 
enum  CESearch_Request::ESort {
  CESearch_Request::eSort_none , CESearch_Request::eSort_author , CESearch_Request::eSort_last_author , CESearch_Request::eSort_journal ,
  CESearch_Request::eSort_pub_date
}
 Sort orders. More...
 
enum  CEUtils_Request::ERequestMethod { CEUtils_Request::eHttp_Post , CEUtils_Request::eHttp_Get }
 HTTP method used to send request. More...
 

Functions

 CEFetch_Request::CEFetch_Request (CRef< CEUtils_ConnContext > &ctx)
 
virtual CEFetch_Request::~CEFetch_Request (void)
 
virtual string CEFetch_Request::GetQueryString (void) const
 Get CGI script query string. More...
 
const CEUtils_IdGroupCEFetch_Request::GetId (void) const
 Group of ids to retrieve. More...
 
CEUtils_IdGroupCEFetch_Request::GetId (void)
 
int CEFetch_Request::GetRetStart (void) const
 Sequential number of the first id retrieved. More...
 
void CEFetch_Request::SetRetStart (int retstart)
 
int CEFetch_Request::GetRetMax (void) const
 Number of items retrieved, default is 20, maximum is 10,000. More...
 
void CEFetch_Request::SetRetMax (int retmax)
 
ERetMode CEFetch_Request::GetRetMode (void) const
 Output format. More...
 
void CEFetch_Request::SetRetMode (ERetMode retmode)
 
virtual ESerialDataFormat CEFetch_Request::GetSerialDataFormat (void) const
 Get serial stream format for reading data. More...
 
virtual CRef< uilist::CIdList > CEFetch_Request::FetchIdList (int chunk_size)
 Get IdList using the currently set DB, WebEnv, retstart, retmax etc. More...
 
const char * CEFetch_Request::x_GetRetModeName (void) const
 
 CEFetch_Literature_Request::CEFetch_Literature_Request (ELiteratureDB db, CRef< CEUtils_ConnContext > &ctx)
 
ERetType CEFetch_Literature_Request::GetRetType (void) const
 Output data type. More...
 
void CEFetch_Literature_Request::SetRetType (ERetType rettype)
 
virtual string CEFetch_Literature_Request::GetQueryString (void) const
 Get CGI script query string. More...
 
virtual CRef< uilist::CIdList > CEFetch_Literature_Request::FetchIdList (int chunk_size)
 Get IdList using the currently set DB, WebEnv, retstart, retmax etc. More...
 
const char * CEFetch_Literature_Request::x_GetRetTypeName (void) const
 
 CEFetch_Sequence_Request::CEFetch_Sequence_Request (ESequenceDB db, CRef< CEUtils_ConnContext > &ctx)
 
ERetType CEFetch_Sequence_Request::GetRetType (void) const
 Output data type. More...
 
void CEFetch_Sequence_Request::SetRetType (ERetType rettype)
 
EStrand CEFetch_Sequence_Request::GetStrand (void) const
 Strand of DNA to show. More...
 
void CEFetch_Sequence_Request::SetStrand (EStrand strand)
 
int CEFetch_Sequence_Request::GetSeqStart (void) const
 Show sequence starting from this base number. More...
 
void CEFetch_Sequence_Request::SetSeqStart (int pos)
 
int CEFetch_Sequence_Request::GetSeqStop (void) const
 Show sequence ending on this base number. More...
 
void CEFetch_Sequence_Request::SetSeqStop (int pos)
 
EComplexity CEFetch_Sequence_Request::GetComplexity (void) const
 Complexity level of the output data. More...
 
void CEFetch_Sequence_Request::SetComplexity (EComplexity complexity)
 
virtual string CEFetch_Sequence_Request::GetQueryString (void) const
 Get CGI script query string. More...
 
const char * CEFetch_Sequence_Request::x_GetRetTypeName (void) const
 
 CEFetch_Taxonomy_Request::CEFetch_Taxonomy_Request (CRef< CEUtils_ConnContext > &ctx)
 
EReport CEFetch_Taxonomy_Request::GetReport (void) const
 Output data format. More...
 
void CEFetch_Taxonomy_Request::SetReport (EReport report)
 
virtual string CEFetch_Taxonomy_Request::GetQueryString (void) const
 Get CGI script query string. More...
 
virtual CRef< uilist::CIdList > CEFetch_Taxonomy_Request::FetchIdList (int chunk_size)
 Get IdList using the currently set DB, WebEnv, retstart, retmax etc. More...
 
const char * CEFetch_Taxonomy_Request::x_GetReportName (void) const
 
 CEGQuery_Request::CEGQuery_Request (CRef< CEUtils_ConnContext > &ctx)
 Create EGQuery request for the given database. More...
 
virtual CEGQuery_Request::~CEGQuery_Request (void)
 
virtual string CEGQuery_Request::GetQueryString (void) const
 Get CGI script query string. More...
 
virtual ESerialDataFormat CEGQuery_Request::GetSerialDataFormat (void) const
 Get serial stream format for reading data. More...
 
CRef< egquery::CResult > CEGQuery_Request::GetResult (void)
 Get search results. More...
 
const stringCEGQuery_Request::GetTerm (void) const
 Search term. More...
 
void CEGQuery_Request::SetTerm (const string &term)
 
 CEHistory_Request::CEHistory_Request (const string &db, CRef< CEUtils_ConnContext > &ctx)
 Create EHistory request for the given database. More...
 
virtual CEHistory_Request::~CEHistory_Request (void)
 
virtual ESerialDataFormat CEHistory_Request::GetSerialDataFormat (void) const
 Get serial stream format for reading data. More...
 
CRef< ehistory::CEHistoryResult > CEHistory_Request::GetEHistoryResult (void)
 Get request history. More...
 
 CEInfo_Request::CEInfo_Request (const string &db, CRef< CEUtils_ConnContext > &ctx)
 Create EInfo request for the given database. More...
 
virtual CEInfo_Request::~CEInfo_Request (void)
 
virtual ESerialDataFormat CEInfo_Request::GetSerialDataFormat (void) const
 Get serial stream format for reading data. More...
 
CRef< einfo::CEInfoResult > CEInfo_Request::GetEInfoResult (void)
 Get result. More...
 
 CELink_Request::CELink_Request (const string &db, CRef< CEUtils_ConnContext > &ctx)
 Create ELink request for the given destination database. More...
 
virtual CELink_Request::~CELink_Request (void)
 
virtual string CELink_Request::GetQueryString (void) const
 Get CGI script query string. More...
 
virtual ESerialDataFormat CELink_Request::GetSerialDataFormat (void) const
 Get serial stream format for reading data. More...
 
CRef< elink::CELinkResult > CELink_Request::GetELinkResult (void)
 Get search result. More...
 
const stringCELink_Request::GetDbFrom (void) const
 Origination database. More...
 
void CELink_Request::SetDbFrom (const string &dbfrom)
 
const CEUtils_IdGroupSetCELink_Request::GetIdGroups (void) const
 Multiple ID groups. More...
 
CEUtils_IdGroupSetCELink_Request::GetIdGroups (void)
 
const stringCELink_Request::GetTerm (void) const
 Search term. More...
 
void CELink_Request::SetTerm (const string &term)
 
int CELink_Request::GetRelDate (void) const
 Relative date to start search with, in days. More...
 
void CELink_Request::SetRelDate (int days)
 
const CTimeCELink_Request::GetMinDate (void) const
 Min date. Both min and max date must be set. More...
 
void CELink_Request::SetMinDate (const CTime &date)
 
const CTimeCELink_Request::GetMaxDate (void) const
 Max date. Both min and max date must be set. More...
 
void CELink_Request::SetMaxDate (const CTime &date)
 
const stringCELink_Request::GetDateType (void) const
 Limit dates to a specific date field based on database (e.g. More...
 
void CELink_Request::SetDateType (const string &type)
 
ERetMode CELink_Request::GetRetMode (void) const
 Output data type. More...
 
void CELink_Request::SetRetMode (ERetMode retmode)
 
ECommand CELink_Request::GetCommand (void) const
 
void CELink_Request::SetCommand (ECommand cmd)
 
const stringCELink_Request::GetLinkName (void) const
 Link to a specific neighbor subset. More...
 
void CELink_Request::SetLinkName (const string &linkname)
 
const stringCELink_Request::GetHolding (void) const
 List LinkOut URLs for the specified holding provider. More...
 
void CELink_Request::SetHolding (const string &holding)
 
const stringCELink_Request::GetVersion (void) const
 Latest DTD version. More...
 
void CELink_Request::SetVersion (const string &version)
 
const char * CELink_Request::x_GetRetModeName (void) const
 
const char * CELink_Request::x_GetCommandName (void) const
 
 CEPost_Request::CEPost_Request (const string &db, CRef< CEUtils_ConnContext > &ctx)
 Create EPost request for the given database. More...
 
virtual CEPost_Request::~CEPost_Request (void)
 
virtual string CEPost_Request::GetQueryString (void) const
 Get CGI script query string. More...
 
virtual ESerialDataFormat CEPost_Request::GetSerialDataFormat (void) const
 Get serial stream format for reading data. More...
 
CRef< epost::CEPostResult > CEPost_Request::GetEPostResult (void)
 Get search results. More...
 
const CEUtils_IdGroupCEPost_Request::GetId (void) const
 Group of ids to be added to the search history. More...
 
CEUtils_IdGroupCEPost_Request::GetId (void)
 
 CESearch_Request::CESearch_Request (const string &db, CRef< CEUtils_ConnContext > &ctx)
 Create ESearch request for the given database. More...
 
virtual CESearch_Request::~CESearch_Request (void)
 
virtual string CESearch_Request::GetQueryString (void) const
 Get CGI script query string. More...
 
virtual ESerialDataFormat CESearch_Request::GetSerialDataFormat (void) const
 Get serial stream format for reading data. More...
 
CRef< esearch::CESearchResult > CESearch_Request::GetESearchResult (void)
 Get search results. More...
 
bool CESearch_Request::GetUseHistory (void) const
 History update flag, on by default. More...
 
void CESearch_Request::SetUseHistory (bool value)
 
const stringCESearch_Request::GetTerm (void) const
 Search term. More...
 
void CESearch_Request::SetTerm (const string &term)
 
const stringCESearch_Request::GetField (void) const
 Search field. More...
 
void CESearch_Request::SetField (const string &field)
 
int CESearch_Request::GetRelDate (void) const
 Relative date to start search with, in days. More...
 
void CESearch_Request::SetRelDate (int days)
 
const CTimeCESearch_Request::GetMinDate (void) const
 Min date. Both min and max date must be set. More...
 
void CESearch_Request::SetMinDate (const CTime &date)
 
const CTimeCESearch_Request::GetMaxDate (void) const
 Max date. Both min and max date must be set. More...
 
void CESearch_Request::SetMaxDate (const CTime &date)
 
const stringCESearch_Request::GetDateType (void) const
 Limit dates to a specific date field (e.g. edat, mdat). More...
 
void CESearch_Request::SetDateType (const string &type)
 
int CESearch_Request::GetRetStart (void) const
 Sequential number of the first id retrieved. More...
 
void CESearch_Request::SetRetStart (int retstart)
 
int CESearch_Request::GetRetMax (void) const
 Number of items retrieved. More...
 
void CESearch_Request::SetRetMax (int retmax)
 
ERetType CESearch_Request::GetRetType (void) const
 Output data type. More...
 
void CESearch_Request::SetRetType (ERetType rettype)
 
ESort CESearch_Request::GetSort (void) const
 Get sort order. More...
 
void CESearch_Request::SetSort (ESort order)
 Set sort order. More...
 
const stringCESearch_Request::GetSortOrderName (void) const
 Get sort order. Empty string indicates no sorting (or the default one). More...
 
void CESearch_Request::SetSortOrderName (CTempString name)
 Set sort order. Empty string indicates no sorting (or the default one). More...
 
const char * CESearch_Request::x_GetRetTypeName (void) const
 
 CESpell_Request::CESpell_Request (const string &db, CRef< CEUtils_ConnContext > &ctx)
 Create ESpell request for the given database. More...
 
virtual CESpell_Request::~CESpell_Request (void)
 
virtual string CESpell_Request::GetQueryString (void) const
 Get CGI script query string. More...
 
virtual ESerialDataFormat CESpell_Request::GetSerialDataFormat (void) const
 Get serial stream format for reading data. More...
 
CRef< espell::CESpellResult > CESpell_Request::GetESpellResult (void)
 Get search results. More...
 
const stringCESpell_Request::GetTerm (void) const
 Search term. More...
 
void CESpell_Request::SetTerm (const string &term)
 
 CESummary_Request::CESummary_Request (const string &db, CRef< CEUtils_ConnContext > &ctx)
 Create ESummary request for the given database. More...
 
virtual CESummary_Request::~CESummary_Request (void)
 
virtual string CESummary_Request::GetQueryString (void) const
 Get CGI script query string. More...
 
virtual ESerialDataFormat CESummary_Request::GetSerialDataFormat (void) const
 Get serial stream format for reading data. More...
 
const CEUtils_IdGroupCESummary_Request::GetId (void) const
 Group of ids required if history is not used. More...
 
CEUtils_IdGroupCESummary_Request::GetId (void)
 
int CESummary_Request::GetRetStart (void) const
 Sequential number of the first id retrieved. More...
 
void CESummary_Request::SetRetStart (int retstart)
 
int CESummary_Request::GetRetMax (void) const
 Number of items retrieved. More...
 
void CESummary_Request::SetRetMax (int retmax)
 
CRef< esummary::CESummaryResult > CESummary_Request::GetESummaryResult (void)
 Get search result. More...
 
 CEUtils_ConnContext::CEUtils_ConnContext (void)
 
virtual CEUtils_ConnContext::~CEUtils_ConnContext (void)
 
const CTimeoutCEUtils_ConnContext::GetTimeout (void) const
 Get timeout. More...
 
void CEUtils_ConnContext::SetTimeout (const CTimeout &tmo)
 Set timeout. More...
 
const stringCEUtils_ConnContext::GetWebEnv (void) const
 Get WebEnv. More...
 
void CEUtils_ConnContext::SetWebEnv (const string &webenv)
 Set WebEnv. More...
 
const stringCEUtils_ConnContext::GetQueryKey (void) const
 Get query_key. More...
 
void CEUtils_ConnContext::SetQueryKey (const string &query_key)
 Set query_key. More...
 
const stringCEUtils_ConnContext::GetTool (void) const
 A string with no internal spaces that identifies the resource which is using Entrez links (optional). More...
 
void CEUtils_ConnContext::SetTool (const string &tool)
 
const stringCEUtils_ConnContext::GetEmail (void) const
 Optional contact e-mail. More...
 
void CEUtils_ConnContext::SetEmail (const string &email)
 
void CEUtils_ConnContext::SetSendQueryKey (bool value)
 Set SendQueryKey flag. More...
 
bool CEUtils_ConnContext::GetSendQueryKey (void) const
 
 CEUtils_Request::CEUtils_Request (CRef< CEUtils_ConnContext > &ctx, const string &script_name)
 Create request. More...
 
virtual CEUtils_Request::~CEUtils_Request (void)
 
const stringCEUtils_Request::GetScriptName (void) const
 Get CGI script name (e.g. efetch.fcgi). More...
 
virtual string CEUtils_Request::GetQueryString (void) const
 Get CGI script query string. More...
 
virtual ESerialDataFormat CEUtils_Request::GetSerialDataFormat (void) const
 Get serial stream format for reading data. More...
 
CRef< CEUtils_ConnContext > & CEUtils_Request::GetConnContext (void) const
 Get current request context. More...
 
void CEUtils_Request::SetConnContext (const CRef< CEUtils_ConnContext > &ctx)
 Set new request context. More...
 
void CEUtils_Request::Connect (void)
 Open connection, create the stream. More...
 
void CEUtils_Request::Disconnect (void)
 Close connection, destroy the stream. More...
 
CNcbiIostreamCEUtils_Request::GetStream (void)
 Get input stream for reading plain data. More...
 
CObjectIStreamCEUtils_Request::GetObjectIStream (void)
 Get serial stream for reading xml or asn data. More...
 
void CEUtils_Request::Read (string *content)
 Read the whole stream into the string. More...
 
const stringCEUtils_Request::GetDatabase (void) const
 Database (usually set by each specific request class). More...
 
void CEUtils_Request::SetDatabase (const string &database)
 Setting new database disconnects the request. More...
 
const stringCEUtils_Request::GetQueryKey (void) const
 Read query_key value from the request or from the connection context. More...
 
void CEUtils_Request::SetQueryKey (const string &key)
 Override query_key stored in the connection context. More...
 
void CEUtils_Request::ResetQueryKey (void)
 Reset requests's query_key, use the one from the connectiono context. More...
 
void CEUtils_Request::SetArgument (const string &name, const string &value)
 Add/change custom argument. Remove the argument if the value is empty. More...
 
const stringCEUtils_Request::GetArgument (const string &name) const
 Get argument by name. More...
 
ERequestMethod CEUtils_Request::GetRequestMethod (void) const
 Get HTTP method. More...
 
void CEUtils_Request::SetRequestMethod (ERequestMethod method)
 Set HTTP method. More...
 
static const stringCEUtils_Request::GetBaseURL (void)
 Get base url for all e-utils requests. More...
 
static void CEUtils_Request::SetBaseURL (const string &url)
 Set new base url for all e-utils requests. More...
 
static void CEUtils_Request::ResetBaseURL (void)
 Reset cached base url so that it's refreshed on next request. More...
 
CObjectIStreamCEUtils_Request::GetObjIStream (void)
 Get serial stream for reading xml or asn data. More...
 
 CEUtils_Request::CEUtils_Request (const CEUtils_Request &)
 
CEUtils_RequestCEUtils_Request::operator= (const CEUtils_Request &)
 
 CEUtils_IdGroup::CEUtils_IdGroup (void)
 
 CEUtils_IdGroup::~CEUtils_IdGroup (void)
 
void CEUtils_IdGroup::AddId (const string &id)
 Add a single id to the list. More...
 
const TIdListCEUtils_IdGroup::GetIds (void) const
 Get read-only list of ids. More...
 
TIdListCEUtils_IdGroup::GetIds (void)
 Get non-const list of ids. More...
 
void CEUtils_IdGroup::SetIds (const string &ids)
 Parse all ids from a string (e.g. 'id=123,456,78'). More...
 
string CEUtils_IdGroup::AsQueryString (void) const
 Get a formatted list of ids (e.g. 'id=123,456,78'). More...
 
 CEUtils_IdGroupSet::CEUtils_IdGroupSet (void)
 
 CEUtils_IdGroupSet::~CEUtils_IdGroupSet (void)
 
void CEUtils_IdGroupSet::AddGroup (const CEUtils_IdGroup &group)
 Add a group of ids. More...
 
const TIdGroupSetCEUtils_IdGroupSet::GetGroups (void) const
 Get read-only list of groups. More...
 
TIdGroupSetCEUtils_IdGroupSet::GetGroups (void)
 Get non-const list of groups. More...
 
void CEUtils_IdGroupSet::SetGroups (const string &groups)
 Parse a set of id groups from a single string ('id=12,34&id=56,78'). More...
 
string CEUtils_IdGroupSet::AsQueryString (void) const
 Return a formatted list of groups ('id=12,34&id=56,78'). More...
 

Variables

CEUtils_IdGroup CEFetch_Request::m_Id
 
int CEFetch_Request::m_RetStart
 
int CEFetch_Request::m_RetMax
 
ERetMode CEFetch_Request::m_RetMode
 
ERetType CEFetch_Literature_Request::m_RetType
 
ERetType CEFetch_Sequence_Request::m_RetType
 
EComplexity CEFetch_Sequence_Request::m_Complexity
 
EStrand CEFetch_Sequence_Request::m_Strand
 
int CEFetch_Sequence_Request::m_SeqStart
 
int CEFetch_Sequence_Request::m_SeqStop
 
EReport CEFetch_Taxonomy_Request::m_Report
 
string CEGQuery_Request::m_Term
 
string CELink_Request::m_DbFrom
 
CEUtils_IdGroupSet CELink_Request::m_IdGroups
 
string CELink_Request::m_Term
 
int CELink_Request::m_RelDate
 
CTime CELink_Request::m_MinDate
 
CTime CELink_Request::m_MaxDate
 
string CELink_Request::m_DateType
 
ERetMode CELink_Request::m_RetMode
 
ECommand CELink_Request::m_Cmd
 
string CELink_Request::m_LinkName
 
string CELink_Request::m_Holding
 
string CELink_Request::m_Version
 
CEUtils_IdGroup CEPost_Request::m_Id
 
bool CESearch_Request::m_UseHistory
 
string CESearch_Request::m_Term
 
string CESearch_Request::m_Field
 
int CESearch_Request::m_RelDate
 
CTime CESearch_Request::m_MinDate
 
CTime CESearch_Request::m_MaxDate
 
string CESearch_Request::m_DateType
 
int CESearch_Request::m_RetStart
 
int CESearch_Request::m_RetMax
 
ERetType CESearch_Request::m_RetType
 
ESort CESearch_Request::m_Sort
 
string CESearch_Request::m_SortName
 
string CESpell_Request::m_Term
 
CEUtils_IdGroup CESummary_Request::m_Id
 
int CESummary_Request::m_RetStart
 
int CESummary_Request::m_RetMax
 
CTimeout CEUtils_ConnContext::m_Timeout
 
string CEUtils_ConnContext::m_WebEnv
 
string CEUtils_ConnContext::m_QueryKey
 
string CEUtils_ConnContext::m_Tool
 
string CEUtils_ConnContext::m_Email
 
bool CEUtils_ConnContext::m_SendQueryKey = true
 
CRef< CEUtils_ConnContextCEUtils_Request::m_Context
 
unique_ptr< CConn_HttpStreamCEUtils_Request::m_Stream
 
unique_ptr< CObjectIStreamCEUtils_Request::m_ObjStream
 
string CEUtils_Request::m_ScriptName
 
string CEUtils_Request::m_QueryKey
 
string CEUtils_Request::m_Database
 
TRequestArgs CEUtils_Request::m_Args
 
ERequestMethod CEUtils_Request::m_Method
 
TIdList CEUtils_IdGroup::m_Ids
 
TIdGroupSet CEUtils_IdGroupSet::m_Groups
 

Detailed Description

Typedef Documentation

◆ TIdGroupSet

Definition at line 276 of file eutils.hpp.

◆ TIdList

Definition at line 241 of file eutils.hpp.

◆ TParent [1/11]

Definition at line 107 of file efetch.hpp.

◆ TParent [2/11]

Definition at line 163 of file efetch.hpp.

◆ TParent [3/11]

Definition at line 260 of file efetch.hpp.

◆ TParent [4/11]

Definition at line 308 of file efetch.hpp.

◆ TParent [5/11]

Definition at line 77 of file egquery.hpp.

◆ TParent [6/11]

Definition at line 74 of file ehistory.hpp.

◆ TParent [7/11]

Definition at line 149 of file elink.hpp.

◆ TParent [8/11]

Definition at line 80 of file epost.hpp.

◆ TParent [9/11]

Definition at line 144 of file esearch.hpp.

◆ TParent [10/11]

Definition at line 79 of file espell.hpp.

◆ TParent [11/11]

Definition at line 90 of file esummary.hpp.

◆ TRequestArgs

Definition at line 212 of file eutils.hpp.

Enumeration Type Documentation

◆ ECommand

ELink commands.

Enumerator
eCmd_none 
eCmd_prlinks 

Links to the primary provider.

eCmd_llinks 

LinkOut URLs, except PubMed libraries.

eCmd_llinkslib 

LinkOut URLs and Attributes.

eCmd_lcheck 

Check for the existence of external links.

eCmd_ncheck 

Check for the existence of neighbor links.

eCmd_neighbor 

Display neighbors within a database (default)

eCmd_neighbor_score 

Display neighbors within a database, with scores.

eCmd_neighbor_history 

Create history for use in other EUtils.

eCmd_acheck 

Entrez databases links.

Definition at line 115 of file elink.hpp.

◆ EComplexity

Complexity level.

Enumerator
eComplexity_none 
eComplexity_WholeBlob 

Get the whole blob.

eComplexity_Bioseq 

Get bioseq (default in Entrez)

eComplexity_BioseqSet 

Get the minimal bioseq-set.

eComplexity_NucProt 

Get the minimal nuc-prot.

eComplexity_PubSet 

Get the minimal pub-set.

Definition at line 242 of file efetch.hpp.

◆ ELiteratureDB

Literature databases.

Enumerator
eDB_pubmed 
eDB_pmc 
eDB_journals 
eDB_omim 

Definition at line 130 of file efetch.hpp.

◆ EReport

Output data format.

Enumerator
eReport_none 
eReport_uilist 
eReport_brief 
eReport_docsum 
eReport_xml 

Definition at line 286 of file efetch.hpp.

◆ ERequestMethod

HTTP method used to send request.

Enumerator
eHttp_Post 

Use POST (default)

eHttp_Get 

Use GET.

Definition at line 185 of file eutils.hpp.

◆ ERetMode [1/2]

Output format for efetch requests.

Enumerator
eRetMode_none 
eRetMode_xml 

Return data as XML.

eRetMode_html 

Return data as HTML.

eRetMode_text 

Return data as plain text.

eRetMode_asn 

Return data as text ASN.1.

Definition at line 81 of file efetch.hpp.

◆ ERetMode [2/2]

Output data types.

Enumerator
eRetMode_none 
eRetMode_xml 
eRetMode_ref 

Default mode is XML.

used only with cmd=prlinks

Definition at line 105 of file elink.hpp.

◆ ERetType [1/3]

Output types based on database.

Enumerator
eRetType_none 
eRetType_uilist 
eRetType_abstract 
eRetType_citation 
eRetType_medline 
eRetType_full 

Definition at line 140 of file efetch.hpp.

◆ ERetType [2/3]

Output types based on database.

Enumerator
eRetType_none 
eRetType_native 
eRetType_fasta 
eRetType_gb 
eRetType_gbc 
eRetType_gbwithparts 
eRetType_est 
eRetType_gss 
eRetType_gp 
eRetType_gpc 
eRetType_seqid 
eRetType_acc 
eRetType_chr 
eRetType_flt 
eRetType_rsr 
eRetType_brief 
eRetType_docset 

Definition at line 199 of file efetch.hpp.

◆ ERetType [3/3]

Output data types.

Enumerator
eRetType_none 
eRetType_count 
eRetType_uilist 

Definition at line 115 of file esearch.hpp.

◆ ESequenceDB

Sequence databases.

Enumerator
eDB_gene 
eDB_genome 
eDB_nucleotide 
eDB_nuccore 
eDB_nucest 
eDB_nucgss 
eDB_protein 
eDB_popset 
eDB_snp 
eDB_sequences 

Definition at line 183 of file efetch.hpp.

◆ ESort

Sort orders.

Deprecated:
Use string sort orders instead.
Enumerator
eSort_none 
eSort_author 
eSort_last_author 
eSort_journal 
eSort_pub_date 

Definition at line 126 of file esearch.hpp.

◆ EStrand

Strand of DNA to show.

Enumerator
eStrand_none 
eStrand_plus 
eStrand_minus 

Definition at line 224 of file efetch.hpp.

Function Documentation

◆ AddGroup()

void CEUtils_IdGroupSet::AddGroup ( const CEUtils_IdGroup group)
inline

Add a group of ids.

Definition at line 279 of file eutils.hpp.

References CEUtils_IdGroupSet::m_Groups.

◆ AddId()

void CEUtils_IdGroup::AddId ( const string id)
inline

Add a single id to the list.

Definition at line 244 of file eutils.hpp.

References CEUtils_IdGroup::m_Ids.

Referenced by s_GetObject(), fix_pub::s_IsIndexed(), and CEUtils_IdGroup::SetIds().

◆ AsQueryString() [1/2]

string CEUtils_IdGroup::AsQueryString ( void  ) const

Get a formatted list of ids (e.g. 'id=123,456,78').

Definition at line 312 of file eutils.cpp.

References NStr::eUrlEnc_ProcessMarkChars, ITERATE, CEUtils_IdGroup::m_Ids, and NStr::URLEncode().

Referenced by CEFetch_Request::GetQueryString(), CEPost_Request::GetQueryString(), and CESummary_Request::GetQueryString().

◆ AsQueryString() [2/2]

string CEUtils_IdGroupSet::AsQueryString ( void  ) const

Return a formatted list of groups ('id=12,34&id=56,78').

Definition at line 352 of file eutils.cpp.

References ITERATE, and CEUtils_IdGroupSet::m_Groups.

Referenced by CELink_Request::GetQueryString().

◆ CEFetch_Literature_Request()

CEFetch_Literature_Request::CEFetch_Literature_Request ( ELiteratureDB  db,
CRef< CEUtils_ConnContext > &  ctx 
)

Definition at line 146 of file efetch.cpp.

References CEUtils_Request::SetDatabase().

◆ CEFetch_Request()

CEFetch_Request::CEFetch_Request ( CRef< CEUtils_ConnContext > &  ctx)

Definition at line 41 of file efetch.cpp.

◆ CEFetch_Sequence_Request()

CEFetch_Sequence_Request::CEFetch_Sequence_Request ( ESequenceDB  db,
CRef< CEUtils_ConnContext > &  ctx 
)

Definition at line 188 of file efetch.cpp.

References CEUtils_Request::SetDatabase().

◆ CEFetch_Taxonomy_Request()

CEFetch_Taxonomy_Request::CEFetch_Taxonomy_Request ( CRef< CEUtils_ConnContext > &  ctx)

Definition at line 244 of file efetch.cpp.

References CEUtils_Request::SetDatabase().

◆ CEGQuery_Request()

CEGQuery_Request::CEGQuery_Request ( CRef< CEUtils_ConnContext > &  ctx)

Create EGQuery request for the given database.

Definition at line 41 of file egquery.cpp.

◆ CEHistory_Request()

CEHistory_Request::CEHistory_Request ( const string db,
CRef< CEUtils_ConnContext > &  ctx 
)

Create EHistory request for the given database.

If db is an empty string, the request will return histories for all databases.

Definition at line 40 of file ehistory.cpp.

References CEUtils_Request::SetDatabase().

◆ CEInfo_Request()

CEInfo_Request::CEInfo_Request ( const string db,
CRef< CEUtils_ConnContext > &  ctx 
)

Create EInfo request for the given database.

Definition at line 40 of file einfo.cpp.

References CEUtils_Request::SetDatabase().

◆ CELink_Request()

CELink_Request::CELink_Request ( const string db,
CRef< CEUtils_ConnContext > &  ctx 
)

Create ELink request for the given destination database.

Use "all" to retrieve links for all Entrez databases.

Definition at line 41 of file elink.cpp.

References CEUtils_Request::SetDatabase().

◆ CEPost_Request()

CEPost_Request::CEPost_Request ( const string db,
CRef< CEUtils_ConnContext > &  ctx 
)

Create EPost request for the given database.

Definition at line 41 of file epost.cpp.

References CEUtils_Request::SetDatabase().

◆ CESearch_Request()

CESearch_Request::CESearch_Request ( const string db,
CRef< CEUtils_ConnContext > &  ctx 
)

Create ESearch request for the given database.

Definition at line 41 of file esearch.cpp.

References CEUtils_Request::SetDatabase().

◆ CESpell_Request()

CESpell_Request::CESpell_Request ( const string db,
CRef< CEUtils_ConnContext > &  ctx 
)

Create ESpell request for the given database.

Definition at line 41 of file espell.cpp.

References CEUtils_Request::SetDatabase().

◆ CESummary_Request()

CESummary_Request::CESummary_Request ( const string db,
CRef< CEUtils_ConnContext > &  ctx 
)

Create ESummary request for the given database.

Definition at line 40 of file esummary.cpp.

References CEUtils_Request::SetDatabase().

◆ CEUtils_ConnContext()

CEUtils_ConnContext::CEUtils_ConnContext ( void  )

Definition at line 45 of file eutils.cpp.

◆ CEUtils_IdGroup()

CEUtils_IdGroup::CEUtils_IdGroup ( void  )
inline

Definition at line 238 of file eutils.hpp.

◆ CEUtils_IdGroupSet()

CEUtils_IdGroupSet::CEUtils_IdGroupSet ( void  )
inline

Definition at line 273 of file eutils.hpp.

◆ CEUtils_Request() [1/2]

CEUtils_Request::CEUtils_Request ( const CEUtils_Request )
private

◆ CEUtils_Request() [2/2]

CEUtils_Request::CEUtils_Request ( CRef< CEUtils_ConnContext > &  ctx,
const string script_name 
)

Create request.

If the context is NULL, a new empty context will be created for the request.

Definition at line 52 of file eutils.cpp.

◆ Connect()

void CEUtils_Request::Connect ( void  )

◆ Disconnect()

void CEUtils_Request::Disconnect ( void  )
inline

Close connection, destroy the stream.

Definition at line 149 of file eutils.hpp.

References CEUtils_Request::m_ObjStream, and CEUtils_Request::m_Stream.

Referenced by CEHistory_Request::GetEHistoryResult(), CEInfo_Request::GetEInfoResult(), CELink_Request::GetELinkResult(), CEPost_Request::GetEPostResult(), CESearch_Request::GetESearchResult(), CESpell_Request::GetESpellResult(), CESummary_Request::GetESummaryResult(), CEFetch_Request::GetId(), CEPost_Request::GetId(), CESummary_Request::GetId(), CELink_Request::GetIdGroups(), CEGQuery_Request::GetResult(), CEUtils_Request::Read(), CEUtils_Request::ResetQueryKey(), fix_pub::s_GetESearchIds(), fix_pub::s_IsIndexed(), CELink_Request::SetCommand(), CEFetch_Sequence_Request::SetComplexity(), CEUtils_Request::SetConnContext(), CEUtils_Request::SetDatabase(), CELink_Request::SetDateType(), CESearch_Request::SetDateType(), CELink_Request::SetDbFrom(), CESearch_Request::SetField(), CELink_Request::SetHolding(), CELink_Request::SetLinkName(), CELink_Request::SetMaxDate(), CESearch_Request::SetMaxDate(), CELink_Request::SetMinDate(), CESearch_Request::SetMinDate(), CEUtils_Request::SetQueryKey(), CELink_Request::SetRelDate(), CESearch_Request::SetRelDate(), CEFetch_Taxonomy_Request::SetReport(), CEFetch_Request::SetRetMax(), CESearch_Request::SetRetMax(), CESummary_Request::SetRetMax(), CEFetch_Request::SetRetMode(), CELink_Request::SetRetMode(), CEFetch_Request::SetRetStart(), CESearch_Request::SetRetStart(), CESummary_Request::SetRetStart(), CEFetch_Literature_Request::SetRetType(), CEFetch_Sequence_Request::SetRetType(), CESearch_Request::SetRetType(), CEFetch_Sequence_Request::SetSeqStart(), CEFetch_Sequence_Request::SetSeqStop(), CESearch_Request::SetSort(), CESearch_Request::SetSortOrderName(), CEFetch_Sequence_Request::SetStrand(), CEGQuery_Request::SetTerm(), CELink_Request::SetTerm(), CESearch_Request::SetTerm(), CESpell_Request::SetTerm(), CESearch_Request::SetUseHistory(), and CELink_Request::SetVersion().

◆ FetchIdList() [1/3]

CRef< uilist::CIdList > CEFetch_Request::FetchIdList ( int  chunk_size)
virtual

Get IdList using the currently set DB, WebEnv, retstart, retmax etc.

Limit number of ids in a single request to chunk_size if it's > 0. Stream format is set to XML. Data type should be set before calling this method. The method does not check returned data type, an exception will be thrown if reading fails.

Reimplemented in CEFetch_Taxonomy_Request, and CEFetch_Literature_Request.

Definition at line 98 of file efetch.cpp.

References chunk_size, CEFetch_Request::eRetMode_xml, CEUtils_Request::GetObjIStream(), CEFetch_Request::GetRetMax(), CEFetch_Request::GetRetStart(), i, max(), CEFetch_Request::SetRetMax(), CEFetch_Request::SetRetMode(), CEFetch_Request::SetRetStart(), and tmp.

Referenced by CEFetch_Literature_Request::FetchIdList(), and CEFetch_Taxonomy_Request::FetchIdList().

◆ FetchIdList() [2/3]

CRef< uilist::CIdList > CEFetch_Literature_Request::FetchIdList ( int  chunk_size)
virtual

Get IdList using the currently set DB, WebEnv, retstart, retmax etc.

The method changes rettype to uilist and retmode to xml, all other parameters are unchanged. Limit number of ids in a single request to chunk_size if it's > 0.

Reimplemented from CEFetch_Request.

Definition at line 181 of file efetch.cpp.

References chunk_size, CEFetch_Literature_Request::eRetType_uilist, CEFetch_Request::FetchIdList(), and CEFetch_Literature_Request::SetRetType().

◆ FetchIdList() [3/3]

CRef< uilist::CIdList > CEFetch_Taxonomy_Request::FetchIdList ( int  chunk_size)
virtual

Get IdList using the currently set DB, WebEnv, retstart, retmax etc.

The method changes report to uilist and retmode to xml, all other parameters are unchanged. Limit number of ids in a single request to chunk_size if it's > 0.

Reimplemented from CEFetch_Request.

Definition at line 275 of file efetch.cpp.

References chunk_size, CEFetch_Taxonomy_Request::eReport_uilist, CEFetch_Request::FetchIdList(), and CEFetch_Taxonomy_Request::SetReport().

◆ GetArgument()

const string & CEUtils_Request::GetArgument ( const string name) const

Get argument by name.

Definition at line 192 of file eutils.cpp.

References map_checker< Container >::end(), map_checker< Container >::find(), kEmptyStr, and CEUtils_Request::m_Args.

◆ GetBaseURL()

const string & CEUtils_Request::GetBaseURL ( void  )
static

◆ GetCommand()

ECommand CELink_Request::GetCommand ( void  ) const
inline

Definition at line 127 of file elink.hpp.

References CELink_Request::m_Cmd.

◆ GetComplexity()

EComplexity CEFetch_Sequence_Request::GetComplexity ( void  ) const
inline

Complexity level of the output data.

Definition at line 252 of file efetch.hpp.

References CEFetch_Sequence_Request::m_Complexity.

◆ GetConnContext()

CRef< CEUtils_ConnContext > & CEUtils_Request::GetConnContext ( void  ) const

Get current request context.

This call does not disconnect the request, all changes made to the context will not be picked up until the new connection.

Definition at line 61 of file eutils.cpp.

References CEUtils_Request::m_Context, and CRef< C, Locker >::Reset().

Referenced by CEUtilsApp::CallELink(), CEUtilsApp::CallESummary(), CEUtils_Request::Connect(), CEPost_Request::GetEPostResult(), CESearch_Request::GetESearchResult(), CEUtils_Request::GetQueryKey(), and CEUtils_Request::GetQueryString().

◆ GetDatabase()

const string& CEUtils_Request::GetDatabase ( void  ) const
inline

Database (usually set by each specific request class).

Definition at line 165 of file eutils.hpp.

References CEUtils_Request::m_Database.

◆ GetDateType() [1/2]

const string& CELink_Request::GetDateType ( void  ) const
inline

Limit dates to a specific date field based on database (e.g.

edat, mdat).

Definition at line 101 of file elink.hpp.

References CELink_Request::m_DateType.

◆ GetDateType() [2/2]

const string& CESearch_Request::GetDateType ( void  ) const
inline

Limit dates to a specific date field (e.g. edat, mdat).

Definition at line 102 of file esearch.hpp.

References CESearch_Request::m_DateType.

◆ GetDbFrom()

const string& CELink_Request::GetDbFrom ( void  ) const
inline

Origination database.

Definition at line 75 of file elink.hpp.

References CELink_Request::m_DbFrom.

◆ GetEHistoryResult()

CRef< ehistory::CEHistoryResult > CEHistory_Request::GetEHistoryResult ( void  )

Get request history.

Definition at line 59 of file ehistory.cpp.

References _ASSERT, CEUtils_Request::Disconnect(), and CEUtils_Request::GetObjIStream().

Referenced by CEUtilsApp::CallEHistory().

◆ GetEInfoResult()

CRef< einfo::CEInfoResult > CEInfo_Request::GetEInfoResult ( void  )

Get result.

Definition at line 59 of file einfo.cpp.

References _ASSERT, CEUtils_Request::Disconnect(), and CEUtils_Request::GetObjIStream().

Referenced by CEUtilsApp::CallEInfo().

◆ GetELinkResult()

CRef< elink::CELinkResult > CELink_Request::GetELinkResult ( void  )

Get search result.

Definition at line 139 of file elink.cpp.

References _ASSERT, CEUtils_Request::Disconnect(), and CEUtils_Request::GetObjIStream().

Referenced by CEUtilsApp::CallELink().

◆ GetEmail()

const string& CEUtils_ConnContext::GetEmail ( void  ) const
inline

Optional contact e-mail.

Definition at line 91 of file eutils.hpp.

References CEUtils_ConnContext::m_Email.

Referenced by CEUtils_Request::GetQueryString().

◆ GetEPostResult()

CRef< epost::CEPostResult > CEPost_Request::GetEPostResult ( void  )

Get search results.

If WebEnv and query_key values are persent in the results, they are stored in the context.

Definition at line 71 of file epost.cpp.

References _ASSERT, CEUtils_Request::Disconnect(), CEUtils_Request::GetConnContext(), CEUtils_Request::GetObjIStream(), CEUtils_ConnContext::SetQueryKey(), and CEUtils_ConnContext::SetWebEnv().

Referenced by CEUtilsApp::CallEPost().

◆ GetESearchResult()

CRef< esearch::CESearchResult > CESearch_Request::GetESearchResult ( void  )

Get search results.

If WebEnv and query_key values are persent in the results, they are stored in the context.

Definition at line 156 of file esearch.cpp.

References _ASSERT, CEUtils_Request::Disconnect(), CEUtils_Request::GetConnContext(), CEUtils_Request::GetObjIStream(), CEUtils_ConnContext::SetQueryKey(), and CEUtils_ConnContext::SetWebEnv().

Referenced by CEUtilsApp::CallESearch(), and CECitMatch_Request::GetResponse().

◆ GetESpellResult()

CRef< espell::CESpellResult > CESpell_Request::GetESpellResult ( void  )

Get search results.

Definition at line 71 of file espell.cpp.

References _ASSERT, CEUtils_Request::Disconnect(), and CEUtils_Request::GetObjIStream().

Referenced by CEUtilsApp::CallESpell().

◆ GetESummaryResult()

CRef< esummary::CESummaryResult > CESummary_Request::GetESummaryResult ( void  )

Get search result.

Depending on the requested database this call may fail (some databases use different DTDs for serialization). To get data from these databases one have to parse the data e.g. using XmlWrapp library.

Definition at line 78 of file esummary.cpp.

References _ASSERT, CEUtils_Request::Disconnect(), and CEUtils_Request::GetObjIStream().

Referenced by CEUtilsApp::CallESummary().

◆ GetField()

const string& CESearch_Request::GetField ( void  ) const
inline

Search field.

Definition at line 85 of file esearch.hpp.

References CESearch_Request::m_Field.

◆ GetGroups() [1/2]

TIdGroupSet& CEUtils_IdGroupSet::GetGroups ( void  )
inline

Get non-const list of groups.

Definition at line 283 of file eutils.hpp.

References CEUtils_IdGroupSet::m_Groups.

◆ GetGroups() [2/2]

const TIdGroupSet& CEUtils_IdGroupSet::GetGroups ( void  ) const
inline

Get read-only list of groups.

Definition at line 281 of file eutils.hpp.

References CEUtils_IdGroupSet::m_Groups.

◆ GetHolding()

const string& CELink_Request::GetHolding ( void  ) const
inline

List LinkOut URLs for the specified holding provider.

Used only in conjunction with cmd=llinks or cmd=llinkslib.

Definition at line 139 of file elink.hpp.

References CELink_Request::m_Holding.

◆ GetId() [1/6]

CEUtils_IdGroup& CEFetch_Request::GetId ( void  )
inline

Definition at line 69 of file efetch.hpp.

References CEUtils_Request::Disconnect(), and CEFetch_Request::m_Id.

◆ GetId() [2/6]

CEUtils_IdGroup& CEPost_Request::GetId ( void  )
inline

Definition at line 77 of file epost.hpp.

References CEUtils_Request::Disconnect(), and CEPost_Request::m_Id.

◆ GetId() [3/6]

CEUtils_IdGroup& CESummary_Request::GetId ( void  )
inline

Definition at line 72 of file esummary.hpp.

References CEUtils_Request::Disconnect(), and CESummary_Request::m_Id.

◆ GetId() [4/6]

const CEUtils_IdGroup& CEFetch_Request::GetId ( void  ) const
inline

Group of ids to retrieve.

Definition at line 68 of file efetch.hpp.

References CEFetch_Request::m_Id.

Referenced by s_GetObject().

◆ GetId() [5/6]

const CEUtils_IdGroup& CEPost_Request::GetId ( void  ) const
inline

Group of ids to be added to the search history.

Definition at line 76 of file epost.hpp.

References CEPost_Request::m_Id.

Referenced by CEUtilsApp::CallEPost().

◆ GetId() [6/6]

const CEUtils_IdGroup& CESummary_Request::GetId ( void  ) const
inline

Group of ids required if history is not used.

Definition at line 71 of file esummary.hpp.

References CESummary_Request::m_Id.

Referenced by CEUtilsApp::CallESummary(), and fix_pub::s_IsIndexed().

◆ GetIdGroups() [1/2]

CEUtils_IdGroupSet& CELink_Request::GetIdGroups ( void  )
inline

Definition at line 80 of file elink.hpp.

References CEUtils_Request::Disconnect(), and CELink_Request::m_IdGroups.

◆ GetIdGroups() [2/2]

const CEUtils_IdGroupSet& CELink_Request::GetIdGroups ( void  ) const
inline

Multiple ID groups.

Definition at line 79 of file elink.hpp.

References CELink_Request::m_IdGroups.

Referenced by CEUtilsApp::CallELink().

◆ GetIds() [1/2]

TIdList& CEUtils_IdGroup::GetIds ( void  )
inline

Get non-const list of ids.

Definition at line 248 of file eutils.hpp.

References CEUtils_IdGroup::m_Ids.

◆ GetIds() [2/2]

const TIdList& CEUtils_IdGroup::GetIds ( void  ) const
inline

Get read-only list of ids.

Definition at line 246 of file eutils.hpp.

References CEUtils_IdGroup::m_Ids.

◆ GetLinkName()

const string& CELink_Request::GetLinkName ( void  ) const
inline

Link to a specific neighbor subset.

A full list of allowed link names is available at http://eutils.ncbi.nlm.nih.gov/entrez/query/static/entrezlinks.html

Definition at line 133 of file elink.hpp.

References CELink_Request::m_LinkName.

◆ GetMaxDate() [1/2]

const CTime& CELink_Request::GetMaxDate ( void  ) const
inline

Max date. Both min and max date must be set.

Definition at line 96 of file elink.hpp.

References CELink_Request::m_MaxDate.

◆ GetMaxDate() [2/2]

const CTime& CESearch_Request::GetMaxDate ( void  ) const
inline

Max date. Both min and max date must be set.

Definition at line 98 of file esearch.hpp.

References CESearch_Request::m_MaxDate.

◆ GetMinDate() [1/2]

const CTime& CELink_Request::GetMinDate ( void  ) const
inline

Min date. Both min and max date must be set.

Definition at line 92 of file elink.hpp.

References CELink_Request::m_MinDate.

◆ GetMinDate() [2/2]

const CTime& CESearch_Request::GetMinDate ( void  ) const
inline

Min date. Both min and max date must be set.

Definition at line 94 of file esearch.hpp.

References CESearch_Request::m_MinDate.

◆ GetObjectIStream()

CObjectIStream * CEUtils_Request::GetObjectIStream ( void  )

Get serial stream for reading xml or asn data.

NOTE: The returned pointer is owned by the caller and must be destroyed properly before Disconnect() is called.

Definition at line 257 of file eutils.cpp.

References eSerial_None, CEUtils_Request::GetSerialDataFormat(), CEUtils_Request::GetStream(), NULL, and CObjectIStream::Open().

Referenced by CEUtils_Request::GetObjIStream().

◆ GetObjIStream()

CObjectIStream * CEUtils_Request::GetObjIStream ( void  )
protected

◆ GetQueryKey() [1/2]

const string& CEUtils_ConnContext::GetQueryKey ( void  ) const
inline

Get query_key.

See also
SetSendQueryKey()

Definition at line 81 of file eutils.hpp.

References CEUtils_ConnContext::m_QueryKey.

Referenced by CEUtilsApp::CallEPost(), and CEUtilsApp::CallESearch().

◆ GetQueryKey() [2/2]

const string & CEUtils_Request::GetQueryKey ( void  ) const

Read query_key value from the request or from the connection context.

Definition at line 288 of file eutils.cpp.

References ctx, CEUtils_Request::GetConnContext(), and CEUtils_Request::m_QueryKey.

Referenced by CEUtils_Request::GetQueryString().

◆ GetQueryString() [1/11]

string CEFetch_Request::GetQueryString ( void  ) const
virtual

◆ GetQueryString() [2/11]

string CEFetch_Literature_Request::GetQueryString ( void  ) const
virtual

◆ GetQueryString() [3/11]

string CEFetch_Sequence_Request::GetQueryString ( void  ) const
virtual

◆ GetQueryString() [4/11]

string CEFetch_Taxonomy_Request::GetQueryString ( void  ) const
virtual

◆ GetQueryString() [5/11]

string CEGQuery_Request::GetQueryString ( void  ) const
virtual

Get CGI script query string.

Reimplemented from CEUtils_Request.

Definition at line 52 of file egquery.cpp.

References NStr::eUrlEnc_ProcessMarkChars, CEUtils_Request::GetQueryString(), CEGQuery_Request::m_Term, and NStr::URLEncode().

Referenced by CEUtilsApp::CallEGQuery().

◆ GetQueryString() [6/11]

string CELink_Request::GetQueryString ( void  ) const
virtual

◆ GetQueryString() [7/11]

string CEPost_Request::GetQueryString ( void  ) const
virtual

Get CGI script query string.

Reimplemented from CEUtils_Request.

Definition at line 54 of file epost.cpp.

References CEUtils_IdGroup::AsQueryString(), CEUtils_Request::GetQueryString(), and CEPost_Request::m_Id.

Referenced by CEUtilsApp::CallEPost().

◆ GetQueryString() [8/11]

string CESearch_Request::GetQueryString ( void  ) const
virtual

◆ GetQueryString() [9/11]

string CESpell_Request::GetQueryString ( void  ) const
virtual

Get CGI script query string.

Reimplemented from CEUtils_Request.

Definition at line 54 of file espell.cpp.

References NStr::eUrlEnc_ProcessMarkChars, CEUtils_Request::GetQueryString(), CESpell_Request::m_Term, and NStr::URLEncode().

Referenced by CEUtilsApp::CallESpell().

◆ GetQueryString() [10/11]

string CESummary_Request::GetQueryString ( void  ) const
virtual

◆ GetQueryString() [11/11]

string CEUtils_Request::GetQueryString ( void  ) const
virtual

◆ GetRelDate() [1/2]

int CELink_Request::GetRelDate ( void  ) const
inline

Relative date to start search with, in days.

0 = not set

Definition at line 88 of file elink.hpp.

References CELink_Request::m_RelDate.

◆ GetRelDate() [2/2]

int CESearch_Request::GetRelDate ( void  ) const
inline

Relative date to start search with, in days.

0 = not set

Definition at line 90 of file esearch.hpp.

References CESearch_Request::m_RelDate.

◆ GetReport()

EReport CEFetch_Taxonomy_Request::GetReport ( void  ) const
inline

Output data format.

Definition at line 295 of file efetch.hpp.

References CEFetch_Taxonomy_Request::m_Report.

◆ GetRequestMethod()

ERequestMethod CEUtils_Request::GetRequestMethod ( void  ) const
inline

Get HTTP method.

Definition at line 191 of file eutils.hpp.

References CEUtils_Request::m_Method.

◆ GetResult()

CRef< egquery::CResult > CEGQuery_Request::GetResult ( void  )

Get search results.

Definition at line 69 of file egquery.cpp.

References _ASSERT, CEUtils_Request::Disconnect(), and CEUtils_Request::GetObjIStream().

Referenced by CEUtilsApp::CallEGQuery().

◆ GetRetMax() [1/3]

int CEFetch_Request::GetRetMax ( void  ) const
inline

Number of items retrieved, default is 20, maximum is 10,000.

Definition at line 77 of file efetch.hpp.

References CEFetch_Request::m_RetMax.

Referenced by CEFetch_Request::FetchIdList().

◆ GetRetMax() [2/3]

int CESearch_Request::GetRetMax ( void  ) const
inline

Number of items retrieved.

Definition at line 111 of file esearch.hpp.

References CESearch_Request::m_RetMax.

◆ GetRetMax() [3/3]

int CESummary_Request::GetRetMax ( void  ) const
inline

Number of items retrieved.

Definition at line 80 of file esummary.hpp.

References CESummary_Request::m_RetMax.

◆ GetRetMode() [1/2]

ERetMode CEFetch_Request::GetRetMode ( void  ) const
inline

Output format.

The real format can be different from the requested one depending on the request type and other arguments (e.g. rettype).

Definition at line 90 of file efetch.hpp.

References CEFetch_Request::m_RetMode.

◆ GetRetMode() [2/2]

ERetMode CELink_Request::GetRetMode ( void  ) const
inline

Output data type.

Definition at line 111 of file elink.hpp.

References CELink_Request::m_RetMode.

◆ GetRetStart() [1/3]

int CEFetch_Request::GetRetStart ( void  ) const
inline

Sequential number of the first id retrieved.

Default is 0 which will retrieve the first record.

Definition at line 73 of file efetch.hpp.

References CEFetch_Request::m_RetStart.

Referenced by CEFetch_Request::FetchIdList().

◆ GetRetStart() [2/3]

int CESearch_Request::GetRetStart ( void  ) const
inline

Sequential number of the first id retrieved.

Default is 0 which will retrieve the first record.

Definition at line 107 of file esearch.hpp.

References CESearch_Request::m_RetStart.

◆ GetRetStart() [3/3]

int CESummary_Request::GetRetStart ( void  ) const
inline

Sequential number of the first id retrieved.

Default is 0 which will retrieve the first record.

Definition at line 76 of file esummary.hpp.

References CESummary_Request::m_RetStart.

◆ GetRetType() [1/3]

ERetType CEFetch_Literature_Request::GetRetType ( void  ) const
inline

Output data type.

Definition at line 150 of file efetch.hpp.

References CEFetch_Literature_Request::m_RetType.

◆ GetRetType() [2/3]

ERetType CEFetch_Sequence_Request::GetRetType ( void  ) const
inline

Output data type.

Definition at line 220 of file efetch.hpp.

References CEFetch_Sequence_Request::m_RetType.

◆ GetRetType() [3/3]

ERetType CESearch_Request::GetRetType ( void  ) const
inline

Output data type.

Definition at line 121 of file esearch.hpp.

References CESearch_Request::m_RetType.

◆ GetScriptName()

const string& CEUtils_Request::GetScriptName ( void  ) const
inline

◆ GetSendQueryKey()

bool CEUtils_ConnContext::GetSendQueryKey ( void  ) const
inline

Definition at line 99 of file eutils.hpp.

References CEUtils_ConnContext::m_SendQueryKey.

◆ GetSeqStart()

int CEFetch_Sequence_Request::GetSeqStart ( void  ) const
inline

Show sequence starting from this base number.

Definition at line 235 of file efetch.hpp.

References CEFetch_Sequence_Request::m_SeqStart.

◆ GetSeqStop()

int CEFetch_Sequence_Request::GetSeqStop ( void  ) const
inline

Show sequence ending on this base number.

Definition at line 238 of file efetch.hpp.

References CEFetch_Sequence_Request::m_SeqStop.

◆ GetSerialDataFormat() [1/10]

ESerialDataFormat CEFetch_Request::GetSerialDataFormat ( void  ) const
virtual

Get serial stream format for reading data.

Reimplemented from CEUtils_Request.

Definition at line 87 of file efetch.cpp.

References CEFetch_Request::eRetMode_asn, CEFetch_Request::eRetMode_xml, eSerial_AsnText, eSerial_None, eSerial_Xml, and CEFetch_Request::m_RetMode.

◆ GetSerialDataFormat() [2/10]

ESerialDataFormat CEGQuery_Request::GetSerialDataFormat ( void  ) const
virtual

Get serial stream format for reading data.

Reimplemented from CEUtils_Request.

Definition at line 63 of file egquery.cpp.

References eSerial_Xml.

◆ GetSerialDataFormat() [3/10]

ESerialDataFormat CEHistory_Request::GetSerialDataFormat ( void  ) const
virtual

Get serial stream format for reading data.

Reimplemented from CEUtils_Request.

Definition at line 53 of file ehistory.cpp.

References eSerial_Xml.

◆ GetSerialDataFormat() [4/10]

ESerialDataFormat CEInfo_Request::GetSerialDataFormat ( void  ) const
virtual

Get serial stream format for reading data.

Reimplemented from CEUtils_Request.

Definition at line 53 of file einfo.cpp.

References eSerial_Xml.

◆ GetSerialDataFormat() [5/10]

ESerialDataFormat CELink_Request::GetSerialDataFormat ( void  ) const
virtual

Get serial stream format for reading data.

Reimplemented from CEUtils_Request.

Definition at line 133 of file elink.cpp.

References eSerial_Xml.

◆ GetSerialDataFormat() [6/10]

ESerialDataFormat CEPost_Request::GetSerialDataFormat ( void  ) const
virtual

Get serial stream format for reading data.

Reimplemented from CEUtils_Request.

Definition at line 65 of file epost.cpp.

References eSerial_Xml.

◆ GetSerialDataFormat() [7/10]

ESerialDataFormat CESearch_Request::GetSerialDataFormat ( void  ) const
virtual

Get serial stream format for reading data.

Reimplemented from CEUtils_Request.

Definition at line 150 of file esearch.cpp.

References eSerial_Xml.

◆ GetSerialDataFormat() [8/10]

ESerialDataFormat CESpell_Request::GetSerialDataFormat ( void  ) const
virtual

Get serial stream format for reading data.

Reimplemented from CEUtils_Request.

Definition at line 65 of file espell.cpp.

References eSerial_Xml.

◆ GetSerialDataFormat() [9/10]

ESerialDataFormat CESummary_Request::GetSerialDataFormat ( void  ) const
virtual

Get serial stream format for reading data.

Reimplemented from CEUtils_Request.

Definition at line 72 of file esummary.cpp.

References eSerial_Xml.

◆ GetSerialDataFormat() [10/10]

virtual ESerialDataFormat CEUtils_Request::GetSerialDataFormat ( void  ) const
inlinevirtual

Get serial stream format for reading data.

Reimplemented in CESummary_Request, CESpell_Request, CESearch_Request, CEPost_Request, CELink_Request, CEInfo_Request, CEHistory_Request, CEGQuery_Request, and CEFetch_Request.

Definition at line 134 of file eutils.hpp.

References eSerial_None.

Referenced by CEUtils_Request::GetObjectIStream().

◆ GetSort()

ESort CESearch_Request::GetSort ( void  ) const
inline

Get sort order.

Deprecated:
Use GetSortOrderName().

Definition at line 134 of file esearch.hpp.

References CESearch_Request::m_Sort.

◆ GetSortOrderName()

const string& CESearch_Request::GetSortOrderName ( void  ) const
inline

Get sort order. Empty string indicates no sorting (or the default one).

Definition at line 139 of file esearch.hpp.

References CESearch_Request::m_SortName.

◆ GetStrand()

EStrand CEFetch_Sequence_Request::GetStrand ( void  ) const
inline

Strand of DNA to show.

Definition at line 231 of file efetch.hpp.

References CEFetch_Sequence_Request::m_Strand.

◆ GetStream()

CNcbiIostream & CEUtils_Request::GetStream ( void  )

Get input stream for reading plain data.

Auto connect if the stream does not yet exist.

Definition at line 247 of file eutils.cpp.

References _ASSERT, CEUtils_Request::Connect(), and CEUtils_Request::m_Stream.

Referenced by CEUtils_Request::GetObjectIStream(), CEUtils_Request::Read(), fix_pub::s_GetESearchIds(), and fix_pub::s_IsIndexed().

◆ GetTerm() [1/4]

const string& CEGQuery_Request::GetTerm ( void  ) const
inline

Search term.

Definition at line 73 of file egquery.hpp.

References CEGQuery_Request::m_Term.

◆ GetTerm() [2/4]

const string& CELink_Request::GetTerm ( void  ) const
inline

Search term.

Definition at line 83 of file elink.hpp.

References CELink_Request::m_Term.

◆ GetTerm() [3/4]

const string& CESearch_Request::GetTerm ( void  ) const
inline

Search term.

Definition at line 81 of file esearch.hpp.

References CESearch_Request::m_Term.

◆ GetTerm() [4/4]

const string& CESpell_Request::GetTerm ( void  ) const
inline

Search term.

Definition at line 75 of file espell.hpp.

References CESpell_Request::m_Term.

◆ GetTimeout()

const CTimeout& CEUtils_ConnContext::GetTimeout ( void  ) const
inline

Get timeout.

Definition at line 71 of file eutils.hpp.

References CEUtils_ConnContext::m_Timeout.

◆ GetTool()

const string& CEUtils_ConnContext::GetTool ( void  ) const
inline

A string with no internal spaces that identifies the resource which is using Entrez links (optional).

Definition at line 87 of file eutils.hpp.

References CEUtils_ConnContext::m_Tool.

Referenced by CEUtils_Request::GetQueryString().

◆ GetUseHistory()

bool CESearch_Request::GetUseHistory ( void  ) const
inline

History update flag, on by default.

If set, WebEnv and query_key are updated to include the results in the history.

Definition at line 77 of file esearch.hpp.

References CESearch_Request::m_UseHistory.

◆ GetVersion()

const string& CELink_Request::GetVersion ( void  ) const
inline

Latest DTD version.

Definition at line 144 of file elink.hpp.

References CELink_Request::m_Version.

◆ GetWebEnv()

const string& CEUtils_ConnContext::GetWebEnv ( void  ) const
inline

◆ operator=()

CEUtils_Request& CEUtils_Request::operator= ( const CEUtils_Request )
private

◆ Read()

void CEUtils_Request::Read ( string content)

Read the whole stream into the string.

Discard data if the pointer is NULL.

Definition at line 274 of file eutils.cpp.

References CEUtils_Request::Disconnect(), CEUtils_Request::GetStream(), and NcbiStreamToString().

Referenced by s_GetObject(), and CEUtilsApp::x_DumpRequest().

◆ ResetBaseURL()

void CEUtils_Request::ResetBaseURL ( void  )
static

Reset cached base url so that it's refreshed on next request.

Definition at line 145 of file eutils.cpp.

References s_CachedBaseUrl.

◆ ResetQueryKey()

void CEUtils_Request::ResetQueryKey ( void  )

Reset requests's query_key, use the one from the connectiono context.

Definition at line 305 of file eutils.cpp.

References CEUtils_Request::Disconnect(), and CEUtils_Request::m_QueryKey.

◆ SetArgument()

void CEUtils_Request::SetArgument ( const string name,
const string value 
)

Add/change custom argument. Remove the argument if the value is empty.

Definition at line 179 of file eutils.cpp.

References map_checker< Container >::end(), map_checker< Container >::erase(), map_checker< Container >::find(), CEUtils_Request::m_Args, and rapidjson::value.

Referenced by fix_pub::s_GetESearchIds(), and fix_pub::s_IsIndexed().

◆ SetBaseURL()

void CEUtils_Request::SetBaseURL ( const string url)
static

Set new base url for all e-utils requests.

Definition at line 137 of file eutils.cpp.

References CEUtils_Request::GetBaseURL().

Referenced by CPubmedFetchApplication::Run(), CTestRemoteUpdaterApplication::Run(), and CRemoteUpdater::xUpdatePubReferences().

◆ SetCommand()

void CELink_Request::SetCommand ( ECommand  cmd)
inline

Definition at line 128 of file elink.hpp.

References cmd, CEUtils_Request::Disconnect(), and CELink_Request::m_Cmd.

Referenced by CEUtilsApp::CallELink().

◆ SetComplexity()

void CEFetch_Sequence_Request::SetComplexity ( EComplexity  complexity)
inline

◆ SetConnContext()

void CEUtils_Request::SetConnContext ( const CRef< CEUtils_ConnContext > &  ctx)

Set new request context.

Definition at line 70 of file eutils.cpp.

References ctx, CEUtils_Request::Disconnect(), and CEUtils_Request::m_Context.

◆ SetDatabase()

void CEUtils_Request::SetDatabase ( const string database)

◆ SetDateType() [1/2]

void CELink_Request::SetDateType ( const string type)
inline

Definition at line 102 of file elink.hpp.

References CEUtils_Request::Disconnect(), CELink_Request::m_DateType, and type.

◆ SetDateType() [2/2]

void CESearch_Request::SetDateType ( const string type)
inline

Definition at line 103 of file esearch.hpp.

References CEUtils_Request::Disconnect(), CESearch_Request::m_DateType, and type.

◆ SetDbFrom()

void CELink_Request::SetDbFrom ( const string dbfrom)
inline

Definition at line 76 of file elink.hpp.

References CEUtils_Request::Disconnect(), and CELink_Request::m_DbFrom.

Referenced by CEUtilsApp::CallELink().

◆ SetEmail()

void CEUtils_ConnContext::SetEmail ( const string email)
inline

Definition at line 92 of file eutils.hpp.

References CEUtils_ConnContext::m_Email.

Referenced by CEUtilsApp::Run().

◆ SetField()

void CESearch_Request::SetField ( const string field)
inline

Definition at line 86 of file esearch.hpp.

References CEUtils_Request::Disconnect(), and CESearch_Request::m_Field.

◆ SetGroups()

void CEUtils_IdGroupSet::SetGroups ( const string groups)

Parse a set of id groups from a single string ('id=12,34&id=56,78').

Definition at line 335 of file eutils.cpp.

References NStr::fSplit_MergeDelimiters, NStr::fSplit_Truncate, ITERATE, CEUtils_IdGroupSet::m_Groups, CEUtils_IdGroup::SetIds(), NStr::Split(), and tmp.

Referenced by CEUtilsApp::CallELink().

◆ SetHolding()

void CELink_Request::SetHolding ( const string holding)
inline

Definition at line 140 of file elink.hpp.

References CEUtils_Request::Disconnect(), and CELink_Request::m_Holding.

Referenced by CEUtilsApp::CallELink().

◆ SetIds()

void CEUtils_IdGroup::SetIds ( const string ids)

Parse all ids from a string (e.g. 'id=123,456,78').

Definition at line 324 of file eutils.cpp.

References CEUtils_IdGroup::AddId(), NStr::fSplit_MergeDelimiters, NStr::fSplit_Truncate, ITERATE, NStr::Split(), and tmp.

Referenced by CEUtilsApp::CallEPost(), CEUtilsApp::CallESummary(), and CEUtils_IdGroupSet::SetGroups().

◆ SetLinkName()

void CELink_Request::SetLinkName ( const string linkname)
inline

Definition at line 134 of file elink.hpp.

References CEUtils_Request::Disconnect(), and CELink_Request::m_LinkName.

Referenced by CEUtilsApp::CallELink().

◆ SetMaxDate() [1/2]

void CELink_Request::SetMaxDate ( const CTime date)
inline

Definition at line 97 of file elink.hpp.

References CEUtils_Request::Disconnect(), and CELink_Request::m_MaxDate.

◆ SetMaxDate() [2/2]

void CESearch_Request::SetMaxDate ( const CTime date)
inline

Definition at line 99 of file esearch.hpp.

References CEUtils_Request::Disconnect(), and CESearch_Request::m_MaxDate.

◆ SetMinDate() [1/2]

void CELink_Request::SetMinDate ( const CTime date)
inline

Definition at line 93 of file elink.hpp.

References CEUtils_Request::Disconnect(), and CELink_Request::m_MinDate.

◆ SetMinDate() [2/2]

void CESearch_Request::SetMinDate ( const CTime date)
inline

Definition at line 95 of file esearch.hpp.

References CEUtils_Request::Disconnect(), and CESearch_Request::m_MinDate.

◆ SetQueryKey() [1/2]

void CEUtils_Request::SetQueryKey ( const string key)

Override query_key stored in the connection context.

Can be used to refer different queries from the history without changing current context. Disconnects the request.

Definition at line 298 of file eutils.cpp.

References CEUtils_Request::Disconnect(), ncbi::grid::netcache::search::fields::key, and CEUtils_Request::m_QueryKey.

◆ SetQueryKey() [2/2]

void CEUtils_ConnContext::SetQueryKey ( const string query_key)
inline

◆ SetRelDate() [1/2]

void CELink_Request::SetRelDate ( int  days)
inline

Definition at line 89 of file elink.hpp.

References CEUtils_Request::Disconnect(), and CELink_Request::m_RelDate.

Referenced by CEUtilsApp::CallELink().

◆ SetRelDate() [2/2]

void CESearch_Request::SetRelDate ( int  days)
inline

Definition at line 91 of file esearch.hpp.

References CEUtils_Request::Disconnect(), and CESearch_Request::m_RelDate.

Referenced by CEUtilsApp::CallESearch().

◆ SetReport()

void CEFetch_Taxonomy_Request::SetReport ( EReport  report)
inline

◆ SetRequestMethod()

void CEUtils_Request::SetRequestMethod ( ERequestMethod  method)
inline

Set HTTP method.

Definition at line 193 of file eutils.hpp.

References CEUtils_Request::m_Method.

Referenced by CEUtilsApp::x_SetHttpMethod().

◆ SetRetMax() [1/3]

void CEFetch_Request::SetRetMax ( int  retmax)
inline

Definition at line 78 of file efetch.hpp.

References CEUtils_Request::Disconnect(), and CEFetch_Request::m_RetMax.

Referenced by CEFetch_Request::FetchIdList().

◆ SetRetMax() [2/3]

void CESearch_Request::SetRetMax ( int  retmax)
inline

◆ SetRetMax() [3/3]

void CESummary_Request::SetRetMax ( int  retmax)
inline

Definition at line 81 of file esummary.hpp.

References CEUtils_Request::Disconnect(), and CESummary_Request::m_RetMax.

Referenced by CEUtilsApp::CallESummary().

◆ SetRetMode() [1/2]

void CEFetch_Request::SetRetMode ( ERetMode  retmode)
inline

Definition at line 91 of file efetch.hpp.

References CEUtils_Request::Disconnect(), and CEFetch_Request::m_RetMode.

Referenced by CEFetch_Request::FetchIdList().

◆ SetRetMode() [2/2]

void CELink_Request::SetRetMode ( ERetMode  retmode)
inline

Definition at line 112 of file elink.hpp.

References CEUtils_Request::Disconnect(), and CELink_Request::m_RetMode.

◆ SetRetStart() [1/3]

void CEFetch_Request::SetRetStart ( int  retstart)
inline

Definition at line 74 of file efetch.hpp.

References CEUtils_Request::Disconnect(), and CEFetch_Request::m_RetStart.

Referenced by CEFetch_Request::FetchIdList().

◆ SetRetStart() [2/3]

void CESearch_Request::SetRetStart ( int  retstart)
inline

Definition at line 108 of file esearch.hpp.

References CEUtils_Request::Disconnect(), and CESearch_Request::m_RetStart.

◆ SetRetStart() [3/3]

void CESummary_Request::SetRetStart ( int  retstart)
inline

Definition at line 77 of file esummary.hpp.

References CEUtils_Request::Disconnect(), and CESummary_Request::m_RetStart.

Referenced by CEUtilsApp::CallESummary().

◆ SetRetType() [1/3]

void CEFetch_Literature_Request::SetRetType ( ERetType  rettype)
inline

◆ SetRetType() [2/3]

void CEFetch_Sequence_Request::SetRetType ( ERetType  rettype)
inline

◆ SetRetType() [3/3]

void CESearch_Request::SetRetType ( ERetType  rettype)
inline

Definition at line 122 of file esearch.hpp.

References CEUtils_Request::Disconnect(), and CESearch_Request::m_RetType.

Referenced by CEUtilsApp::CallESearch().

◆ SetSendQueryKey()

void CEUtils_ConnContext::SetSendQueryKey ( bool  value)
inline

Set SendQueryKey flag.

By default query-key is automatically sent with each request. This tells the server to append new search terms to the previous query. Setting SendQueryKey flag to false disables sending query-key (without resetting the actual query-key value received in replies).

Definition at line 98 of file eutils.hpp.

References CEUtils_ConnContext::m_SendQueryKey, and rapidjson::value.

Referenced by CEUtilsApp::Run().

◆ SetSeqStart()

void CEFetch_Sequence_Request::SetSeqStart ( int  pos)
inline

◆ SetSeqStop()

void CEFetch_Sequence_Request::SetSeqStop ( int  pos)
inline

◆ SetSort()

void CESearch_Request::SetSort ( ESort  order)

◆ SetSortOrderName()

void CESearch_Request::SetSortOrderName ( CTempString  name)

Set sort order. Empty string indicates no sorting (or the default one).

Definition at line 83 of file esearch.cpp.

References CEUtils_Request::Disconnect(), CESearch_Request::eSort_none, CESearch_Request::m_Sort, and CESearch_Request::m_SortName.

Referenced by CEUtilsApp::CallESearch().

◆ SetStrand()

void CEFetch_Sequence_Request::SetStrand ( EStrand  strand)
inline

◆ SetTerm() [1/4]

void CEGQuery_Request::SetTerm ( const string term)
inline

Definition at line 74 of file egquery.hpp.

References CEUtils_Request::Disconnect(), and CEGQuery_Request::m_Term.

Referenced by CEUtilsApp::CallEGQuery().

◆ SetTerm() [2/4]

void CELink_Request::SetTerm ( const string term)
inline

Definition at line 84 of file elink.hpp.

References CEUtils_Request::Disconnect(), and CELink_Request::m_Term.

◆ SetTerm() [3/4]

void CESearch_Request::SetTerm ( const string term)
inline

Definition at line 82 of file esearch.hpp.

References CEUtils_Request::Disconnect(), and CESearch_Request::m_Term.

Referenced by CEUtilsApp::CallESearch().

◆ SetTerm() [4/4]

void CESpell_Request::SetTerm ( const string term)
inline

Definition at line 76 of file espell.hpp.

References CEUtils_Request::Disconnect(), and CESpell_Request::m_Term.

Referenced by CEUtilsApp::CallESpell().

◆ SetTimeout()

void CEUtils_ConnContext::SetTimeout ( const CTimeout tmo)
inline

Set timeout.

Definition at line 73 of file eutils.hpp.

References CEUtils_ConnContext::m_Timeout.

◆ SetTool()

void CEUtils_ConnContext::SetTool ( const string tool)
inline

Definition at line 88 of file eutils.hpp.

References CEUtils_ConnContext::m_Tool.

Referenced by CEUtilsApp::Run().

◆ SetUseHistory()

void CESearch_Request::SetUseHistory ( bool  value)
inline

◆ SetVersion()

void CELink_Request::SetVersion ( const string version)
inline

Definition at line 145 of file elink.hpp.

References CEUtils_Request::Disconnect(), CELink_Request::m_Version, and version.

◆ SetWebEnv()

void CEUtils_ConnContext::SetWebEnv ( const string webenv)
inline

◆ x_GetCommandName()

const char * CELink_Request::x_GetCommandName ( void  ) const
inlineprivate

Definition at line 68 of file elink.cpp.

References CELink_Request::m_Cmd.

Referenced by CELink_Request::GetQueryString().

◆ x_GetReportName()

const char * CEFetch_Taxonomy_Request::x_GetReportName ( void  ) const
inlineprivate

Definition at line 254 of file efetch.cpp.

References CEFetch_Taxonomy_Request::m_Report.

Referenced by CEFetch_Taxonomy_Request::GetQueryString().

◆ x_GetRetModeName() [1/2]

const char * CEFetch_Request::x_GetRetModeName ( void  ) const
inlineprivate

Definition at line 56 of file efetch.cpp.

References CEFetch_Request::m_RetMode.

Referenced by CEFetch_Request::GetQueryString().

◆ x_GetRetModeName() [2/2]

const char * CELink_Request::x_GetRetModeName ( void  ) const
inlineprivate

Definition at line 58 of file elink.cpp.

References CELink_Request::m_RetMode.

Referenced by CELink_Request::GetQueryString().

◆ x_GetRetTypeName() [1/3]

const char * CEFetch_Literature_Request::x_GetRetTypeName ( void  ) const
inlineprivate

◆ x_GetRetTypeName() [2/3]

const char * CEFetch_Sequence_Request::x_GetRetTypeName ( void  ) const
inlineprivate

Definition at line 207 of file efetch.cpp.

References CEFetch_Sequence_Request::m_RetType.

Referenced by CEFetch_Sequence_Request::GetQueryString().

◆ x_GetRetTypeName() [3/3]

const char * CESearch_Request::x_GetRetTypeName ( void  ) const
inlineprivate

Definition at line 92 of file esearch.cpp.

References CESearch_Request::m_RetType.

Referenced by CESearch_Request::GetQueryString().

◆ ~CEFetch_Request()

CEFetch_Request::~CEFetch_Request ( void  )
virtual

Definition at line 50 of file efetch.cpp.

◆ ~CEGQuery_Request()

CEGQuery_Request::~CEGQuery_Request ( void  )
virtual

Definition at line 47 of file egquery.cpp.

◆ ~CEHistory_Request()

CEHistory_Request::~CEHistory_Request ( void  )
virtual

Definition at line 48 of file ehistory.cpp.

◆ ~CEInfo_Request()

CEInfo_Request::~CEInfo_Request ( void  )
virtual

Definition at line 48 of file einfo.cpp.

◆ ~CELink_Request()

CELink_Request::~CELink_Request ( void  )
virtual

Definition at line 52 of file elink.cpp.

◆ ~CEPost_Request()

CEPost_Request::~CEPost_Request ( void  )
virtual

Definition at line 49 of file epost.cpp.

◆ ~CESearch_Request()

CESearch_Request::~CESearch_Request ( void  )
virtual

Definition at line 55 of file esearch.cpp.

◆ ~CESpell_Request()

CESpell_Request::~CESpell_Request ( void  )
virtual

Definition at line 49 of file espell.cpp.

◆ ~CESummary_Request()

CESummary_Request::~CESummary_Request ( void  )
virtual

Definition at line 50 of file esummary.cpp.

◆ ~CEUtils_ConnContext()

virtual CEUtils_ConnContext::~CEUtils_ConnContext ( void  )
inlinevirtual

Definition at line 68 of file eutils.hpp.

◆ ~CEUtils_IdGroup()

CEUtils_IdGroup::~CEUtils_IdGroup ( void  )
inline

Definition at line 239 of file eutils.hpp.

◆ ~CEUtils_IdGroupSet()

CEUtils_IdGroupSet::~CEUtils_IdGroupSet ( void  )
inline

Definition at line 274 of file eutils.hpp.

◆ ~CEUtils_Request()

virtual CEUtils_Request::~CEUtils_Request ( void  )
inlinevirtual

Definition at line 125 of file eutils.hpp.

Variable Documentation

◆ m_Args

TRequestArgs CEUtils_Request::m_Args
private

◆ m_Cmd

ECommand CELink_Request::m_Cmd
private

◆ m_Complexity

EComplexity CEFetch_Sequence_Request::m_Complexity
private

◆ m_Context

CRef<CEUtils_ConnContext> CEUtils_Request::m_Context
mutableprivate

Definition at line 214 of file eutils.hpp.

Referenced by CEUtils_Request::GetConnContext(), and CEUtils_Request::SetConnContext().

◆ m_Database

string CEUtils_Request::m_Database
private

◆ m_DateType [1/2]

string CELink_Request::m_DateType
private

◆ m_DateType [2/2]

string CESearch_Request::m_DateType
private

◆ m_DbFrom

string CELink_Request::m_DbFrom
private

◆ m_Email

string CEUtils_ConnContext::m_Email
private

Definition at line 106 of file eutils.hpp.

Referenced by CEUtils_ConnContext::GetEmail(), and CEUtils_ConnContext::SetEmail().

◆ m_Field

string CESearch_Request::m_Field
private

◆ m_Groups

TIdGroupSet CEUtils_IdGroupSet::m_Groups
private

◆ m_Holding

string CELink_Request::m_Holding
private

◆ m_Id [1/3]

CEUtils_IdGroup CEFetch_Request::m_Id
private

Definition at line 111 of file efetch.hpp.

Referenced by CEFetch_Request::GetId(), and CEFetch_Request::GetQueryString().

◆ m_Id [2/3]

CEUtils_IdGroup CEPost_Request::m_Id
private

Definition at line 82 of file epost.hpp.

Referenced by CEPost_Request::GetId(), and CEPost_Request::GetQueryString().

◆ m_Id [3/3]

CEUtils_IdGroup CESummary_Request::m_Id
private

Definition at line 92 of file esummary.hpp.

Referenced by CESummary_Request::GetId(), and CESummary_Request::GetQueryString().

◆ m_IdGroups

CEUtils_IdGroupSet CELink_Request::m_IdGroups
private

Definition at line 155 of file elink.hpp.

Referenced by CELink_Request::GetIdGroups(), and CELink_Request::GetQueryString().

◆ m_Ids

TIdList CEUtils_IdGroup::m_Ids
private

◆ m_LinkName

string CELink_Request::m_LinkName
private

◆ m_MaxDate [1/2]

CTime CELink_Request::m_MaxDate
private

◆ m_MaxDate [2/2]

CTime CESearch_Request::m_MaxDate
private

◆ m_Method

ERequestMethod CEUtils_Request::m_Method
private

◆ m_MinDate [1/2]

CTime CELink_Request::m_MinDate
private

◆ m_MinDate [2/2]

CTime CESearch_Request::m_MinDate
private

◆ m_ObjStream

unique_ptr<CObjectIStream> CEUtils_Request::m_ObjStream
private

Definition at line 216 of file eutils.hpp.

Referenced by CEUtils_Request::Disconnect(), and CEUtils_Request::GetObjIStream().

◆ m_QueryKey [1/2]

string CEUtils_ConnContext::m_QueryKey
private

◆ m_QueryKey [2/2]

string CEUtils_Request::m_QueryKey
private

◆ m_RelDate [1/2]

int CELink_Request::m_RelDate
private

◆ m_RelDate [2/2]

int CESearch_Request::m_RelDate
private

◆ m_Report

EReport CEFetch_Taxonomy_Request::m_Report
private

◆ m_RetMax [1/3]

int CEFetch_Request::m_RetMax
private

◆ m_RetMax [2/3]

int CESearch_Request::m_RetMax
private

◆ m_RetMax [3/3]

int CESummary_Request::m_RetMax
private

◆ m_RetMode [1/2]

ERetMode CEFetch_Request::m_RetMode
private

◆ m_RetMode [2/2]

ERetMode CELink_Request::m_RetMode
private

◆ m_RetStart [1/3]

int CEFetch_Request::m_RetStart
private

◆ m_RetStart [2/3]

int CESearch_Request::m_RetStart
private

◆ m_RetStart [3/3]

int CESummary_Request::m_RetStart
private

◆ m_RetType [1/3]

ERetType CEFetch_Literature_Request::m_RetType
private

◆ m_RetType [2/3]

ERetType CEFetch_Sequence_Request::m_RetType
private

◆ m_RetType [3/3]

ERetType CESearch_Request::m_RetType
private

◆ m_ScriptName

string CEUtils_Request::m_ScriptName
private

Definition at line 218 of file eutils.hpp.

Referenced by CEUtils_Request::GetScriptName().

◆ m_SendQueryKey

bool CEUtils_ConnContext::m_SendQueryKey = true
private

◆ m_SeqStart

int CEFetch_Sequence_Request::m_SeqStart
private

◆ m_SeqStop

int CEFetch_Sequence_Request::m_SeqStop
private

◆ m_Sort

ESort CESearch_Request::m_Sort
private

◆ m_SortName

string CESearch_Request::m_SortName
private

◆ m_Strand

EStrand CEFetch_Sequence_Request::m_Strand
private

◆ m_Stream

unique_ptr<CConn_HttpStream> CEUtils_Request::m_Stream
private

◆ m_Term [1/4]

string CEGQuery_Request::m_Term
private

◆ m_Term [2/4]

string CELink_Request::m_Term
private

◆ m_Term [3/4]

string CESearch_Request::m_Term
private

◆ m_Term [4/4]

string CESpell_Request::m_Term
private

◆ m_Timeout

CTimeout CEUtils_ConnContext::m_Timeout
private

Definition at line 102 of file eutils.hpp.

Referenced by CEUtils_ConnContext::GetTimeout(), and CEUtils_ConnContext::SetTimeout().

◆ m_Tool

string CEUtils_ConnContext::m_Tool
private

Definition at line 105 of file eutils.hpp.

Referenced by CEUtils_ConnContext::GetTool(), and CEUtils_ConnContext::SetTool().

◆ m_UseHistory

bool CESearch_Request::m_UseHistory
private

◆ m_Version

string CELink_Request::m_Version
private

◆ m_WebEnv

string CEUtils_ConnContext::m_WebEnv
private

Definition at line 103 of file eutils.hpp.

Referenced by CEUtils_ConnContext::GetWebEnv(), and CEUtils_ConnContext::SetWebEnv().

Modified on Wed Jun 12 11:20:43 2024 by modify_doxy.py rev. 669887