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

生物技术

开发平台:

C/C++

  1. /*
  2.  * ===========================================================================
  3.  * PRODUCTION $Log: Bioseq.hpp,v $
  4.  * PRODUCTION Revision 1000.0  2003/10/29 21:02:20  gouriano
  5.  * PRODUCTION PRODUCTION: IMPORTED [ORIGINAL] Dev-tree R1.17
  6.  * PRODUCTION
  7.  * ===========================================================================
  8.  */
  9. /* $Id: Bioseq.hpp,v 1000.0 2003/10/29 21:02:20 gouriano Exp $
  10.  * ===========================================================================
  11.  *
  12.  *                            PUBLIC DOMAIN NOTICE
  13.  *               National Center for Biotechnology Information
  14.  *
  15.  *  This software/database is a "United States Government Work" under the
  16.  *  terms of the United States Copyright Act.  It was written as part of
  17.  *  the author's official duties as a United States Government employee and
  18.  *  thus cannot be copyrighted.  This software/database is freely available
  19.  *  to the public for use. The National Library of Medicine and the U.S.
  20.  *  Government have not placed any restriction on its use or reproduction.
  21.  *
  22.  *  Although all reasonable efforts have been taken to ensure the accuracy
  23.  *  and reliability of the software and data, the NLM and the U.S.
  24.  *  Government do not and cannot warrant the performance or results that
  25.  *  may be obtained by using this software or data. The NLM and the U.S.
  26.  *  Government disclaim all warranties, express or implied, including
  27.  *  warranties of performance, merchantability or fitness for any particular
  28.  *  purpose.
  29.  *
  30.  *  Please cite the author in any work or product based on this material.
  31.  *
  32.  * ===========================================================================
  33.  *
  34.  * Author:  .......
  35.  *
  36.  * File Description:
  37.  *   .......
  38.  *
  39.  * Remark:
  40.  *   This code was originally generated by application DATATOOL
  41.  *   using specifications from the ASN data definition file
  42.  *   'seq.asn'.
  43.  *
  44.  */
  45. #ifndef OBJECTS_SEQ_BIOSEQ_HPP
  46. #define OBJECTS_SEQ_BIOSEQ_HPP
  47. // generated includes
  48. #include <objects/seq/Bioseq_.hpp>
  49. #include <map>
  50. // generated classes
  51. BEGIN_NCBI_SCOPE
  52. BEGIN_objects_SCOPE // namespace ncbi::objects::
  53. class CSeq_entry;
  54. class CSeq_loc;
  55. class CDelta_ext;
  56. class CSeq_id;
  57. class NCBI_SEQ_EXPORT CBioseq : public CBioseq_Base, public CSerialUserOp
  58. {
  59.     typedef CBioseq_Base Tparent;
  60. public:
  61.     // constructor
  62.     CBioseq(void);
  63.     // destructor
  64.     ~CBioseq(void);
  65.     // Manage Seq-entry tree structure
  66.     // get parent Seq-entry.
  67.     // NULL means that either there is no parent Seq-entry,
  68.     // or CSeq_entry::Parentize() was never called.
  69.     CSeq_entry* GetParentEntry(void) const;
  70.     // see GetTitle in util/sequence.hpp
  71.     //   string GetTitle(const CBioseq_Handle&, TGetTitleFlags);
  72.     // Construct bioseq from seq-loc. The constructed bioseq
  73.     // has id = "local|"+str_id or "local|constructed###", where
  74.     // ### is a generated number; inst::repr = const,
  75.     // inst::mol = other (since it is impossible to check sequence
  76.     // type by seq-loc). The location is splitted into simple
  77.     // locations (intervals, points, whole-s etc.) and put into
  78.     // ext::delta.
  79.     CBioseq(const CSeq_loc& loc, string str_id = "");
  80.     enum ELabelType {
  81.         eType,
  82.         eContent,
  83.         eBoth
  84.     };
  85.     // Append a label to label for a CBioseq based on type, content or both
  86.     void GetLabel(string* label, ELabelType type, bool worst = false) const;
  87.     const CSeq_id* GetFirstId() const;
  88.     // check molecule type for nucleotide or protein
  89.     bool IsNa(void) const;
  90.     bool IsAa(void) const;
  91. protected:
  92.     // From CSerialUserOp
  93.     virtual void UserOp_Assign(const CSerialUserOp& source);
  94.     virtual bool UserOp_Equals(const CSerialUserOp& object) const;
  95. private:
  96.     // Prohibit copy constructor and assignment operator
  97.     CBioseq(const CBioseq& value);
  98.     CBioseq& operator= (const CBioseq& value);
  99.     // Seq-entry containing the Bioseq
  100.     void SetParentEntry(CSeq_entry* entry);
  101.     CSeq_entry* m_ParentEntry;
  102.     static void x_SeqLoc_To_DeltaExt(const CSeq_loc& loc, CDelta_ext& ext);
  103.     static int sm_ConstructedId;
  104.     friend class CSeq_entry;
  105. };
  106. /////////////////// CBioseq inline methods
  107. // constructor
  108. inline
  109. CBioseq::CBioseq(void)
  110.     : m_ParentEntry(0)
  111. {
  112. }
  113. inline
  114. void CBioseq::SetParentEntry(CSeq_entry* entry)
  115. {
  116.     m_ParentEntry = entry;
  117. }
  118. inline
  119. CSeq_entry* CBioseq::GetParentEntry(void) const
  120. {
  121.     return m_ParentEntry;
  122. }
  123. /////////////////// end of CBioseq inline methods
  124. END_objects_SCOPE // namespace ncbi::objects::
  125. END_NCBI_SCOPE
  126. /*
  127.  * ===========================================================================
  128.  * $Log: Bioseq.hpp,v $
  129.  * Revision 1000.0  2003/10/29 21:02:20  gouriano
  130.  * PRODUCTION: IMPORTED [ORIGINAL] Dev-tree R1.17
  131.  *
  132.  * Revision 1.17  2003/04/24 16:14:11  vasilche
  133.  * Fixed Parentize().
  134.  *
  135.  * Revision 1.16  2002/12/26 12:42:59  dicuccio
  136.  * Added Win32 export specifiers
  137.  *
  138.  * Revision 1.15  2002/12/19 20:10:27  kans
  139.  * added IsNa and IsAa methods
  140.  *
  141.  * Revision 1.14  2002/10/03 19:06:25  clausen
  142.  * Removed extra whitespace
  143.  *
  144.  * Revision 1.13  2002/10/03 16:59:04  clausen
  145.  * Added GetLabel() and GetFirstId()
  146.  *
  147.  * Revision 1.12  2002/06/07 12:09:21  clausen
  148.  * Modified GetTitle comment
  149.  *
  150.  * Revision 1.11  2002/05/22 14:03:33  grichenk
  151.  * CSerialUserOp -- added prefix UserOp_ to Assign() and Equals()
  152.  *
  153.  * Revision 1.10  2002/04/22 20:09:56  grichenk
  154.  * -ConstructExcludedSequence() -- use
  155.  * CBioseq_Handle::GetSequenceView() instead
  156.  *
  157.  * Revision 1.9  2002/03/18 21:46:11  grichenk
  158.  * +ConstructExcludedSequence()
  159.  *
  160.  * Revision 1.8  2001/12/20 20:00:28  grichenk
  161.  * CObjectManager::ConstructBioseq(CSeq_loc) -> CBioseq::CBioseq(CSeq_loc ...)
  162.  *
  163.  * Revision 1.7  2001/10/12 19:32:55  ucko
  164.  * move BREAK to a central location; move CBioseq::GetTitle to object manager
  165.  *
  166.  * Revision 1.6  2001/10/04 19:11:54  ucko
  167.  * Centralize (rudimentary) code to get a sequence's title.
  168.  *
  169.  * Revision 1.5  2001/07/25 19:11:07  grichenk
  170.  * Equals() and Assign() re-declared as protected
  171.  *
  172.  * Revision 1.4  2001/07/16 16:22:42  grichenk
  173.  * Added CSerialUserOp class to create Assign() and Equals() methods for
  174.  * user-defind classes.
  175.  * Added SerialAssign<>() and SerialEquals<>() functions.
  176.  *
  177.  * Revision 1.3  2001/06/25 18:51:59  grichenk
  178.  * Prohibited copy constructor and assignment operator
  179.  *
  180.  * Revision 1.2  2001/06/21 19:47:34  grichenk
  181.  * Copy constructor and operator=() moved to "private" section
  182.  *
  183.  * Revision 1.1  2001/06/13 15:00:06  grichenk
  184.  * Initial revision
  185.  *
  186.  *
  187.  * ===========================================================================
  188.  */
  189. #endif // OBJECTS_SEQ_BIOSEQ_HPP
  190. /* Original file checksum: lines: 85, chars: 2191, CRC32: 21fd3921 */