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

生物技术

开发平台:

C/C++

  1. /*
  2.  * ===========================================================================
  3.  * PRODUCTION $Log: alignment_smear_layout.hpp,v $
  4.  * PRODUCTION Revision 1000.0  2004/06/01 19:54:31  gouriano
  5.  * PRODUCTION PRODUCTION: IMPORTED [GCC34_MSVC7] Dev-tree R1.4
  6.  * PRODUCTION
  7.  * ===========================================================================
  8.  */
  9. #ifndef GUI_OBJUTILS___ALIGNMENT_SMEAR_LAYOUT__HPP
  10. #define GUI_OBJUTILS___ALIGNMENT_SMEAR_LAYOUT__HPP
  11. /*  $Id: alignment_smear_layout.hpp,v 1000.0 2004/06/01 19:54:31 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:  Robert Smith
  37.  *
  38.  * File Description:
  39.  *    CLayoutAlignSmear -- utility class for having alignment smears in graphical layouts.
  40.  */
  41. #include <corelib/ncbiobj.hpp>
  42. #include <gui/objutils/layout.hpp>
  43. #include <gui/objutils/alignment_smear.hpp>
  44. #include <objects/seqloc/Seq_interval.hpp>
  45. /** @addtogroup GUI_OBJUTILS
  46.  *
  47.  * @{
  48.  */
  49. BEGIN_NCBI_SCOPE
  50. class NCBI_GUIOBJUTILS_EXPORT CLayoutAlignSmear : public CLayoutObject
  51. {
  52. public:
  53.     // ctors
  54.     CLayoutAlignSmear(const objects::CBioseq_Handle& handle, 
  55.                       TSeqPos start, TSeqPos stop, TSeqPos window,
  56.                       CAlignmentSmear::EAlignSmearStrand strand_type,
  57.                       const objects::CSeq_annot& seq_annot);
  58.     //
  59.     // pure virtual requirements
  60.     //
  61.     // access the position of this object.
  62.     const objects::CSeq_loc& GetLocation(void) const;
  63.     // access our core component - we wrap an object of some sort
  64.     const CObject* GetObject(TSeqPos pos) const;
  65.     
  66.     bool HasObject(const CObject* obj) const;
  67.     // Comparators
  68.     bool LessByPos (const CLayoutObject& obj) const;
  69.     bool LessBySize(const CLayoutObject& obj) const;
  70.     // retrieve the type of this object
  71.     EType GetType() const;
  72.     // Is this layout object selectable in the viewers?
  73.     bool IsSelectable() const;
  74.     
  75.     // Get our native data.
  76.     const CAlignmentSmear& GetAlignSmear() const;
  77. protected:
  78.     CRef<CAlignmentSmear> m_AlignSmear;
  79.     
  80.     // Location is not real. 
  81.     // smear will occuy an entire row in layout
  82.     CRef<objects::CSeq_loc> m_Location;
  83. };
  84. inline
  85. bool CLayoutAlignSmear::IsSelectable() const
  86. {
  87.     return false;
  88. }
  89. inline
  90. const objects::CSeq_loc& CLayoutAlignSmear::GetLocation(void) const
  91. {
  92.     return *m_Location;
  93. }
  94. inline
  95. const CObject* CLayoutAlignSmear::GetObject(TSeqPos pos) const
  96. {
  97.     TSeqRange r = GetLocation().GetTotalRange();
  98.     if (pos >= r.GetFrom()  &&  pos <= r.GetTo()) {
  99.         return m_AlignSmear.GetPointer();
  100.     }
  101.     return NULL;
  102. }
  103. inline
  104. bool CLayoutAlignSmear::HasObject(const CObject* obj) const
  105. {
  106.     return m_AlignSmear.GetPointer() == obj;
  107. }
  108. inline
  109. bool CLayoutAlignSmear::LessByPos(const CLayoutObject& obj) const
  110. {
  111.     return false;
  112. }
  113. inline
  114. bool CLayoutAlignSmear::LessBySize(const CLayoutObject& obj) const
  115. {
  116.     return false;
  117. }
  118. inline
  119. const CAlignmentSmear& CLayoutAlignSmear::GetAlignSmear() const
  120. {
  121.     return *m_AlignSmear;    
  122. }
  123. inline
  124. CLayoutAlignSmear::EType CLayoutAlignSmear::GetType() const
  125. {
  126.     return eAlignSmear;
  127. }
  128. END_NCBI_SCOPE
  129. /* @} */
  130. /*
  131.  * ===========================================================================
  132.  * $Log: alignment_smear_layout.hpp,v $
  133.  * Revision 1000.0  2004/06/01 19:54:31  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:53  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:52  dicuccio
  147.  * Split out from gui/utils
  148.  *
  149.  * Revision 1.3  2004/04/16 14:23:44  dicuccio
  150.  * Formatting changes.  Added doxygen module tags
  151.  *
  152.  * Revision 1.2  2004/04/15 12:57:43  lebedev
  153.  * Changed GetObject to return NULL or const pointer based on given position
  154.  *
  155.  * Revision 1.1  2004/03/22 16:35:34  rsmith
  156.  * initial checkin
  157.  *
  158.  *
  159.  * ===========================================================================
  160.  */
  161. #endif  // GUI_OBJUTILS___ALIGNMENT_SMEAR_LAYOUT__HPP