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

生物技术

开发平台:

C/C++

  1. /*
  2.  * ===========================================================================
  3.  * PRODUCTION $Log: prot_to_neighbors.hpp,v $
  4.  * PRODUCTION Revision 1000.5  2004/04/12 19:28:16  gouriano
  5.  * PRODUCTION PRODUCTION: UPGRADED [CATCHUP_003] Dev-tree R1.11
  6.  * PRODUCTION
  7.  * ===========================================================================
  8.  */
  9. #ifndef GUI_PLUGINS_ALGO_ALIGN___PROT_TO_NEIGHBORS__HPP
  10. #define GUI_PLUGINS_ALGO_ALIGN___PROT_TO_NEIGHBORS__HPP
  11. /*  $Id: prot_to_neighbors.hpp,v 1000.5 2004/04/12 19:28:16 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:  Mike DiCuccio
  37.  *
  38.  * File Description:
  39.  *
  40.  */
  41. #include <gui/core/algo_thread.hpp>
  42. #include <gui/core/version.hpp>
  43. #include "align_to_neighbors.hpp"
  44. #include "blast_util.hpp"
  45. BEGIN_NCBI_SCOPE
  46. USING_SCOPE(objects);
  47. class CAlgoPlugin_AlignProtToNeighbors
  48.     : public CAlignToNeighbors,
  49.       public CAlgorithm<CAlgoPlugin_AlignProtToNeighbors>
  50. {
  51. public:
  52.     void RunCommand(CPluginMessage& msg);
  53.     // standard info boilerplate
  54.     static void GetInfo(CPluginInfo& info);
  55. };
  56. inline void
  57. CAlgoPlugin_AlignProtToNeighbors::RunCommand(CPluginMessage& msg)
  58. {
  59.     CAlignToNeighbors::Run(msg);
  60. }
  61. // standard info boilerplate
  62. inline
  63. void CAlgoPlugin_AlignProtToNeighbors::GetInfo(CPluginInfo& info)
  64. {
  65.     info.Reset();
  66.     // version info macro
  67.     info.SetInfo(CPluginVersion::eMajor, CPluginVersion::eMinor, 0,
  68.                  string(__DATE__) + " " + string(__TIME__),
  69.                  "CAlgoPlugin_AlignProtToNeighbors",
  70.                  "Alignments/Align protein to Entrez neighbors",
  71.                  "Create an alignment of a protein sequence "
  72.                  "to its related sequences",
  73.                  "");
  74.     // command info
  75.     CPluginCommandSet& cmds = info.SetCommands();
  76.     CPluginCommand&    args = cmds.AddAlgoCommand(eAlgoCommand_run);
  77.     args.AddArgument("cds_feat", "Protein sequence",
  78.                      CSeq_feat::GetTypeInfo());
  79.     args.SetConstraint("cds_feat",
  80.                        (*CPluginValueConstraint::CreateFeatType(),
  81.                         CSeqFeatData::e_Cdregion));
  82.     args.AddConstraint("cds_feat",
  83.                        *CPluginValueConstraint::CreateFeatProduct());
  84.     CBlastUtils::AddBlastArgs(args, blast::eBlastp);
  85.     args.AddDefaultArgument("neighbor_filter",
  86.                             "Which entrez neighbors",
  87.                             CPluginArg::eString, "all");
  88.     args.SetConstraint("neighbor_filter",
  89.                        (*CPluginValueConstraint::CreateSet(),
  90.                         "all",
  91.                         "arbitrary query string (below)"));
  92.     args.AddOptionalArgument("query_string",
  93.                              "Entrez query for filtering",
  94.                              CPluginArg::eString);
  95.     // pass to the base class standard arg function
  96.     //x_AddStandardArgs(args);
  97. }
  98. END_NCBI_SCOPE
  99. /*
  100.  * ===========================================================================
  101.  * $Log: prot_to_neighbors.hpp,v $
  102.  * Revision 1000.5  2004/04/12 19:28:16  gouriano
  103.  * PRODUCTION: UPGRADED [CATCHUP_003] Dev-tree R1.11
  104.  *
  105.  * Revision 1.11  2004/04/07 12:57:49  dicuccio
  106.  * Formatting changes
  107.  *
  108.  * Revision 1.10  2004/03/05 17:33:44  dicuccio
  109.  * Changed plugin to run single-threaded until thread issues can be sorted out.
  110.  * Use sequence::GetId() instead of CSeq_id::GetStringDescr()
  111.  *
  112.  * Revision 1.9  2004/01/27 18:40:27  dicuccio
  113.  * Code clean-up.  Renamed plugin classes to follow standard pattern
  114.  *
  115.  * Revision 1.8  2004/01/13 20:37:41  dicuccio
  116.  * Use CBlastUtils for standard blast argument processing
  117.  *
  118.  * Revision 1.7  2003/11/26 17:12:30  dicuccio
  119.  * Switched to use CThreadedAlgorithm<>
  120.  *
  121.  * Revision 1.6  2003/11/24 15:45:23  dicuccio
  122.  * Renamed CVersion to CPluginVersion
  123.  *
  124.  * Revision 1.5  2003/11/06 20:12:12  dicuccio
  125.  * Cleaned up handling of USING_SCOPE - removed from all headers
  126.  *
  127.  * Revision 1.4  2003/11/04 17:49:22  dicuccio
  128.  * Changed calling parameters for plugins - pass CPluginMessage instead of paired
  129.  * CPluginCommand/CPluginReply
  130.  *
  131.  * Revision 1.3  2003/10/17 17:45:40  jcherry
  132.  * Default E-values -> 0.05
  133.  *
  134.  * Revision 1.2  2003/10/16 21:52:07  jcherry
  135.  * Added filtering of neighbors
  136.  *
  137.  * Revision 1.1  2003/10/15 18:17:07  dicuccio
  138.  * Split algo into two front-ends (one for mRNA, one for proteins)
  139.  *
  140.  * ===========================================================================
  141.  */
  142. #endif  // GUI_PLUGINS_ALGO_ALIGN___PROT_TO_NEIGHBORS__HPP