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

生物技术

开发平台:

C/C++

  1. /*
  2.  * ===========================================================================
  3.  * PRODUCTION $Log: flat_loc.hpp,v $
  4.  * PRODUCTION Revision 1000.0  2003/10/29 20:59:35  gouriano
  5.  * PRODUCTION PRODUCTION: IMPORTED [ORIGINAL] Dev-tree R1.3
  6.  * PRODUCTION
  7.  * ===========================================================================
  8.  */
  9. #ifndef OBJECTS_FLAT___FLAT_LOC__HPP
  10. #define OBJECTS_FLAT___FLAT_LOC__HPP
  11. /*  $Id: flat_loc.hpp,v 1000.0 2003/10/29 20:59:35 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. * Author:  Aaron Ucko, NCBI
  37. *
  38. * File Description:
  39. *   new (early 2003) flat-file generator -- location representation
  40. *
  41. */
  42. #include <corelib/ncbiobj.hpp>
  43. #include <util/range.hpp>
  44. BEGIN_NCBI_SCOPE
  45. BEGIN_SCOPE(objects)
  46. // forward declarations
  47. class CInt_fuzz;
  48. class CSeq_id;
  49. class CSeq_interval;
  50. class CSeq_loc;
  51. class CFlatContext;
  52. class CFlatLoc : public CObject // derived from CObject to allow for caching
  53. {
  54. public:
  55.     struct SInterval
  56.     {
  57.         enum EFlags {
  58.             fReversed     = 0x1,
  59.             fPartialLeft  = 0x2,
  60.             fPartialRight = 0x4
  61.         };
  62.         typedef int TFlags; // binary OR of EFlags
  63.         TSeqPos GetStart(void) const
  64.           { return m_Flags & fReversed ? m_Range.GetTo() : m_Range.GetFrom(); }
  65.         TSeqPos GetStop(void) const
  66.           { return m_Flags & fReversed ? m_Range.GetFrom() : m_Range.GetTo(); }
  67.         bool IsReversed    (void) const
  68.             { return (m_Flags & fReversed) != 0; }
  69.         bool IsPartialLeft (void) const
  70.             { return (m_Flags & fPartialLeft) != 0; }
  71.         bool IsPartialRight(void) const
  72.             { return (m_Flags & fPartialRight) != 0; }
  73.         string          m_Accession;
  74.         CRange<TSeqPos> m_Range; // 1-based, L->R; should be finite
  75.         TFlags          m_Flags;
  76.     };
  77.     typedef vector<SInterval> TIntervals;
  78.     
  79.     CFlatLoc(const CSeq_loc& loc, CFlatContext& ctx);
  80.     const string&     GetString(void)    const { return m_String;    }
  81.     const TIntervals& GetIntervals(void) const { return m_Intervals; }
  82.     
  83. private:
  84.     string     m_String;    // whole location, as a GB-style string
  85.     TIntervals m_Intervals; // individual intervals/points
  86.     void x_Add   (const CSeq_loc& loc, CNcbiOstrstream& oss,
  87.                   CFlatContext& ctx);
  88.     void x_Add   (const CSeq_interval& si, CNcbiOstrstream& oss,
  89.                   CFlatContext& ctx);
  90.     // these convert from 0-based to 1-based coordinates in the process
  91.     SInterval::TFlags x_AddPnt(TSeqPos pnt, const CInt_fuzz* fuzz,
  92.                                CNcbiOstrstream& oss, CFlatContext& ctx);
  93.     void x_AddInt(TSeqPos from, TSeqPos to, const string& accn,
  94.                   SInterval::TFlags flags = 0);
  95.     static void x_AddID(const CSeq_id& id, CNcbiOstrstream& oss,
  96.                         CFlatContext& ctx, string *s = 0);
  97. };
  98. END_SCOPE(objects)
  99. END_NCBI_SCOPE
  100. /*
  101. * ===========================================================================
  102. *
  103. * $Log: flat_loc.hpp,v $
  104. * Revision 1000.0  2003/10/29 20:59:35  gouriano
  105. * PRODUCTION: IMPORTED [ORIGINAL] Dev-tree R1.3
  106. *
  107. * Revision 1.3  2003/03/28 19:02:43  ucko
  108. * Add flags to intervals.
  109. *
  110. * Revision 1.2  2003/03/21 18:47:47  ucko
  111. * Turn most structs into (accessor-requiring) classes; replace some
  112. * formerly copied fields with pointers to the original data.
  113. *
  114. * Revision 1.1  2003/03/10 16:39:08  ucko
  115. * Initial check-in of new flat-file generator
  116. *
  117. *
  118. * ===========================================================================
  119. */
  120. #endif  /* OBJECTS_FLAT___FLAT_LOC__HPP */