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

生物技术

开发平台:

C/C++

  1. /*
  2.  * ===========================================================================
  3.  * PRODUCTION $Log: blast_prot_options.hpp,v $
  4.  * PRODUCTION Revision 1000.2  2004/06/01 18:02:45  gouriano
  5.  * PRODUCTION PRODUCTION: UPGRADED [GCC34_MSVC7] Dev-tree R1.7
  6.  * PRODUCTION
  7.  * ===========================================================================
  8.  */
  9. #ifndef ALGO_BLAST_API___BLAST_PROT_OPTIONS__HPP
  10. #define ALGO_BLAST_API___BLAST_PROT_OPTIONS__HPP
  11. /*  $Id: blast_prot_options.hpp,v 1000.2 2004/06/01 18:02:45 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 blast_prot_options.hpp
  40. /// Declares the CBlastProteinOptionsHandle class.
  41. #include <algo/blast/api/blast_options_handle.hpp>
  42. /** @addtogroup AlgoBlast
  43.  *
  44.  * @{
  45.  */
  46. BEGIN_NCBI_SCOPE
  47. BEGIN_SCOPE(blast)
  48. /// Handle to the protein-protein options to the BLAST algorithm.
  49. ///
  50. /// Adapter class for protein-protein 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 CBlastProteinOptionsHandle : 
  54.                                             public CBlastOptionsHandle
  55. {
  56. public:
  57.     
  58.     /// Creates object with default options set
  59.     CBlastProteinOptionsHandle(EAPILocality locality = CBlastOptions::eLocal);
  60.     ~CBlastProteinOptionsHandle() {}
  61.     /******************* Lookup table options ***********************/
  62.     int GetWordThreshold() const { return m_Opts->GetWordThreshold(); }
  63.     void SetWordThreshold(int wt) { m_Opts->SetWordThreshold(wt); }
  64.     short GetWordSize() const { return m_Opts->GetWordSize(); }
  65.     void SetWordSize(short ws) { m_Opts->SetWordSize(ws); }
  66.     /******************* Initial word options ***********************/
  67.     int GetWindowSize() const { return m_Opts->GetWindowSize(); }
  68.     void SetWindowSize(int ws) { m_Opts->SetWindowSize(ws); }
  69.     double GetXDropoff() const { return m_Opts->GetXDropoff(); } 
  70.     void SetXDropoff(double x) { m_Opts->SetXDropoff(x); }
  71.     /******************* Gapped extension options *******************/
  72.     double GetGapXDropoffFinal() const { 
  73.         return m_Opts->GetGapXDropoffFinal(); 
  74.     }
  75.     void SetGapXDropoffFinal(double x) { m_Opts->SetGapXDropoffFinal(x); }
  76.     /************************ Scoring options ************************/
  77.     const char* GetMatrixName() const { return m_Opts->GetMatrixName(); }
  78.     void SetMatrixName(const char* matrix) { m_Opts->SetMatrixName(matrix); }
  79.     const char* GetMatrixPath() const { return m_Opts->GetMatrixPath(); }
  80.     void SetMatrixPath(const char* path) { m_Opts->SetMatrixPath(path); }
  81.     int GetGapOpeningCost() const { return m_Opts->GetGapOpeningCost(); }
  82.     void SetGapOpeningCost(int g) { m_Opts->SetGapOpeningCost(g); }
  83.     int GetGapExtensionCost() const { return m_Opts->GetGapExtensionCost(); }
  84.     void SetGapExtensionCost(int e) { m_Opts->SetGapExtensionCost(e); }
  85.     Int8 GetEffectiveSearchSpace() const { 
  86.         return m_Opts->GetEffectiveSearchSpace(); 
  87.     }
  88.     void SetEffectiveSearchSpace(Int8 eff) {
  89.         m_Opts->SetEffectiveSearchSpace(eff);
  90.     }
  91.     bool GetUseRealDbSize() const { return m_Opts->GetUseRealDbSize(); }
  92.     void SetUseRealDbSize(bool u = true) { m_Opts->SetUseRealDbSize(u); }
  93. protected:
  94.     virtual void SetLookupTableDefaults();
  95.     virtual void SetQueryOptionDefaults();
  96.     virtual void SetInitialWordOptionsDefaults();
  97.     virtual void SetGappedExtensionDefaults();
  98.     virtual void SetScoringOptionsDefaults();
  99.     virtual void SetHitSavingOptionsDefaults();
  100.     virtual void SetEffectiveLengthsOptionsDefaults();
  101.     virtual void SetSubjectSequenceOptionsDefaults(); 
  102. private:
  103.     CBlastProteinOptionsHandle(const CBlastProteinOptionsHandle& rhs);
  104.     CBlastProteinOptionsHandle& operator=(const CBlastProteinOptionsHandle& rhs);
  105. };
  106. END_SCOPE(blast)
  107. END_NCBI_SCOPE
  108. /* @} */
  109. /*
  110.  * ===========================================================================
  111.  * $Log: blast_prot_options.hpp,v $
  112.  * Revision 1000.2  2004/06/01 18:02:45  gouriano
  113.  * PRODUCTION: UPGRADED [GCC34_MSVC7] Dev-tree R1.7
  114.  *
  115.  * Revision 1.7  2004/05/04 13:09:20  camacho
  116.  * Made copy-ctor & assignment operator private
  117.  *
  118.  * Revision 1.6  2004/03/19 14:53:24  camacho
  119.  * Move to doxygen group AlgoBlast
  120.  *
  121.  * Revision 1.5  2004/03/10 14:55:02  madden
  122.  * Added methods for get/set matrix, matrix-path, gap-opening, gap-extension
  123.  *
  124.  * Revision 1.4  2004/01/16 20:44:08  bealer
  125.  * - Add locality flag for options handle classes.
  126.  *
  127.  * Revision 1.3  2003/12/15 23:41:36  dondosha
  128.  * Added [gs]etters of database (subject) length and number of sequences to general options handle
  129.  *
  130.  * Revision 1.2  2003/12/09 12:40:22  camacho
  131.  * Added windows export specifiers
  132.  *
  133.  * Revision 1.1  2003/11/26 18:22:16  camacho
  134.  * +Blast Option Handle classes
  135.  *
  136.  * ===========================================================================
  137.  */
  138. #endif  /* ALGO_BLAST_API___BLAST_PROT_OPTIONS__HPP */