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

生物技术

开发平台:

C/C++

  1. /*
  2.  * ===========================================================================
  3.  * PRODUCTION $Log: queue_poll.hpp,v $
  4.  * PRODUCTION Revision 1000.0  2004/04/12 17:55:07  gouriano
  5.  * PRODUCTION PRODUCTION: IMPORTED [CATCHUP_003] Dev-tree R1.1
  6.  * PRODUCTION
  7.  * ===========================================================================
  8.  */
  9. #ifndef ALGO_BLAST_API_DEMO___QUEUE_POLL__HPP
  10. #define ALGO_BLAST_API_DEMO___QUEUE_POLL__HPP
  11. /*  $Id: queue_poll.hpp,v 1000.0 2004/04/12 17:55:07 gouriano Exp $
  12.  * ===========================================================================
  13.  *
  14.  *                            PUBLIC DOMAIN NOTICE
  15.  *               National Center for Biotechnology Information
  16.  *
  17.  *  This software/database is a "United States Government Work" under the
  18.  *  terms of the United States Copyright Act.  It was written as part of
  19.  *  the author's official duties as a United States Government employee and
  20.  *  thus cannot be copyrighted.  This software/database is freely available
  21.  *  to the public for use. The National Library of Medicine and the U.S.
  22.  *  Government have not placed any restriction on its use or reproduction.
  23.  *
  24.  *  Although all reasonable efforts have been taken to ensure the accuracy
  25.  *  and reliability of the software and data, the NLM and the U.S.
  26.  *  Government do not and cannot warrant the performance or results that
  27.  *  may be obtained by using this software or data. The NLM and the U.S.
  28.  *  Government disclaim all warranties, express or implied, including
  29.  *  warranties of performance, merchantability or fitness for any particular
  30.  *  purpose.
  31.  *
  32.  *  Please cite the author in any work or product based on this material.
  33.  *
  34.  * ===========================================================================
  35.  *
  36.  * Author:  Kevin Bealer
  37.  */
  38. /// @file queue_poll.hpp
  39. /// Queueing and Polling code for remote_blast.
  40. ///
  41. /// This contains the interface of queueing and polling code for remote_blast.
  42. /// There is only one function interface.  The goal of this interface is to
  43. /// seperate the computational / network code from the UI (CNcbiApplication).
  44. #include "search_opts.hpp"
  45. #include "align_parms.hpp"
  46. USING_NCBI_SCOPE;
  47. /// Queue the request with the given parameters; poll and display the results.
  48. ///
  49. /// This function does the bulk of the work for the remote_blast program.  It
  50. /// queues the search, waits for processing, retrieves the results, and
  51. /// displays the output.
  52. /// @param program       Program to run (e.g. blastp, blastn...).
  53. /// @param service       Service to run (e.g. plain, rpsblast, megablast...).
  54. /// @param database      Database to search (nr, nt, pdb, etc).
  55. /// @param opts          Optional netblast parameters.
  56. /// @param verbose       Debugging output - displays netblast socket traffic.
  57. /// @param trust_defline Assume sequence and defline are consistent with db.
  58. /// @param raw_asn       Display text ASN.1, not formatted output.
  59. /// @param alparms       Parameters to control output formatting.
  60. Int4 QueueAndPoll(string                program,
  61.                   string                service,
  62.                   string                database,
  63.                   CNetblastSearchOpts & opts,
  64.                   CNcbiIstream        & query_in,
  65.                   bool                  verbose,
  66.                   bool                  trust_defline,
  67.                   bool                  raw_asn,
  68.                   CAlignParms         & alparms,
  69.                   bool                  async_mode,
  70.                   string                get_RID);
  71. /*
  72.  * ===========================================================================
  73.  *
  74.  * $Log: queue_poll.hpp,v $
  75.  * Revision 1000.0  2004/04/12 17:55:07  gouriano
  76.  * PRODUCTION: IMPORTED [CATCHUP_003] Dev-tree R1.1
  77.  *
  78.  * Revision 1.1  2004/02/18 17:04:42  bealer
  79.  * - Adapt blast_client code for Remote Blast API, merging code into the
  80.  *   remote_blast demo application.
  81.  *
  82.  * ===========================================================================
  83.  */
  84. #endif // ALGO_BLAST_API_DEMO___QUEUE_POLL__HPP