开通博客赚积分
发布资源赚积分
分类

源码开发语言/平台
当前位置：首页 > 源码/资料 > 数值算法/人工智能 > 生物技术 > 查看源码
utils.hpp
资源名称：ncbi_cxx_win--Jul_08_2004.zip　[点击查看]
上传用户：yhdzpy8989
上传日期：2007-06-13
资源大小：13604k
文件大小：11k
源码类别：

生物技术

开发平台：

C/C++

utils.hpp：源码内容
  1. /*
  2.  * ===========================================================================
  3.  * PRODUCTION $Log: utils.hpp,v $
  4.  * PRODUCTION Revision 1000.0  2004/06/01 19:56:12  gouriano
  5.  * PRODUCTION PRODUCTION: IMPORTED [GCC34_MSVC7] Dev-tree R1.6
  6.  * PRODUCTION
  7.  * ===========================================================================
  8.  */
  10. #ifndef GUI_OBJUTILS___UTILS__HPP
  11. #define GUI_OBJUTILS___UTILS__HPP
  13. /*  $Id: utils.hpp,v 1000.0 2004/06/01 19:56:12 gouriano Exp $
  14.  * ===========================================================================
  15.  *
  16.  *                            PUBLIC DOMAIN NOTICE
  17.  *               National Center for Biotechnology Information
  18.  *
  19.  *  This software/database is a "United States Government Work" under the
  20.  *  terms of the United States Copyright Act.  It was written as part of
  21.  *  the author's official duties as a United States Government employee and
  22.  *  thus cannot be copyrighted.  This software/database is freely available
  23.  *  to the public for use. The National Library of Medicine and the U.S.
  24.  *  Government have not placed any restriction on its use or reproduction.
  25.  *
  26.  *  Although all reasonable efforts have been taken to ensure the accuracy
  27.  *  and reliability of the software and data, the NLM and the U.S.
  28.  *  Government do not and cannot warrant the performance or results that
  29.  *  may be obtained by using this software or data. The NLM and the U.S.
  30.  *  Government disclaim all warranties, express or implied, including
  31.  *  warranties of performance, merchantability or fitness for any particular
  32.  *  purpose.
  33.  *
  34.  *  Please cite the author in any work or product based on this material.
  35.  *
  36.  * ===========================================================================
  37.  *
  38.  * Authors:  Mike DiCuccio
  39.  *
  40.  * File Description:
  41.  *    General utility classes for GUI projects.
  42.  */
  44. #include <corelib/ncbistd.hpp>
  45. #include <gui/objutils/feature.hpp>
  46. #include <objmgr/bioseq_handle.hpp>
  48. /** @addtogroup GUI_OBJUTILS
  49.  *
  50.  * @{
  51.  */
  54. BEGIN_NCBI_SCOPE
  57. //
  58. // Main utilities class
  59. //
  61. class NCBI_GUIOBJUTILS_EXPORT CSeqUtils
  62. {
  63. public:
  64.     // flags controlling feature retrieval
  65.     enum {
  66.         fFeature_LinkFeatures = 0x1,
  68.         fFeature_Default = 0
  69.     };
  70.     typedef int TFeatureFlags;
  72.     // request an annotation selector for a given type
  73.     static objects::SAnnotSelector
  74.     GetAnnotSelector(void);
  76.     static objects::SAnnotSelector
  77.     GetAnnotSelector(objects::SAnnotSelector::TAnnotType choice);
  79.     static objects::SAnnotSelector
  80.     GetAnnotSelector(objects::SAnnotSelector::TFeatType);
  82.     static objects::SAnnotSelector
  83.     GetAnnotSelector(objects::SAnnotSelector::TFeatSubtype);
  85.     // Request a list of landmark features from a bioseq.
  86.     static void GetLandmarkFeatures(const objects::CBioseq_Handle&  handle,
  87.                                     const TSeqRange&          range,
  88.                                     size_t                 max_feats,
  89.                                     CLayoutFeat::TFeatList&   info);
  91.     // Request a list of features from a bioseq.
  92.     static void GetFeatures(const objects::CBioseq_Handle&  handle,
  93.                             const TSeqRange&          range,
  94.                             objects::CSeqFeatData::E_Choice feat_type,
  95.                             CLayoutFeat::TFeatList&   info,
  96.                             TFeatureFlags            flags = fFeature_Default);
  98.     static void GetFeatures(const objects::CBioseq_Handle&  handle,
  99.                             const TSeqRange&         range,
  100.                             objects::SAnnotSelector  sel,
  101.                             CLayoutFeat::TFeatList&  feats,
  102.                             TFeatureFlags            flags = fFeature_Default);
  104.     // Link features into a hierarchical list.  This function will transform a
  105.     // linear, feature-order-sorted list of CLayoutFeat objects into a
  106.     // hierarchically arranged list in which genes are linked to mRNAs, mRNAs
  107.     // to CDSs, etc.
  108.     static void LinkFeatures(CLayoutFeat::TFeatList& features);
  110.     // Request a list of alignments from a bioseq.
  111.     enum EAlignFlags {
  112.         fAlign_LinkMatePairs        = 0x1,
  113.         fAlign_MatedAlignsAsPwAlign = 0x2,
  115.         fAlign_Default = 0x0
  116.     };
  117.     typedef int TAlignFlags;
  119.     static void GetAlignments(const objects::CBioseq_Handle& handle,
  120.                               const TSeqRange&               range,
  121.                               CLayoutEngine::TObjects&       info,
  122.                               TAlignFlags flags = fAlign_Default);
  124.     // Request a list of alignments as smears from a bioseq.  Here, 'window'
  125.     // is the number of bases per bin to place in the smeared alignment
  126.     static void GetAlignmentSmears(const objects::CBioseq_Handle& handle,
  127.                                    const TSeqRange&         range,
  128.                                    TSeqPos                  window,
  129.                                    CLayoutEngine::TObjects& aligns);
  131.     // Request a list of graphs from a bioseq.
  132.     static void GetGraphs(const objects::CBioseq_Handle& handle,
  133.                           const TSeqRange&               range,
  134.                           CLayoutEngine::TObjects&       graphs);
  136.     // remap a location to a parent location.  The child location is split
  137.     // such that all of its relative positions will map correctly to the
  138.     // parent location's positions
  139.     static CRef<objects::CSeq_loc>
  140.     RemapChildToParent(const objects::CSeq_loc& parent,
  141.                        const objects::CSeq_loc& child,
  142.                        objects::CScope* scope = NULL);
  144.     // check to see if two seq-ids are identical.  If provided with a scope,
  145.     // this function will use the synonyms available through a scope to check
  146.     // for identicality.  Note that this may require network access, and may
  147.     // be slow.
  148.     static bool Match(const objects::CSeq_id& id1,
  149.                       const objects::CSeq_id& id2, 
  150.                       objects::CScope* scope = NULL);
  151. };
  154. END_NCBI_SCOPE
  157. /* @} */
  159. /*
  160.  * ===========================================================================
  161.  * $Log: utils.hpp,v $
  162.  * Revision 1000.0  2004/06/01 19:56:12  gouriano
  163.  * PRODUCTION: IMPORTED [GCC34_MSVC7] Dev-tree R1.6
  164.  *
  165.  * Revision 1.6  2004/05/14 14:24:47  dicuccio
  166.  * Added new pure virtual requirement on CLayoutObject(): GetType(), returns enum
  167.  * defined in CLayoutObject
  168.  *
  169.  * Revision 1.5  2004/05/10 00:00:38  dicuccio
  170.  * Added flags to control retrieval of alignments
  171.  *
  172.  * Revision 1.4  2004/05/07 15:44:32  dicuccio
  173.  * Removed GetLabel()
  174.  *
  175.  * Revision 1.3  2004/05/03 13:34:54  dicuccio
  176.  * FIxed include guards, doxygen groups
  177.  *
  178.  * Revision 1.2  2004/05/03 12:41:35  dicuccio
  179.  * Fixed #includes and export specifiers
  180.  *
  181.  * Revision 1.1  2004/04/30 11:52:53  dicuccio
  182.  * Split out from gui/utils
  183.  *
  184.  * Revision 1.32  2004/04/16 14:27:17  dicuccio
  185.  * Added doxygen module tag
  186.  *
  187.  * Revision 1.31  2004/04/16 13:30:39  lebedev
  188.  * Do not link features by default
  189.  *
  190.  * Revision 1.30  2004/04/12 16:49:32  dicuccio
  191.  * Dropped getMatePairs() as separate API - folded into GetAlignments()
  192.  *
  193.  * Revision 1.29  2004/04/07 12:40:53  dicuccio
  194.  * Changed GetAnnotSelector() - for feature types, separated feature type and
  195.  * subtype into different functions.  Changed Match() - scope is now an optional
  196.  * (default null) pointer
  197.  *
  198.  * Revision 1.28  2004/04/06 18:28:26  dicuccio
  199.  * Added GetMatePairs().  Cosmetic changes.
  200.  *
  201.  * Revision 1.27  2004/04/02 16:12:59  yazhuk
  202.  * Added Match() function for comparing CSeq_id-s
  203.  *
  204.  * Revision 1.26  2004/03/23 13:36:14  dicuccio
  205.  * Removed lots of dead functions.  Moved #include of alignment_smear.hpp to .cpp
  206.  *
  207.  * Revision 1.25  2004/03/22 16:39:35  rsmith
  208.  * add GetAlignmentSmears()
  209.  *
  210.  * Revision 1.24  2004/03/11 17:20:23  dicuccio
  211.  * Use gui/gui instead of gui/types.  Use TSeqRange instead of TRange
  212.  *
  213.  * Revision 1.23  2004/02/17 17:17:17  dicuccio
  214.  * Added flags to feature retrieval
  215.  *
  216.  * Revision 1.22  2004/02/04 18:05:30  grichenk
  217.  * Added annotation filtering by set of types/subtypes.
  218.  * Renamed *Choice to *Type in SAnnotSelector.
  219.  *
  220.  * Revision 1.21  2004/01/30 17:12:59  dicuccio
  221.  * Added GetLabel() - moved from plugin_utils.[h,c]pp
  222.  *
  223.  * Revision 1.20  2003/10/28 15:23:47  lebedev
  224.  * GetFeatures method that takes a selector added
  225.  *
  226.  * Revision 1.19  2003/10/22 15:40:57  dicuccio
  227.  * Added API to create a dummy seq-entry to wrap a seq-annot
  228.  *
  229.  * Revision 1.18  2003/10/14 15:42:15  dicuccio
  230.  * Changed API for RemapChildToParent() to accept an optional scope
  231.  *
  232.  * Revision 1.17  2003/10/14 12:19:47  dicuccio
  233.  * Added RemapChildToParent() for remapping seq-locs
  234.  *
  235.  * Revision 1.16  2003/09/29 15:20:08  dicuccio
  236.  * Deprecated gui/scope.hpp.  Merged gui/core/types.hpp into gui/types.hpp
  237.  *
  238.  * Revision 1.15  2003/09/24 18:17:23  dicuccio
  239.  * Add additional GetAnnotSelector prototype
  240.  *
  241.  * Revision 1.14  2003/09/17 16:19:25  dicuccio
  242.  * Removed SetResolveDepth().  Added new functions for formatting annotation
  243.  * selectors in standard ways
  244.  *
  245.  * Revision 1.13  2003/08/22 15:57:11  dicuccio
  246.  * Removed 'USING_SCOPE(objects)'.  Removed export specifier from inline structs
  247.  *
  248.  * Revision 1.12  2003/08/18 14:53:26  dicuccio
  249.  * Changed nales: CFeature -> CLayoutFeat; CAlignment -> CLayoutAlign; CGraph ->
  250.  * CLayoutGraph; CProtProduct -> CLayoutProtProd.
  251.  * Removed USING_SCOPE(objects);
  252.  *
  253.  * Revision 1.11  2003/08/15 19:33:11  dicuccio
  254.  * Added SetResolveDepth() for determining the correct depth of annotations
  255.  *
  256.  * Revision 1.10  2003/07/29 13:38:37  lebedev
  257.  * GetGraphs method added
  258.  *
  259.  * Revision 1.9  2003/07/18 13:33:22  lebedev
  260.  * Method to retrieve alignments added
  261.  *
  262.  * Revision 1.8  2003/06/23 13:18:49  dicuccio
  263.  * Merged functionality in from seq_utils.hpp
  264.  *
  265.  * Revision 1.7  2003/06/10 13:32:21  dicuccio
  266.  * Added new API for retrieving landmark features.  Cleaned up a lot of dead code.
  267.  *
  268.  * Revision 1.6  2003/06/02 16:01:30  dicuccio
  269.  * Rearranged include/objects/ subtree.  This includes the following shifts:
  270.  *     - include/objects/alnmgr --> include/objtools/alnmgr
  271.  *     - include/objects/cddalignview --> include/objtools/cddalignview
  272.  *     - include/objects/flat --> include/objtools/flat
  273.  *     - include/objects/objmgr/ --> include/objmgr/
  274.  *     - include/objects/util/ --> include/objmgr/util/
  275.  *     - include/objects/validator --> include/objtools/validator
  276.  *
  277.  * Revision 1.5  2003/01/15 20:58:38  dicuccio
  278.  * Added interface functions for linking and packing features.  Removed old
  279.  * bitmask feature types in favor of toolkit standard CSeqFeatData::E_Choice
  280.  * types.
  281.  *
  282.  * Revision 1.4  2003/01/13 13:11:42  dicuccio
  283.  * Namespace clean-up.  Retired namespace gui -> converted to namespace ncbi.
  284.  * Moved all FLUID-generated code into namespace ncbi.
  285.  *
  286.  * Revision 1.3  2003/01/09 14:48:21  dicuccio
  287.  * Use 'const CBioseq_Handle&' instead of 'CBioseq_Handle&'
  288.  *
  289.  * Revision 1.2  2002/12/19 18:13:03  dicuccio
  290.  * Added export specifiers for Win32.
  291.  *
  292.  * Revision 1.1  2002/11/29 15:28:10  dicuccio
  293.  * Initial revision - moved from gui/core/view/graphic
  294.  *
  295.  * ===========================================================================
  296.  */
  299. #endif  // GUI_OBJUTILS___UTILS__HPP