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

生物技术

开发平台:

C/C++

  1. /*
  2.  * ===========================================================================
  3.  * PRODUCTION $Log: bioseq_base_info.hpp,v $
  4.  * PRODUCTION Revision 1000.0  2004/04/12 17:32:44  gouriano
  5.  * PRODUCTION PRODUCTION: IMPORTED [CATCHUP_003] Dev-tree R1.3
  6.  * PRODUCTION
  7.  * ===========================================================================
  8.  */
  9. #ifndef OBJECTS_OBJMGR_IMPL___BIOSEQ_BASE_INFO__HPP
  10. #define OBJECTS_OBJMGR_IMPL___BIOSEQ_BASE_INFO__HPP
  11. /*  $Id: bioseq_base_info.hpp,v 1000.0 2004/04/12 17:32:44 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: Aleksey Grichenko, Eugene Vasilchenko
  37.  *
  38.  * File Description:
  39.  *   Bioseq info for data source
  40.  *
  41.  */
  42. #include <corelib/ncbiobj.hpp>
  43. #include <objmgr/impl/tse_info_object.hpp>
  44. #include <objmgr/seq_id_handle.hpp>
  45. #include <vector>
  46. BEGIN_NCBI_SCOPE
  47. BEGIN_SCOPE(objects)
  48. class CDataSource;
  49. class CTSE_Info;
  50. class CSeq_entry;
  51. class CSeq_entry_Info;
  52. class CSeq_annot;
  53. class CSeq_annot_Info;
  54. class CSeq_descr;
  55. class CSeqdesc;
  56. ////////////////////////////////////////////////////////////////////
  57. //
  58. //  CBioseq_Info::
  59. //
  60. //    Structure to keep bioseq's parent seq-entry along with the list
  61. //    of seq-id synonyms for the bioseq.
  62. //
  63. class NCBI_XOBJMGR_EXPORT CBioseq_Base_Info : public CTSE_Info_Object
  64. {
  65.     typedef CTSE_Info_Object TParent;
  66. public:
  67.     // 'ctors
  68.     CBioseq_Base_Info(void);
  69.     virtual ~CBioseq_Base_Info(void);
  70.     // info tree
  71.     const CSeq_entry_Info& GetParentSeq_entry_Info(void) const;
  72.     CSeq_entry_Info& GetParentSeq_entry_Info(void);
  73.     // member modification
  74.     // descr
  75.     typedef CSeq_descr TDescr;
  76.     virtual bool IsSetDescr(void) const = 0;
  77.     virtual const TDescr& GetDescr(void) const = 0;
  78.     virtual void SetDescr(TDescr& v) = 0;
  79.     virtual TDescr& x_SetDescr(void) = 0;
  80.     virtual void ResetDescr(void) = 0;
  81.     bool AddSeqdesc(CSeqdesc& d);
  82.     bool RemoveSeqdesc(const CSeqdesc& d);
  83.     void AddSeq_descr(TDescr& v);
  84.     // annot
  85.     typedef vector< CRef<CSeq_annot_Info> > TAnnot;
  86.     typedef list< CRef<CSeq_annot> > TObjAnnot;
  87.     bool IsSetAnnot(void) const;
  88.     bool HasAnnots(void) const;
  89.     const TAnnot& GetAnnot(void) const;
  90.     void ResetAnnot(void);
  91.     CRef<CSeq_annot_Info> AddAnnot(const CSeq_annot& annot);
  92.     void AddAnnot(CRef<CSeq_annot_Info> annot);
  93.     void RemoveAnnot(CRef<CSeq_annot_Info> annot);
  94.     // object initialization
  95.     void x_AttachAnnot(CRef<CSeq_annot_Info> info);
  96.     void x_DetachAnnot(CRef<CSeq_annot_Info> info);
  97.     // info tree initialization
  98.     virtual void x_DSAttachContents(CDataSource& ds);
  99.     virtual void x_DSDetachContents(CDataSource& ds);
  100.     virtual void x_TSEAttachContents(CTSE_Info& tse);
  101.     virtual void x_TSEDetachContents(CTSE_Info& tse);
  102.     virtual void x_ParentAttach(CSeq_entry_Info& parent);
  103.     virtual void x_ParentDetach(CSeq_entry_Info& parent);
  104.     // index support
  105.     void x_UpdateAnnotIndexContents(CTSE_Info& tse);
  106.     void x_SetAnnot(void);
  107.     void x_SetAnnot(const CBioseq_Base_Info& info);
  108.     void x_DoUpdateObject(void);
  109.     virtual TObjAnnot& x_SetObjAnnot(void) = 0;
  110.     virtual void x_ResetObjAnnot(void) = 0;
  111. private:
  112.     friend class CAnnotTypes_CI;
  113.     friend class CSeq_annot_CI;
  114.     CBioseq_Base_Info(const CBioseq_Base_Info& info);
  115.     CBioseq_Base_Info& operator=(const CBioseq_Base_Info&);
  116.     // members
  117.     TAnnot              m_Annot;
  118.     TObjAnnot*          m_ObjAnnot;
  119. };
  120. /////////////////////////////////////////////////////////////////////
  121. //
  122. //  Inline methods
  123. //
  124. /////////////////////////////////////////////////////////////////////
  125. inline
  126. bool CBioseq_Base_Info::IsSetAnnot(void) const
  127. {
  128.     return m_ObjAnnot != 0;
  129. }
  130. inline
  131. bool CBioseq_Base_Info::HasAnnots(void) const
  132. {
  133.     return !m_Annot.empty();
  134. }
  135. inline
  136. const CBioseq_Base_Info::TAnnot& CBioseq_Base_Info::GetAnnot(void) const
  137. {
  138.     return m_Annot;
  139. }
  140. END_SCOPE(objects)
  141. END_NCBI_SCOPE
  142. /*
  143.  * ---------------------------------------------------------------------------
  144.  * $Log: bioseq_base_info.hpp,v $
  145.  * Revision 1000.0  2004/04/12 17:32:44  gouriano
  146.  * PRODUCTION: IMPORTED [CATCHUP_003] Dev-tree R1.3
  147.  *
  148.  * Revision 1.3  2004/03/31 17:08:06  vasilche
  149.  * Implemented ConvertSeqToSet and ConvertSetToSeq.
  150.  *
  151.  * Revision 1.2  2004/03/24 18:30:28  vasilche
  152.  * Fixed edit API.
  153.  * Every *_Info object has its own shallow copy of original object.
  154.  *
  155.  * Revision 1.1  2004/03/16 15:47:26  vasilche
  156.  * Added CBioseq_set_Handle and set of EditHandles
  157.  *
  158.  * Revision 1.15  2003/11/28 15:13:25  grichenk
  159.  * Added CSeq_entry_Handle
  160.  *
  161.  * Revision 1.14  2003/09/30 16:22:00  vasilche
  162.  * Updated internal object manager classes to be able to load ID2 data.
  163.  * SNP blobs are loaded as ID2 split blobs - readers convert them automatically.
  164.  * Scope caches results of requests for data to data loaders.
  165.  * Optimized CSeq_id_Handle for gis.
  166.  * Optimized bioseq lookup in scope.
  167.  * Reduced object allocations in annotation iterators.
  168.  * CScope is allowed to be destroyed before other objects using this scope are
  169.  * deleted (feature iterators, bioseq handles etc).
  170.  * Optimized lookup for matching Seq-ids in CSeq_id_Mapper.
  171.  * Added 'adaptive' option to objmgr_demo application.
  172.  *
  173.  * Revision 1.13  2003/06/02 16:01:37  dicuccio
  174.  * Rearranged include/objects/ subtree.  This includes the following shifts:
  175.  *     - include/objects/alnmgr --> include/objtools/alnmgr
  176.  *     - include/objects/cddalignview --> include/objtools/cddalignview
  177.  *     - include/objects/flat --> include/objtools/flat
  178.  *     - include/objects/objmgr/ --> include/objmgr/
  179.  *     - include/objects/util/ --> include/objmgr/util/
  180.  *     - include/objects/validator --> include/objtools/validator
  181.  *
  182.  * Revision 1.12  2003/04/29 19:51:12  vasilche
  183.  * Fixed interaction of Data Loader garbage collector and TSE locking mechanism.
  184.  * Made some typedefs more consistent.
  185.  *
  186.  * Revision 1.11  2003/04/25 14:23:46  vasilche
  187.  * Added explicit constructors, destructor and assignment operator to make it compilable on MSVC DLL.
  188.  *
  189.  * Revision 1.10  2003/04/24 16:12:37  vasilche
  190.  * Object manager internal structures are splitted more straightforward.
  191.  * Removed excessive header dependencies.
  192.  *
  193.  * Revision 1.9  2003/04/14 21:31:05  grichenk
  194.  * Removed operators ==(), !=() and <()
  195.  *
  196.  * Revision 1.8  2003/03/12 20:09:31  grichenk
  197.  * Redistributed members between CBioseq_Handle, CBioseq_Info and CTSE_Info
  198.  *
  199.  * Revision 1.7  2003/02/05 17:57:41  dicuccio
  200.  * Moved into include/objects/objmgr/impl to permit data loaders to be defined
  201.  * outside of xobjmgr.
  202.  *
  203.  * Revision 1.6  2002/12/26 21:03:33  dicuccio
  204.  * Added Win32 export specifier.  Moved file from src/objects/objmgr to
  205.  * include/objects/objmgr.
  206.  *
  207.  * Revision 1.5  2002/07/08 20:51:01  grichenk
  208.  * Moved log to the end of file
  209.  * Replaced static mutex (in CScope, CDataSource) with the mutex
  210.  * pool. Redesigned CDataSource data locking.
  211.  *
  212.  * Revision 1.4  2002/05/29 21:21:13  gouriano
  213.  * added debug dump
  214.  *
  215.  * Revision 1.3  2002/05/06 03:28:46  vakatov
  216.  * OM/OM1 renaming
  217.  *
  218.  * Revision 1.2  2002/02/21 19:27:05  grichenk
  219.  * Rearranged includes. Added scope history. Added searching for the
  220.  * best seq-id match in data sources and scopes. Updated tests.
  221.  *
  222.  * Revision 1.1  2002/02/07 21:25:05  grichenk
  223.  * Initial revision
  224.  *
  225.  *
  226.  * ===========================================================================
  227.  */
  228. #endif//OBJECTS_OBJMGR_IMPL___BIOSEQ_BASE_INFO__HPP