entrez2_client.hpp
上传用户:yhdzpy8989
上传日期:2007-06-13
资源大小:13604k
文件大小:6k
- /*
- * ===========================================================================
- * PRODUCTION $Log: entrez2_client.hpp,v $
- * PRODUCTION Revision 1000.1 2004/04/12 17:23:37 gouriano
- * PRODUCTION PRODUCTION: UPGRADED [CATCHUP_003] Dev-tree R1.6
- * PRODUCTION
- * ===========================================================================
- */
- /* $Id: entrez2_client.hpp,v 1000.1 2004/04/12 17:23:37 gouriano Exp $
- * ===========================================================================
- *
- * PUBLIC DOMAIN NOTICE
- * National Center for Biotechnology Information
- *
- * This software/database is a "United States Government Work" under the
- * terms of the United States Copyright Act. It was written as part of
- * the author's official duties as a United States Government employee and
- * thus cannot be copyrighted. This software/database is freely available
- * to the public for use. The National Library of Medicine and the U.S.
- * Government have not placed any restriction on its use or reproduction.
- *
- * Although all reasonable efforts have been taken to ensure the accuracy
- * and reliability of the software and data, the NLM and the U.S.
- * Government do not and cannot warrant the performance or results that
- * may be obtained by using this software or data. The NLM and the U.S.
- * Government disclaim all warranties, express or implied, including
- * warranties of performance, merchantability or fitness for any particular
- * purpose.
- *
- * Please cite the author in any work or product based on this material.
- *
- * ===========================================================================
- *
- * Author: Aaron Ucko, NCBI
- *
- * File Description:
- * Entrez2 network client
- *
- * Remark:
- * This code was originally generated by application DATATOOL
- * using specifications from the data definition file
- * 'entrez2.asn'.
- */
- #ifndef OBJECTS_ENTREZ2_ENTREZ2_CLIENT_HPP
- #define OBJECTS_ENTREZ2_ENTREZ2_CLIENT_HPP
- // generated includes
- #include <objects/entrez2/entrez2_client_.hpp>
- #include <objects/entrez2/Entrez2_link_set.hpp>
- #include <objects/entrez2/Entrez2_link_count_list.hpp>
- // generated classes
- BEGIN_NCBI_SCOPE
- BEGIN_objects_SCOPE // namespace ncbi::objects::
- class NCBI_ENTREZ2_EXPORT CEntrez2Client : public CEntrez2Client_Base
- {
- typedef CEntrez2Client_Base Tparent;
- public:
- // constructor
- CEntrez2Client(void);
- // destructor
- ~CEntrez2Client(void);
- /// A simplified interface for getting neighbors (links)
-
- /// Get ids of neigbors of a specified type.
- /// db is, e.g., "nucleotide" or "protein" (depending on the query).
- /// link_type is, for example, "nucleotide_nucleotide".
- /// This form just yields a vector of UIDs
- void GetNeighbors(int query_uid, const string& db,
- const string& link_type,
- vector<int>& neighbor_uids);
- /// This form just yields a vector of UIDs, taking a vector of UIDs
- void GetNeighbors(const vector<int>& query_uids,
- const string& db,
- const string& link_type,
- vector<int>& neighbor_uids);
- /// This form returns the entire CEntrez2_link_set object,
- /// which includes scores.
- CRef<CEntrez2_link_set> GetNeighbors(int query_uid,
- const string& db,
- const string& link_type);
- /// This form returns the entire CEntrez2_link_set object,
- /// which includes scores.
- CRef<CEntrez2_link_set> GetNeighbors(const vector<int>& query_uids,
- const string& db,
- const string& link_type);
- /// Retrieve counts of the various types of neighbors available
- CRef<CEntrez2_link_count_list> GetNeighborCounts(int query_uid,
- const string& db);
-
- /// Some other simplified interfaces
- /// Query a db with a string, returning uids as integers
- void Query(const string& query, const string& db,
- vector<int>& result_uids);
- /// Given some uids, a database, and an entrez query string,
- /// determine which of these uids match the query string
- void FilterIds(const vector<int>& query_uids, const string& db,
- const string& query_string,
- vector<int>& result_uids);
- private:
- // Prohibit copy constructor and assignment operator
- CEntrez2Client(const CEntrez2Client& value);
- CEntrez2Client& operator=(const CEntrez2Client& value);
- };
- /////////////////// CEntrez2Client inline methods
- // constructor
- inline
- CEntrez2Client::CEntrez2Client(void)
- {
- SetDefaultRequest().SetTool("CEntrez2Client");
- SetDefaultRequest().SetVersion(1);
- }
- /////////////////// end of CEntrez2Client inline methods
- END_objects_SCOPE // namespace ncbi::objects::
- END_NCBI_SCOPE
- /*
- * ===========================================================================
- *
- * $Log: entrez2_client.hpp,v $
- * Revision 1000.1 2004/04/12 17:23:37 gouriano
- * PRODUCTION: UPGRADED [CATCHUP_003] Dev-tree R1.6
- *
- * Revision 1.6 2004/03/11 17:25:05 dicuccio
- * Added API to retrieve neighbors for multiple UIDs at once
- *
- * Revision 1.5 2004/01/20 05:36:56 jcherry
- * Added missing '&' on argument to FilterIds (pass by reference)
- *
- * Revision 1.4 2003/10/16 20:10:24 jcherry
- * Added some simplified interfaces for querying
- *
- * Revision 1.3 2003/10/08 19:18:01 jcherry
- * Added a simplified interface for getting neighbors
- *
- * Revision 1.2 2003/07/31 16:43:58 dicuccio
- * Added missing export specifier
- *
- * Revision 1.1 2003/04/09 16:00:12 ucko
- * Give all RPC clients unique basenames.
- *
- * Revision 1.1 2002/11/13 20:13:41 ucko
- * Add datatool-generated client classes
- *
- *
- * ===========================================================================
- */
- #endif // OBJECTS_ENTREZ2_ENTREZ2_CLIENT_HPP
- /* Original file checksum: lines: 93, chars: 2440, CRC32: 16aa1713 */