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

生物技术

开发平台:

C/C++

  1. /*
  2.  * ===========================================================================
  3.  * PRODUCTION $Log: tblastn_options.hpp,v $
  4.  * PRODUCTION Revision 1000.2  2004/06/01 18:03:12  gouriano
  5.  * PRODUCTION PRODUCTION: UPGRADED [GCC34_MSVC7] Dev-tree R1.8
  6.  * PRODUCTION
  7.  * ===========================================================================
  8.  */
  9. #ifndef ALGO_BLAST_API___TBLASTN_OPTIONS__HPP
  10. #define ALGO_BLAST_API___TBLASTN_OPTIONS__HPP
  11. /*  $Id: tblastn_options.hpp,v 1000.2 2004/06/01 18:03:12 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 tblastn_options.hpp
  40. /// Declares the CTBlastnOptionsHandle class.
  41. #include <algo/blast/api/blast_prot_options.hpp>
  42. /** @addtogroup AlgoBlast
  43.  *
  44.  * @{
  45.  */
  46. BEGIN_NCBI_SCOPE
  47. BEGIN_SCOPE(blast)
  48. /// Handle to the protein-translated nucleotide options to the BLAST algorithm.
  49. ///
  50. /// Adapter class for protein-translated nucleotide BLAST comparisons.
  51. /// Exposes an interface to allow manipulation the options that are relevant to
  52. /// this type of search.
  53. class NCBI_XBLAST_EXPORT CTBlastnOptionsHandle : 
  54.                                             public CBlastProteinOptionsHandle
  55. {
  56. public:
  57.     /// Creates object with default options set
  58.     CTBlastnOptionsHandle(EAPILocality locality = CBlastOptions::eLocal);
  59.     ~CTBlastnOptionsHandle() {}
  60.     /************************ Scoring options ************************/
  61.     // is this needed or can we use a sentinel for the frame shift penalty?
  62.     bool GetOutOfFrameMode() const { return m_Opts->GetOutOfFrameMode(); }
  63.     void SetOutOfFrameMode(bool m = true) { m_Opts->SetOutOfFrameMode(m); }
  64.     int GetFrameShiftPenalty() const { return m_Opts->GetFrameShiftPenalty(); }
  65.     void SetFrameShiftPenalty(int p) { m_Opts->SetFrameShiftPenalty(p); }
  66.     int GetLongestIntronLength() const { return m_Opts->GetLongestIntronLength(); }
  67.     void SetLongestIntronLength(int l) { m_Opts->SetLongestIntronLength(l); }
  68.     /******************* Subject sequence options *******************/
  69.     int GetDbGeneticCode() const {
  70.         return m_Opts->GetDbGeneticCode();
  71.     }
  72.     void SetDbGeneticCode(int gc) {
  73.         m_Opts->SetDbGeneticCode(gc);
  74.     }
  75. protected:
  76.     void SetLookupTableDefaults();
  77.     void SetScoringOptionsDefaults();
  78.     void SetHitSavingOptionsDefaults();
  79.     void SetSubjectSequenceOptionsDefaults();
  80. private:
  81.     CTBlastnOptionsHandle(const CTBlastnOptionsHandle& rhs);
  82.     CTBlastnOptionsHandle& operator=(const CTBlastnOptionsHandle& rhs);
  83. };
  84. END_SCOPE(blast)
  85. END_NCBI_SCOPE
  86. /* @} */
  87. /*
  88.  * ===========================================================================
  89.  * $Log: tblastn_options.hpp,v $
  90.  * Revision 1000.2  2004/06/01 18:03:12  gouriano
  91.  * PRODUCTION: UPGRADED [GCC34_MSVC7] Dev-tree R1.8
  92.  *
  93.  * Revision 1.8  2004/05/04 13:09:20  camacho
  94.  * Made copy-ctor & assignment operator private
  95.  *
  96.  * Revision 1.7  2004/03/19 14:53:24  camacho
  97.  * Move to doxygen group AlgoBlast
  98.  *
  99.  * Revision 1.6  2004/01/20 15:19:25  camacho
  100.  * Provide missing default parameters to default ctor
  101.  *
  102.  * Revision 1.5  2004/01/16 20:42:57  bealer
  103.  * - Add locality flag for blast options handle classes.
  104.  *
  105.  * Revision 1.4  2003/12/15 18:42:06  dondosha
  106.  * Added longest intron length setter/getter
  107.  *
  108.  * Revision 1.3  2003/12/09 12:40:23  camacho
  109.  * Added windows export specifiers
  110.  *
  111.  * Revision 1.2  2003/12/03 16:34:58  dondosha
  112.  * SetDbGeneticCode now fills both integer and string option
  113.  *
  114.  * Revision 1.1  2003/11/26 18:22:18  camacho
  115.  * +Blast Option Handle classes
  116.  *
  117.  * ===========================================================================
  118.  */
  119. #endif  /* ALGO_BLAST_API___TBLASTN_OPTIONS__HPP */