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

生物技术

开发平台:

C/C++

  1. /*
  2.  * ===========================================================================
  3.  * PRODUCTION $Log: seqdb_src.hpp,v $
  4.  * PRODUCTION Revision 1000.1  2004/06/01 18:03:10  gouriano
  5.  * PRODUCTION PRODUCTION: UPGRADED [GCC34_MSVC7] Dev-tree R1.3
  6.  * PRODUCTION
  7.  * ===========================================================================
  8.  */
  9. #ifndef ALGO_BLAST_API___SEQDB_SRC__HPP
  10. #define ALGO_BLAST_API___SEQDB_SRC__HPP
  11. /*  $Id: seqdb_src.hpp,v 1000.1 2004/06/01 18:03:10 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:  Ilya Dondoshansky
  37.  *
  38.  */
  39. /// @file seqdb_src.hpp
  40. /// Implementation of the BlastSeqSrc interface using the C++ BLAST databases
  41. /// API
  42. #include <algo/blast/core/blast_seqsrc.h>
  43. #include <algo/blast/core/blast_def.h>
  44. #include <algo/blast/api/blast_types.hpp>
  45. /** @addtogroup AlgoBlast
  46.  *
  47.  * @{
  48.  */
  49. BEGIN_NCBI_SCOPE
  50. BEGIN_SCOPE(blast)
  51. /// Encapsulates the arguments needed to initialize multi-sequence source.
  52. struct SSeqDbSrcNewArgs {
  53.     char* dbname;     /**< Database name */
  54.     bool is_protein; /**< Is this database protein? */
  55.     Int4 first_db_seq; /**< Ordinal id of the first sequence to search */
  56.     Int4 final_db_seq; /**< Ordinal id of the last sequence to search */
  57. };
  58. extern "C" {
  59. /** SeqDb sequence source constructor 
  60.  * @param bssp BlastSeqSrc structure (already allocated) to populate [in]
  61.  * @param args Pointer to SSeqDbSrcNewArgs structure above [in]
  62.  * @return Updated bssp structure (with all function pointers initialized
  63.  */
  64. BlastSeqSrc* SeqDbSrcNew(BlastSeqSrc* bssp, void* args);
  65. /** SeqDb sequence source destructor: frees its internal data structure and the
  66.  * BlastSeqSrc structure itself.
  67.  * @param bssp BlastSeqSrc structure to free [in]
  68.  * @return NULL
  69.  */
  70. BlastSeqSrc* SeqDbSrcFree(BlastSeqSrc* bssp);
  71. }
  72. /** Initialize the sequence source structure.
  73.  * @param dbname BLAST database name [in]
  74.  * @param is_prot Is this a protein or nucleotide database? [in]
  75.  * @param first_seq First ordinal id in the database to search [in]
  76.  * @param last_seq Last ordinal id in the database to search 
  77.  *                 (full database if 0) [in]
  78.  * @param extra_arg Reserved for the future implementation of other database
  79.  *                  restrictions [in]
  80.  */
  81. BlastSeqSrc* 
  82. SeqDbSrcInit(const char* dbname, Boolean is_prot, int first_seq, 
  83.              int last_seq, void* extra_arg);
  84. END_SCOPE(blast)
  85. END_NCBI_SCOPE
  86. /* @} */
  87. /*
  88.  * ===========================================================================
  89.  * $Log: seqdb_src.hpp,v $
  90.  * Revision 1000.1  2004/06/01 18:03:10  gouriano
  91.  * PRODUCTION: UPGRADED [GCC34_MSVC7] Dev-tree R1.3
  92.  *
  93.  * Revision 1.3  2004/05/19 14:52:00  camacho
  94.  * 1. Added doxygen tags to enable doxygen processing of algo/blast/core
  95.  * 2. Standardized copyright, CVS $Id string, $Log and rcsid formatting and i
  96.  *    location
  97.  * 3. Added use of @todo doxygen keyword
  98.  *
  99.  * Revision 1.2  2004/04/08 14:46:06  camacho
  100.  * Added missing extern "C" declarations"
  101.  *
  102.  * Revision 1.1  2004/04/06 20:43:54  dondosha
  103.  * Sequence source for CSeqDB BLAST database interface
  104.  *
  105.  * ===========================================================================
  106.  */
  107. #endif /* ALGO_BLAST_API___SEQDB_SRC__HPP */