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

生物技术

开发平台:

C/C++

  1. /*
  2.  * ===========================================================================
  3.  * PRODUCTION $Log: seq_map.hpp,v $
  4.  * PRODUCTION Revision 1000.0  2004/06/01 19:55:57  gouriano
  5.  * PRODUCTION PRODUCTION: IMPORTED [GCC34_MSVC7] Dev-tree R1.4
  6.  * PRODUCTION
  7.  * ===========================================================================
  8.  */
  9. #ifndef GUI_OBJUTILS___SEQ_MAP__HPP
  10. #define GUI_OBJUTILS___SEQ_MAP__HPP
  11. /*  $Id: seq_map.hpp,v 1000.0 2004/06/01 19:55:57 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.  *   CLayoutSeqMap -- utility class to layout sequence segments and 
  40.  *                    hold CSeq_id_Handle objects
  41.  */
  42. #include <corelib/ncbiobj.hpp>
  43. #include <gui/objutils/layout.hpp>
  44. #include <objects/seqloc/Seq_interval.hpp>
  45. #include <objmgr/seq_id_handle.hpp>
  46. /** @addtogroup GUI_OBJUTILS
  47.  *
  48.  * @{
  49.  */
  50. BEGIN_NCBI_SCOPE
  51. class NCBI_GUIOBJUTILS_EXPORT CLayoutSeqMap : public CLayoutObject
  52. {
  53. public:
  54.     typedef vector< CRef<CLayoutSeqMap> > TSeqMapList;
  55.     
  56.     // ctors
  57.     CLayoutSeqMap(objects::CSeq_id_Handle hndl,
  58.             const TSeqRange& range, const TSeqRange& ref_range);
  59.     // Access the data as a CObject
  60.     const CObject* GetObject(TSeqPos pos) const;
  61.     bool HasObject(const CObject* obj) const;
  62.     // Access the remapped location
  63.     const objects::CSeq_loc&  GetLocation(void) const;
  64.     const objects::CSeq_loc&  GetRefLocation(void) const;
  65.     const objects::CSeq_id&   GetSeqID(void) const;
  66.     // retrieve the type of this object
  67.     EType GetType() const;
  68.     //
  69.     // pure virtual requirements
  70.     //    
  71.     // Comparators
  72.     bool LessByPos (const CLayoutObject& obj) const;
  73.     bool LessBySize(const CLayoutObject& obj) const;
  74. protected:
  75.     // pointer to the actual seq data
  76.     objects::CSeq_id_Handle     m_SeqHandle;
  77.     CRef<objects::CSeq_loc>  m_Location;
  78.     CRef<objects::CSeq_loc>  m_RefLocation;
  79. };
  80. inline
  81. bool CLayoutSeqMap::LessByPos(const CLayoutObject& obj) const
  82. {
  83.     TSeqRange r0 = GetLocation().GetTotalRange();
  84.     TSeqRange r1 = obj.GetLocation().GetTotalRange();
  85.     return (r0.GetFrom() < r1.GetFrom());
  86. }
  87. inline
  88. bool CLayoutSeqMap::LessBySize(const CLayoutObject& obj) const
  89. {
  90.     TSeqRange r0 = GetLocation().GetTotalRange();
  91.     TSeqRange r1 = obj.GetLocation().GetTotalRange();
  92.     return (r0.GetLength() < r1.GetLength());
  93. }
  94. inline
  95. const CObject* CLayoutSeqMap::GetObject(TSeqPos pos) const
  96. {
  97.     TSeqRange r = GetLocation().GetTotalRange();
  98.     if (pos >= r.GetFrom()  &&  pos <= r.GetTo()) {
  99.         return m_SeqHandle.GetSeqId().GetPointer();
  100.     }
  101.     return NULL;
  102. }
  103. inline
  104. bool CLayoutSeqMap::HasObject(const CObject* obj) const
  105. {
  106.     return m_SeqHandle.GetSeqId().GetPointer() == obj;
  107. }
  108. inline
  109. const objects::CSeq_id& CLayoutSeqMap::GetSeqID(void) const
  110. {
  111.     return *m_SeqHandle.GetSeqId();
  112. }
  113. inline
  114. const objects::CSeq_loc& CLayoutSeqMap::GetLocation(void) const
  115. {
  116.     return *m_Location;
  117. }
  118. inline
  119. const objects::CSeq_loc& CLayoutSeqMap::GetRefLocation(void) const
  120. {
  121.     return *m_RefLocation;
  122. }
  123. inline
  124. CLayoutSeqMap::EType CLayoutSeqMap::GetType() const
  125. {
  126.     return eSeqMap;
  127. }
  128. END_NCBI_SCOPE
  129. /* @} */
  130. /*
  131.  * ===========================================================================
  132.  * $Log: seq_map.hpp,v $
  133.  * Revision 1000.0  2004/06/01 19:55:57  gouriano
  134.  * PRODUCTION: IMPORTED [GCC34_MSVC7] Dev-tree R1.4
  135.  *
  136.  * Revision 1.4  2004/05/14 14:24:47  dicuccio
  137.  * Added new pure virtual requirement on CLayoutObject(): GetType(), returns enum
  138.  * defined in CLayoutObject
  139.  *
  140.  * Revision 1.3  2004/05/03 13:34:54  dicuccio
  141.  * FIxed include guards, doxygen groups
  142.  *
  143.  * Revision 1.2  2004/05/03 12:41:35  dicuccio
  144.  * Fixed #includes and export specifiers
  145.  *
  146.  * Revision 1.1  2004/04/30 11:52:53  dicuccio
  147.  * Split out from gui/utils
  148.  *
  149.  * Revision 1.7  2004/04/16 14:27:17  dicuccio
  150.  * Added doxygen module tag
  151.  *
  152.  * Revision 1.6  2004/04/15 12:57:44  lebedev
  153.  * Changed GetObject to return NULL or const pointer based on given position
  154.  *
  155.  * Revision 1.5  2004/04/01 20:10:30  rsmith
  156.  * take out redundant & illegal class specifier
  157.  *
  158.  * Revision 1.4  2004/03/23 12:23:51  lebedev
  159.  * Changed seq_map to hold CSeq_id_Handle
  160.  *
  161.  * Revision 1.3  2004/03/11 17:20:23  dicuccio
  162.  * Use gui/gui instead of gui/types.  Use TSeqRange instead of TRange
  163.  *
  164.  * Revision 1.2  2003/11/04 13:09:54  lebedev
  165.  * Reference location added
  166.  *
  167.  * Revision 1.1  2003/10/30 13:18:51  lebedev
  168.  * Initial revision
  169.  *
  170.  * ===========================================================================
  171.  */
  172.  
  173. #endif  // GUI_OBJUTILS___SEQ_MAP__HPP