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

生物技术

开发平台:

C/C++

  1. /*
  2.  * ===========================================================================
  3.  * PRODUCTION $Log: alignment.hpp,v $
  4.  * PRODUCTION Revision 1000.0  2004/06/01 19:54:21  gouriano
  5.  * PRODUCTION PRODUCTION: IMPORTED [GCC34_MSVC7] Dev-tree R1.4
  6.  * PRODUCTION
  7.  * ===========================================================================
  8.  */
  9. #ifndef GUI_OBJUTILS___ALIGNMENT__HPP
  10. #define GUI_OBJUTILS___ALIGNMENT__HPP
  11. /*  $Id: alignment.hpp,v 1000.0 2004/06/01 19:54:21 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:  Vlad Lebedev
  37.  *
  38.  * File Description:
  39.  *   CLayoutAlign -- utility class to layout alignments and hold CAlnVec objects
  40.  */
  41. #include <corelib/ncbiobj.hpp>
  42. #include <gui/gui.hpp>
  43. #include <gui/objutils/layout.hpp>
  44. #include <objects/seqloc/Seq_interval.hpp>
  45. #include <objtools/alnmgr/alnmix.hpp>
  46. /** @addtogroup GUI_OBJUTILS
  47.  *
  48.  * @{
  49.  */
  50. BEGIN_NCBI_SCOPE
  51. class NCBI_GUIOBJUTILS_EXPORT CLayoutAlign : public CLayoutObject
  52. {
  53. public:
  54.     typedef vector< CRef<CLayoutAlign> > TAlnList;
  55.     
  56.     // ctors
  57.     CLayoutAlign(const objects::CAlnVec& aln_mgr,
  58.                  const objects::CSeq_align& align);
  59.     // Access the alignment as a CObject
  60.     const CObject* GetObject(TSeqPos pos) const;
  61.     bool HasObject(const CObject* obj) const;
  62.     // Access the alignments's remapped location
  63.     const objects::CSeq_loc&   GetLocation(void) const;
  64.     const objects::CAlnVec&    GetAlignMgr(void) const;
  65.     const objects::CSeq_align& GetAlignment(void) const;
  66.     
  67.     //
  68.     // pure virtual requirements
  69.     //    
  70.     // Comparators
  71.     bool LessByPos (const CLayoutObject& obj) const;
  72.     bool LessBySize(const CLayoutObject& obj) const;
  73.     // retrieve the type of this object
  74.     EType GetType() const;
  75. protected:
  76.     // pointer to the actual alignment information
  77.     CConstRef<objects::CAlnVec>     m_AlnMgr;
  78.     CConstRef<objects::CSeq_align>  m_SeqAlign;
  79.     CRef<objects::CSeq_loc>      m_Location;
  80. };
  81. inline
  82. bool CLayoutAlign::LessByPos(const CLayoutObject& obj) const
  83. {
  84.     TSeqRange r0 = GetLocation().GetTotalRange();
  85.     TSeqRange r1 = obj.GetLocation().GetTotalRange();
  86.     if (r0.GetFrom() < r1.GetFrom()) {
  87.         return true;
  88.     }
  89.     if (r0.GetFrom() > r1.GetFrom()) {
  90.         return false;
  91.     }
  92.     if (r0.GetTo() > r1.GetTo()) {
  93.         return true;
  94.     }
  95.     return false;
  96. }
  97. inline
  98. bool CLayoutAlign::LessBySize(const CLayoutObject& obj) const
  99. {
  100.     TSeqRange r0 = GetLocation().GetTotalRange();
  101.     TSeqRange r1 = obj.GetLocation().GetTotalRange();
  102.     return (r0.GetLength() < r1.GetLength());
  103. }
  104. inline
  105. const CObject* CLayoutAlign::GetObject(TSeqPos pos) const
  106. {
  107.     TSeqRange r = GetLocation().GetTotalRange();
  108.     if (pos >= r.GetFrom()  &&  pos <= r.GetTo()) {
  109.         return m_SeqAlign.GetPointer();
  110.     }
  111.     return NULL;
  112. }
  113. inline
  114. bool CLayoutAlign::HasObject(const CObject* obj) const
  115. {
  116.     return m_SeqAlign.GetPointer() == obj;
  117. }
  118. inline
  119. const objects::CAlnVec& CLayoutAlign::GetAlignMgr(void) const
  120. {
  121.     return *m_AlnMgr;
  122. }
  123. inline
  124. const objects::CSeq_align& CLayoutAlign::GetAlignment(void) const
  125. {
  126.     return *m_SeqAlign;
  127. }
  128. inline
  129. const objects::CSeq_loc& CLayoutAlign::GetLocation(void) const
  130. {
  131.     return *m_Location;
  132. }
  133. inline
  134. CLayoutAlign::EType CLayoutAlign::GetType() const
  135. {
  136.     return eAlign;
  137. }
  138. END_NCBI_SCOPE
  139. /* @} */
  140. /*
  141.  * ===========================================================================
  142.  * $Log: alignment.hpp,v $
  143.  * Revision 1000.0  2004/06/01 19:54:21  gouriano
  144.  * PRODUCTION: IMPORTED [GCC34_MSVC7] Dev-tree R1.4
  145.  *
  146.  * Revision 1.4  2004/05/14 14:24:47  dicuccio
  147.  * Added new pure virtual requirement on CLayoutObject(): GetType(), returns enum
  148.  * defined in CLayoutObject
  149.  *
  150.  * Revision 1.3  2004/05/03 13:34:53  dicuccio
  151.  * FIxed include guards, doxygen groups
  152.  *
  153.  * Revision 1.2  2004/05/03 12:41:35  dicuccio
  154.  * Fixed #includes and export specifiers
  155.  *
  156.  * Revision 1.1  2004/04/30 11:52:52  dicuccio
  157.  * Split out from gui/utils
  158.  *
  159.  * Revision 1.10  2004/04/20 19:14:45  dicuccio
  160.  * Expose underlying seq-align
  161.  *
  162.  * Revision 1.9  2004/04/16 14:27:17  dicuccio
  163.  * Added doxygen module tag
  164.  *
  165.  * Revision 1.8  2004/04/15 12:57:43  lebedev
  166.  * Changed GetObject to return NULL or const pointer based on given position
  167.  *
  168.  * Revision 1.7  2004/04/12 16:48:13  dicuccio
  169.  * Changed variable m_AlignMgr to m_AlnMgr.  Changed ctor signature - no longer
  170.  * require an externally computed alignment range.
  171.  *
  172.  * Revision 1.6  2004/03/11 17:19:32  dicuccio
  173.  * Use TSeqRange instead of TRange.  Use gui/gui instead of gui/types
  174.  *
  175.  * Revision 1.5  2003/09/29 15:20:08  dicuccio
  176.  * Deprecated gui/scope.hpp.  Merged gui/core/types.hpp into gui/types.hpp
  177.  *
  178.  * Revision 1.4  2003/09/19 00:28:59  ucko
  179.  * CLayoutAlign: use an unsigned range per CAlnMap::GetSeqRange's new rettype.
  180.  *
  181.  * Revision 1.3  2003/08/18 14:53:26  dicuccio
  182.  * Changed nales: CFeature -> CLayoutFeat; CAlignment -> CLayoutAlign; CGraph ->
  183.  * CLayoutGraph; CProtProduct -> CLayoutProtProd.
  184.  * Removed USING_SCOPE(objects);
  185.  *
  186.  * Revision 1.2  2003/07/21 19:24:09  dicuccio
  187.  * Changed storage mechanism: CLayoutObject::GetObject() is pure virtual.  Also,
  188.  * CFeature now stores a CMappedFeat object instead of a CSeq_feat / CSeq_loc pair
  189.  *
  190.  * Revision 1.1  2003/07/18 13:33:52  lebedev
  191.  * Initial revision
  192.  *
  193.  * ===========================================================================
  194.  */
  195. #endif  // GUI_OBJUTILS___ALIGNMENT__HPP