entrez2_client.hpp
上传用户:yhdzpy8989
上传日期:2007-06-13
资源大小:13604k
文件大小:6k
源码类别:

生物技术

开发平台:

C/C++

  1. /*
  2.  * ===========================================================================
  3.  * PRODUCTION $Log: entrez2_client.hpp,v $
  4.  * PRODUCTION Revision 1000.1  2004/04/12 17:23:37  gouriano
  5.  * PRODUCTION PRODUCTION: UPGRADED [CATCHUP_003] Dev-tree R1.6
  6.  * PRODUCTION
  7.  * ===========================================================================
  8.  */
  9. /* $Id: entrez2_client.hpp,v 1000.1 2004/04/12 17:23:37 gouriano Exp $
  10.  * ===========================================================================
  11.  *
  12.  *                            PUBLIC DOMAIN NOTICE
  13.  *               National Center for Biotechnology Information
  14.  *
  15.  *  This software/database is a "United States Government Work" under the
  16.  *  terms of the United States Copyright Act.  It was written as part of
  17.  *  the author's official duties as a United States Government employee and
  18.  *  thus cannot be copyrighted.  This software/database is freely available
  19.  *  to the public for use. The National Library of Medicine and the U.S.
  20.  *  Government have not placed any restriction on its use or reproduction.
  21.  *
  22.  *  Although all reasonable efforts have been taken to ensure the accuracy
  23.  *  and reliability of the software and data, the NLM and the U.S.
  24.  *  Government do not and cannot warrant the performance or results that
  25.  *  may be obtained by using this software or data. The NLM and the U.S.
  26.  *  Government disclaim all warranties, express or implied, including
  27.  *  warranties of performance, merchantability or fitness for any particular
  28.  *  purpose.
  29.  *
  30.  *  Please cite the author in any work or product based on this material.
  31.  *
  32.  * ===========================================================================
  33.  *
  34.  * Author:  Aaron Ucko, NCBI
  35.  *
  36.  * File Description:
  37.  *   Entrez2 network client
  38.  *
  39.  * Remark:
  40.  *   This code was originally generated by application DATATOOL
  41.  *   using specifications from the data definition file
  42.  *   'entrez2.asn'.
  43.  */
  44. #ifndef OBJECTS_ENTREZ2_ENTREZ2_CLIENT_HPP
  45. #define OBJECTS_ENTREZ2_ENTREZ2_CLIENT_HPP
  46. // generated includes
  47. #include <objects/entrez2/entrez2_client_.hpp>
  48. #include <objects/entrez2/Entrez2_link_set.hpp>
  49. #include <objects/entrez2/Entrez2_link_count_list.hpp>
  50. // generated classes
  51. BEGIN_NCBI_SCOPE
  52. BEGIN_objects_SCOPE // namespace ncbi::objects::
  53. class NCBI_ENTREZ2_EXPORT CEntrez2Client : public CEntrez2Client_Base
  54. {
  55.     typedef CEntrez2Client_Base Tparent;
  56. public:
  57.     // constructor
  58.     CEntrez2Client(void);
  59.     // destructor
  60.     ~CEntrez2Client(void);
  61.     /// A simplified interface for getting neighbors (links)
  62.     
  63.     /// Get ids of neigbors of a specified type.
  64.     /// db is, e.g., "nucleotide" or "protein" (depending on the query).
  65.     /// link_type is, for example, "nucleotide_nucleotide".
  66.     /// This form just yields a vector of UIDs
  67.     void GetNeighbors(int query_uid, const string& db,
  68.                       const string& link_type,
  69.                       vector<int>& neighbor_uids);
  70.     /// This form just yields a vector of UIDs, taking a vector of UIDs
  71.     void GetNeighbors(const vector<int>& query_uids,
  72.                       const string& db,
  73.                       const string& link_type,
  74.                       vector<int>& neighbor_uids);
  75.     /// This form returns the entire CEntrez2_link_set object,
  76.     /// which includes scores.
  77.     CRef<CEntrez2_link_set> GetNeighbors(int query_uid,
  78.                                          const string& db,
  79.                                          const string& link_type);
  80.     /// This form returns the entire CEntrez2_link_set object,
  81.     /// which includes scores.
  82.     CRef<CEntrez2_link_set> GetNeighbors(const vector<int>& query_uids,
  83.                                          const string& db,
  84.                                          const string& link_type);
  85.     /// Retrieve counts of the various types of neighbors available
  86.     CRef<CEntrez2_link_count_list> GetNeighborCounts(int query_uid,
  87.                                                      const string& db);
  88.     
  89.     /// Some other simplified interfaces
  90.     /// Query a db with a string, returning uids as integers
  91.     void Query(const string& query, const string& db,
  92.                vector<int>& result_uids);
  93.     /// Given some uids, a database, and an entrez query string,
  94.     /// determine which of these uids match the query string
  95.     void FilterIds(const vector<int>& query_uids, const string& db,
  96.                    const string& query_string,
  97.                    vector<int>& result_uids);
  98. private:
  99.     // Prohibit copy constructor and assignment operator
  100.     CEntrez2Client(const CEntrez2Client& value);
  101.     CEntrez2Client& operator=(const CEntrez2Client& value);
  102. };
  103. /////////////////// CEntrez2Client inline methods
  104. // constructor
  105. inline
  106. CEntrez2Client::CEntrez2Client(void)
  107. {
  108.     SetDefaultRequest().SetTool("CEntrez2Client");
  109.     SetDefaultRequest().SetVersion(1);
  110. }
  111. /////////////////// end of CEntrez2Client inline methods
  112. END_objects_SCOPE // namespace ncbi::objects::
  113. END_NCBI_SCOPE
  114. /*
  115. * ===========================================================================
  116. *
  117. * $Log: entrez2_client.hpp,v $
  118. * Revision 1000.1  2004/04/12 17:23:37  gouriano
  119. * PRODUCTION: UPGRADED [CATCHUP_003] Dev-tree R1.6
  120. *
  121. * Revision 1.6  2004/03/11 17:25:05  dicuccio
  122. * Added API to retrieve neighbors for multiple UIDs at once
  123. *
  124. * Revision 1.5  2004/01/20 05:36:56  jcherry
  125. * Added missing '&' on argument to FilterIds (pass by reference)
  126. *
  127. * Revision 1.4  2003/10/16 20:10:24  jcherry
  128. * Added some simplified interfaces for querying
  129. *
  130. * Revision 1.3  2003/10/08 19:18:01  jcherry
  131. * Added a simplified interface for getting neighbors
  132. *
  133. * Revision 1.2  2003/07/31 16:43:58  dicuccio
  134. * Added missing export specifier
  135. *
  136. * Revision 1.1  2003/04/09 16:00:12  ucko
  137. * Give all RPC clients unique basenames.
  138. *
  139. * Revision 1.1  2002/11/13 20:13:41  ucko
  140. * Add datatool-generated client classes
  141. *
  142. *
  143. * ===========================================================================
  144. */
  145. #endif // OBJECTS_ENTREZ2_ENTREZ2_CLIENT_HPP
  146. /* Original file checksum: lines: 93, chars: 2440, CRC32: 16aa1713 */