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

生物技术

开发平台:

C/C++

  1. /*
  2.  * ===========================================================================
  3.  * PRODUCTION $Log: disc_nucl_options.hpp,v $
  4.  * PRODUCTION Revision 1000.2  2004/06/01 18:03:02  gouriano
  5.  * PRODUCTION PRODUCTION: UPGRADED [GCC34_MSVC7] Dev-tree R1.8
  6.  * PRODUCTION
  7.  * ===========================================================================
  8.  */
  9. #ifndef ALGO_BLAST_API___DISC_NUCL_OPTIONS__HPP
  10. #define ALGO_BLAST_API___DISC_NUCL_OPTIONS__HPP
  11. /*  $Id: disc_nucl_options.hpp,v 1000.2 2004/06/01 18:03:02 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.  * Authors:  Christiam Camacho
  37.  *
  38.  */
  39. /// @file disc_nucl_options.hpp
  40. /// Declares the CDiscNucleotideOptionsHandle class.
  41. #include <algo/blast/api/blast_nucl_options.hpp>
  42. /** @addtogroup AlgoBlast
  43.  *
  44.  * @{
  45.  */
  46. BEGIN_NCBI_SCOPE
  47. BEGIN_SCOPE(blast)
  48. /// Handle to the nucleotide-nucleotide options to the discontiguous 
  49. /// BLAST algorithm.
  50. ///
  51. /// Adapter class for nucleotide-nucleotide discontiguous BLAST comparisons.
  52. /// Exposes an interface to allow manipulation the options that are relevant to
  53. /// this type of search.
  54. class NCBI_XBLAST_EXPORT CDiscNucleotideOptionsHandle : 
  55.                                             public CBlastNucleotideOptionsHandle
  56. {
  57. public:
  58.     /// Creates object with default options set
  59.     CDiscNucleotideOptionsHandle(EAPILocality locality = CBlastOptions::eLocal);
  60.     ~CDiscNucleotideOptionsHandle() {}
  61.     /******************* Lookup table options ***********************/
  62.     unsigned char GetTemplateLength() const { 
  63.         return m_Opts->GetMBTemplateLength();
  64.     }
  65.     void SetTemplateLength(unsigned char length) {
  66.         m_Opts->SetMBTemplateLength(length);
  67.     }
  68.     unsigned char GetTemplateType() const { 
  69.         return m_Opts->GetMBTemplateType();
  70.     }
  71.     void SetTemplateType(unsigned char type) {
  72.         m_Opts->SetMBTemplateType(type);
  73.     }
  74.     void SetWordSize(short ws) { 
  75.         if (ws == 11 || ws == 12) {
  76.             m_Opts->SetWordSize(ws); 
  77.         } else {
  78.             NCBI_THROW(CBlastException, eBadParameter, 
  79.                        "Word size must be 11 or 12 only");
  80.         }
  81.     }
  82.     // Unavailable for discontiguous megablast, throws a CBlastException
  83.     void SetTraditionalBlastnDefaults();
  84. protected:
  85.     void SetMBLookupTableDefaults();
  86.     void SetMBInitialWordOptionsDefaults();
  87.     void SetMBGappedExtensionDefaults();
  88.     void SetMBScoringOptionsDefaults();
  89. private:
  90.     CDiscNucleotideOptionsHandle(const CDiscNucleotideOptionsHandle& rhs);
  91.     CDiscNucleotideOptionsHandle& operator=(const CDiscNucleotideOptionsHandle& rhs);
  92. };
  93. END_SCOPE(blast)
  94. END_NCBI_SCOPE
  95. /* @} */
  96. /*
  97.  * ===========================================================================
  98.  * $Log: disc_nucl_options.hpp,v $
  99.  * Revision 1000.2  2004/06/01 18:03:02  gouriano
  100.  * PRODUCTION: UPGRADED [GCC34_MSVC7] Dev-tree R1.8
  101.  *
  102.  * Revision 1.8  2004/05/04 13:09:20  camacho
  103.  * Made copy-ctor & assignment operator private
  104.  *
  105.  * Revision 1.7  2004/03/22 20:15:58  dondosha
  106.  * Added custom setting of MB scoring options for discontiguous case
  107.  *
  108.  * Revision 1.6  2004/03/19 14:53:24  camacho
  109.  * Move to doxygen group AlgoBlast
  110.  *
  111.  * Revision 1.5  2004/03/17 21:48:30  dondosha
  112.  * Added custom SetMBInitialWordOptionsDefaults and SetMBGappedExtensionDefaults methods
  113.  *
  114.  * Revision 1.4  2004/01/20 15:19:25  camacho
  115.  * Provide missing default parameters to default ctor
  116.  *
  117.  * Revision 1.3  2004/01/16 20:44:08  bealer
  118.  * - Add locality flag for options handle classes.
  119.  *
  120.  * Revision 1.2  2003/12/09 12:40:22  camacho
  121.  * Added windows export specifiers
  122.  *
  123.  * Revision 1.1  2003/11/26 18:22:17  camacho
  124.  * +Blast Option Handle classes
  125.  *
  126.  * ===========================================================================
  127.  */
  128. #endif  /* ALGO_BLAST_API___DISC_NUCL_OPTIONS__HPP */