NCBI C++ ToolKit
seqsrc_query_factory.hpp
Go to the documentation of this file.

Go to the SVN repository for this file.

1 #ifndef ALGO_BLAST_API___SEQSRC_QUERY_FACTORY__HPP
2 #define ALGO_BLAST_API___SEQSRC_QUERY_FACTORY__HPP
3 
4 /* $Id: seqsrc_query_factory.hpp 50220 2011-06-28 14:54:16Z camacho $
5  * ===========================================================================
6  *
7  * PUBLIC DOMAIN NOTICE
8  * National Center for Biotechnology Information
9  *
10  * This software/database is a "United States Government Work" under the
11  * terms of the United States Copyright Act. It was written as part of
12  * the author's official duties as a United States Government employee and
13  * thus cannot be copyrighted. This software/database is freely available
14  * to the public for use. The National Library of Medicine and the U.S.
15  * Government have not placed any restriction on its use or reproduction.
16  *
17  * Although all reasonable efforts have been taken to ensure the accuracy
18  * and reliability of the software and data, the NLM and the U.S.
19  * Government do not and cannot warrant the performance or results that
20  * may be obtained by using this software or data. The NLM and the U.S.
21  * Government disclaim all warranties, express or implied, including
22  * warranties of performance, merchantability or fitness for any particular
23  * purpose.
24  *
25  * Please cite the author in any work or product based on this material.
26  *
27  * ===========================================================================
28  *
29  * Author: Christiam Camacho
30  *
31  */
32 
33 /// @file seqsrc_query_factory.hpp
34 /// Implementation of the BlastSeqSrc interface for a query factory
35 
39 
40 /** @addtogroup AlgoBlast
41  *
42  * @{
43  */
44 
46 BEGIN_SCOPE(blast)
47 
48 /** Initialize the sequence source structure from a query factory.
49  * @param query_factory Factory from which the queries will be manufactured [in]
50  * @param program Type of BLAST to be performed [in]
51  */
54  EBlastProgramType program);
55 
56 /** Initialize the sequence source structure from a TSeqLocVector.
57  * @param subj_seqs TSeqLocVector object from which the queries will be
58  * manufactured [in]
59  * @param program Type of BLAST to be performed [in]
60  * @note this is deprecated, use MultiSeqBlastSeqSrcInit instead
61  */
65  EBlastProgramType program);
66 END_SCOPE(blast)
68 
69 /* @} */
70 
71 #endif /* ALGO_BLAST_API___SEQSRC_QUERY_FACTORY__HPP */
#define NCBI_XBLAST_EXPORT
NULL operations for other cases.
Definition: blast_export.h:65
EBlastProgramType
Defines the engine's notion of the different applications of the BLAST algorithm.
Definition: blast_program.h:72
Declaration of ADT to retrieve sequences for the BLAST engine.
BlastSeqSrc * QueryFactoryBlastSeqSrcInit(CRef< IQueryFactory > query_factory, EBlastProgramType program)
Initialize the sequence source structure from a query factory.
#define NCBI_DEPRECATED
#define END_NCBI_SCOPE
End previously defined NCBI scope.
Definition: ncbistl.hpp:103
#define END_SCOPE(ns)
End the previously defined scope.
Definition: ncbistl.hpp:75
#define BEGIN_NCBI_SCOPE
Define ncbi namespace.
Definition: ncbistl.hpp:100
#define BEGIN_SCOPE(ns)
Define a new scope.
Definition: ncbistl.hpp:72
NOTE: This file contains work in progress and the APIs are likely to change, please do not rely on th...
Definition of SSeqLoc structure.
vector< SSeqLoc > TSeqLocVector
Vector of sequence locations.
Definition: sseqloc.hpp:129
Complete type definition of Blast Sequence Source ADT.
Definition: blast_seqsrc.c:43
Modified on Wed Apr 17 13:09:09 2024 by modify_doxy.py rev. 669887