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

生物技术

开发平台:

C/C++

  1. /*
  2.  * ===========================================================================
  3.  * PRODUCTION $Log: alnmulti_ds.hpp,v $
  4.  * PRODUCTION Revision 1000.3  2004/04/12 18:15:52  gouriano
  5.  * PRODUCTION PRODUCTION: UPGRADED [CATCHUP_003] Dev-tree R1.12
  6.  * PRODUCTION
  7.  * ===========================================================================
  8.  */
  9. #ifndef GUI_WIDGETS_ALN_MULTIPLE___ALN_MULTI_DS__HPP
  10. #define GUI_WIDGETS_ALN_MULTIPLE___ALN_MULTI_DS__HPP
  11. /*  $Id: alnmulti_ds.hpp,v 1000.3 2004/04/12 18:15:52 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 <corelib/ncbistd.hpp>
  42. #include <corelib/ncbiobj.hpp>
  43. #include <objects/seqloc/Seq_loc.hpp>
  44. #include <gui/widgets/aln_data/align_ds.hpp>
  45. BEGIN_NCBI_SCOPE
  46. USING_SCOPE(ncbi::objects);
  47. /// IAlignRowHandle provides an abstract way to access alignment row data.
  48. ///
  49. /// IAlignRowHandle-inherited classes are supposed to provide proprietary
  50. /// interface depending on the nature of data being represented.
  51. class NCBI_GUIWIDGETS_ALNMULTIPLE_EXPORT IAlignRowHandle
  52. {
  53. protected:
  54.     virtual ~IAlignRowHandle() {}
  55. };
  56. /// IAlnMultiDataSource - interface to a data source representing abstract
  57. /// multiple alignment.
  58. class NCBI_GUIWIDGETS_ALNMULTIPLE_EXPORT IAlnMultiDataSource
  59. {
  60. public:
  61.     typedef CAlnVec::TNumrow   TNumrow;
  62.     typedef CAlnVec::TResidue  TResidue;
  63.     typedef CAlnMap                   TSearchDirection;
  64.     typedef CAlnMap::ESearchDirection ESearchDirection;
  65. public:
  66.     /// number of rows in alignment
  67.     virtual TNumrow  GetNumRows (void) const = 0;    
  68.     virtual TSeqPos  GetAlnStart (void) const = 0; 
  69.     virtual TSeqPos  GetAlnStop (void) const = 0;
  70.     /// returns index of the Consensus row or -1 if it doesn't exist
  71.     virtual int     GetConsensusRow() const = 0;
  72.     virtual const IAlignRowHandle*  GetRowHandle(TNumrow row) const = 0;
  73.     
  74.     /// Anchoring methods 
  75.     virtual bool  IsSetAnchor (void) const = 0;
  76.     virtual TNumrow  GetAnchor (void) const = 0; 
  77.     virtual void  SetAnchor (TNumrow anchor) = 0; 
  78.     virtual void  UnsetAnchor (void) = 0;
  79.     
  80.     virtual bool    CanGetId(TNumrow row) const = 0;
  81.     virtual const CSeq_id&  GetSeqId(TNumrow row) const = 0;
  82.     
  83.     virtual TSignedSeqPos  GetSeqPosFromAlnPos(TNumrow for_row, TSeqPos aln_pos,
  84.                                 ESearchDirection dir=TSearchDirection::eNone,
  85.                                 bool try_reverse_dir=true) const = 0;
  86.     
  87.     virtual TSignedSeqPos  GetAlnPosFromSeqPos(TNumrow row, TSeqPos seq_pos, 
  88.                                 ESearchDirection dir=TSearchDirection::eNone,
  89.                                 bool try_reverse_dir=true) const = 0;
  90. };
  91. END_NCBI_SCOPE
  92. /*
  93.  * ===========================================================================
  94.  * $Log: alnmulti_ds.hpp,v $
  95.  * Revision 1000.3  2004/04/12 18:15:52  gouriano
  96.  * PRODUCTION: UPGRADED [CATCHUP_003] Dev-tree R1.12
  97.  *
  98.  * Revision 1.12  2003/12/10 19:03:20  yazhuk
  99.  * Added const specifier to CanGetId() and GetSeqId().
  100.  *
  101.  * Revision 1.11  2003/12/10 17:04:36  yazhuk
  102.  * Changed row identification from mandatory CBioseqHandle to optional CSeq_id.
  103.  * Clean-up
  104.  *
  105.  * Revision 1.10  2003/11/26 16:52:53  johnson
  106.  * switch IAlnMultiDataSource to use CAlnMap::ESearchDirection instead of it's
  107.  * own ESearchDirection
  108.  *
  109.  * Revision 1.9  2003/11/17 21:12:46  yazhuk
  110.  * Moved SetGapChar() to CAlnVecMultiDataSource
  111.  *
  112.  * Revision 1.8  2003/10/29 23:27:05  yazhuk
  113.  * Replaced CAlnMultiDataSource with IAlnMultiDataSource
  114.  *
  115.  * Revision 1.7  2003/09/25 20:43:47  yazhuk
  116.  * Moved consensus row support to CAlignDataSource
  117.  *
  118.  * Revision 1.6  2003/09/24 18:19:50  dicuccio
  119.  * Inherit data source from generic data source, removing many redundant data
  120.  * members / functions
  121.  *
  122.  * Revision 1.5  2003/09/23 21:53:44  yazhuk
  123.  * Added support for consensus row
  124.  *
  125.  * Revision 1.4  2003/09/16 14:37:13  dicuccio
  126.  * Cleaned up and clarified export specifiers - added a new specifier for each
  127.  * library
  128.  *
  129.  * Revision 1.3  2003/09/12 12:59:14  dicuccio
  130.  * Added export specifiers.  Inlined virtual dtors for interface classes
  131.  *
  132.  * Revision 1.2  2003/08/28 18:23:47  yazhuk
  133.  * Modified to be used with new CAlnMultiWidget
  134.  *
  135.  * Revision 1.1  2003/07/14 17:37:18  dicuccio
  136.  * Initial revision
  137.  *
  138.  * ===========================================================================
  139.  */
  140. #endif  // GUI_WIDGETS_ALN_MULTIPLE___ALN_MULTI_DS__HPP