开通博客赚积分
发布资源赚积分
分类

源码开发语言/平台
当前位置：首页 > 源码/资料 > 数值算法/人工智能 > 生物技术 > 查看源码
seq_entry_info.hpp
资源名称：ncbi_cxx_win--Jul_08_2004.zip　[点击查看]
上传用户：yhdzpy8989
上传日期：2007-06-13
资源大小：13604k
文件大小：9k
源码类别：

生物技术

开发平台：

C/C++

seq_entry_info.hpp：源码内容
  1. /*
  2.  * ===========================================================================
  3.  * PRODUCTION $Log: seq_entry_info.hpp,v $
  4.  * PRODUCTION Revision 1000.2  2004/04/12 17:28:31  gouriano
  5.  * PRODUCTION PRODUCTION: UPGRADED [CATCHUP_003] Dev-tree R1.13
  6.  * PRODUCTION
  7.  * ===========================================================================
  8.  */
  10. #ifndef OBJECTS_OBJMGR_IMPL___SEQ_ENTRY_INFO__HPP
  11. #define OBJECTS_OBJMGR_IMPL___SEQ_ENTRY_INFO__HPP
  13. /*  $Id: seq_entry_info.hpp,v 1000.2 2004/04/12 17:28:31 gouriano Exp $
  14. * ===========================================================================
  15. *
  16. *                            PUBLIC DOMAIN NOTICE
  17. *               National Center for Biotechnology Information
  18. *
  19. *  This software/database is a "United States Government Work" under the
  20. *  terms of the United States Copyright Act.  It was written as part of
  21. *  the author's official duties as a United States Government employee and
  22. *  thus cannot be copyrighted.  This software/database is freely available
  23. *  to the public for use. The National Library of Medicine and the U.S.
  24. *  Government have not placed any restriction on its use or reproduction.
  25. *
  26. *  Although all reasonable efforts have been taken to ensure the accuracy
  27. *  and reliability of the software and data, the NLM and the U.S.
  28. *  Government do not and cannot warrant the performance or results that
  29. *  may be obtained by using this software or data. The NLM and the U.S.
  30. *  Government disclaim all warranties, express or implied, including
  31. *  warranties of performance, merchantability or fitness for any particular
  32. *  purpose.
  33. *
  34. *  Please cite the author in any work or product based on this material.
  35. *
  36. * ===========================================================================
  37. *
  38. * Author: Eugene Vasilchenko
  39. *
  40. * File Description:
  41. *   Seq_entry info -- entry for data source
  42. *
  43. */
  46. #include <objmgr/impl/tse_info_object.hpp>
  47. #include <objects/seqset/Seq_entry.hpp>
  48. #include <objects/seqset/Bioseq_set.hpp>
  49. #include <vector>
  50. #include <list>
  52. BEGIN_NCBI_SCOPE
  53. BEGIN_SCOPE(objects)
  56. // forward declaration
  57. class CSeq_entry;
  58. class CBioseq;
  59. class CBioseq_set;
  60. class CSeq_annot;
  62. class CDataSource;
  63. class CTSE_Info;
  64. class CSeq_entry_Info;
  65. class CBioseq_Base_Info;
  66. class CBioseq_set_Info;
  67. class CBioseq_Info;
  68. class CSeq_annot_Info;
  69. class CSeq_descr;
  70. class CSeqdesc;
  72. ////////////////////////////////////////////////////////////////////
  73. //
  74. //  CSeq_entry_Info::
  75. //
  76. //    General information and indexes for seq-entries
  77. //
  80. class NCBI_XOBJMGR_EXPORT CSeq_entry_Info : public CTSE_Info_Object
  81. {
  82.     typedef CTSE_Info_Object TParent;
  83. public:
  84.     // 'ctors
  85.     CSeq_entry_Info(void);
  86.     explicit CSeq_entry_Info(const CSeq_entry_Info& info);
  87.     explicit CSeq_entry_Info(CSeq_entry& entry);
  88.     virtual ~CSeq_entry_Info(void);
  90.     const CBioseq_set_Info& GetParentBioseq_set_Info(void) const;
  91.     CBioseq_set_Info& GetParentBioseq_set_Info(void);
  93.     const CSeq_entry_Info& GetParentSeq_entry_Info(void) const;
  94.     CSeq_entry_Info& GetParentSeq_entry_Info(void);
  97.     typedef CSeq_entry TObject;
  99.     CConstRef<TObject> GetCompleteSeq_entry(void) const;
  100.     CConstRef<TObject> GetSeq_entryCore(void) const;
  102.     // Seq-entry access
  103.     typedef TObject::E_Choice E_Choice;
  104.     E_Choice Which(void) const;
  105.     void x_CheckWhich(E_Choice which) const;
  106.     void Reset(void);
  108.     typedef CBioseq_set_Info TSet;
  109.     bool IsSet(void) const;
  110.     const TSet& GetSet(void) const;
  111.     TSet& SetSet(void);
  113.     // SelectSet switches Seq-entry to e_Set variant
  114.     TSet& SelectSet(void);
  115.     TSet& SelectSet(TSet& seqset);
  116.     TSet& SelectSet(CBioseq_set& seqset);
  118.     typedef CBioseq_Info TSeq;
  119.     bool IsSeq(void) const;
  120.     const TSeq& GetSeq(void) const;
  121.     TSeq& SetSeq(void);
  123.     // SelectSeq switches Seq-entry to e_Seq variant
  124.     TSeq& SelectSeq(TSeq& seq);
  125.     TSeq& SelectSeq(CBioseq& seq);
  127.     typedef CSeq_descr TDescr;
  128.     // Bioseq-set access
  129.     bool IsSetDescr(void) const;
  130.     const TDescr& GetDescr(void) const;
  131.     void ResetDescr(void);
  132.     void SetDescr(TDescr& v);
  133.     bool AddSeqdesc(CSeqdesc& d);
  134.     bool RemoveSeqdesc(const CSeqdesc& d);
  135.     void AddDescr(CSeq_entry_Info& src);
  137.     CRef<CSeq_annot_Info> AddAnnot(const CSeq_annot& annot);
  138.     void AddAnnot(CRef<CSeq_annot_Info> annot);
  139.     void RemoveAnnot(CRef<CSeq_annot_Info> annot);
  141.     CRef<CSeq_entry_Info> AddEntry(CSeq_entry& entry, int index = -1);
  142.     void AddEntry(CRef<CSeq_entry_Info> entry, int index = -1);
  143.     void RemoveEntry(CRef<CSeq_entry_Info> entry);
  145.     // tree initialization
  146.     void x_Attach(CRef<CSeq_entry_Info> sub_entry, int index = -1);
  147.     void x_Attach(CRef<CBioseq_Info> bioseq);
  149.     void x_ParentAttach(CBioseq_set_Info& parent);
  150.     void x_ParentDetach(CBioseq_set_Info& parent);
  152.     // attaching/detaching to CDataSource (it's in CTSE_Info)
  153.     virtual void x_DSAttachContents(CDataSource& ds);
  154.     virtual void x_DSDetachContents(CDataSource& ds);
  156.     // attaching/detaching to CTSE_Info
  157.     virtual void x_TSEAttachContents(CTSE_Info& tse_info);
  158.     virtual void x_TSEDetachContents(CTSE_Info& tse_info);
  160.     void UpdateAnnotIndex(void) const;
  162. protected:
  163.     friend class CScope_Impl;
  164.     friend class CDataSource;
  166.     friend class CAnnot_Collector;
  167.     friend class CSeq_annot_CI;
  169.     friend class CTSE_Info;
  170.     friend class CBioseq_Info;
  171.     friend class CBioseq_set_Info;
  172.     friend class CSeq_annot_Info;
  174.     void x_AttachContents(void);
  175.     void x_DetachContents(void);
  177.     TObject& x_GetObject(void);
  178.     const TObject& x_GetObject(void) const;
  180.     void x_SetObject(TObject& obj);
  181.     void x_SetObject(const CSeq_entry_Info& info);
  183.     void x_DetachObjectVariant(void);
  184.     void x_AttachObjectVariant(CBioseq& seq);
  185.     void x_AttachObjectVariant(CBioseq_set& seqset);
  187.     void x_Select(CSeq_entry::E_Choice which,
  188.                   CBioseq_Base_Info* contents);
  189.     void x_Select(CSeq_entry::E_Choice which,
  190.                   CRef<CBioseq_Base_Info> contents);
  192.     virtual void x_DSMapObject(CConstRef<TObject> obj, CDataSource& ds);
  193.     virtual void x_DSUnmapObject(CConstRef<TObject> obj, CDataSource& ds);
  195.     void x_UpdateAnnotIndexContents(CTSE_Info& tse);
  197.     void x_DoUpdateObject(void);
  198.     static CRef<TObject> sx_ShallowCopy(TObject& obj);
  200.     // Seq-entry pointer
  201.     CRef<TObject>           m_Object;
  203.     // Bioseq/Bioseq_set info
  204.     E_Choice                m_Which;
  205.     CRef<CBioseq_Base_Info> m_Contents;
  207.     // Hide copy methods
  208.     CSeq_entry_Info& operator= (const CSeq_entry_Info&);
  209. };
  213. /////////////////////////////////////////////////////////////////////
  214. //
  215. //  Inline methods
  216. //
  217. /////////////////////////////////////////////////////////////////////
  220. inline
  221. CSeq_entry::E_Choice CSeq_entry_Info::Which(void) const
  222. {
  223.     return m_Which;
  224. }
  227. inline
  228. CSeq_entry& CSeq_entry_Info::x_GetObject(void)
  229. {
  230.     return *m_Object;
  231. }
  234. inline
  235. const CSeq_entry& CSeq_entry_Info::x_GetObject(void) const
  236. {
  237.     return *m_Object;
  238. }
  241. inline
  242. bool CSeq_entry_Info::IsSet(void) const
  243. {
  244.     return Which() == CSeq_entry::e_Set;
  245. }
  248. inline
  249. bool CSeq_entry_Info::IsSeq(void) const
  250. {
  251.     return Which() == CSeq_entry::e_Seq;
  252. }
  255. END_SCOPE(objects)
  256. END_NCBI_SCOPE
  258. /*
  259. * ---------------------------------------------------------------------------
  260. * $Log: seq_entry_info.hpp,v $
  261. * Revision 1000.2  2004/04/12 17:28:31  gouriano
  262. * PRODUCTION: UPGRADED [CATCHUP_003] Dev-tree R1.13
  263. *
  264. * Revision 1.13  2004/04/05 15:56:13  grichenk
  265. * Redesigned CAnnotTypes_CI: moved all data and data collecting
  266. * functions to CAnnotDataCollector. CAnnotTypes_CI is no more
  267. * inherited from SAnnotSelector.
  268. *
  269. * Revision 1.12  2004/03/31 17:08:06  vasilche
  270. * Implemented ConvertSeqToSet and ConvertSetToSeq.
  271. *
  272. * Revision 1.11  2004/03/25 19:27:44  vasilche
  273. * Implemented MoveTo and CopyTo methods of handles.
  274. *
  275. * Revision 1.10  2004/03/24 18:30:29  vasilche
  276. * Fixed edit API.
  277. * Every *_Info object has its own shallow copy of original object.
  278. *
  279. * Revision 1.9  2004/03/16 15:47:27  vasilche
  280. * Added CBioseq_set_Handle and set of EditHandles
  281. *
  282. * Revision 1.8  2004/02/03 19:02:16  vasilche
  283. * Fixed broken 'dirty annot index' state after RemoveEntry().
  284. *
  285. * Revision 1.7  2003/12/18 16:38:06  grichenk
  286. * Added CScope::RemoveEntry()
  287. *
  288. * Revision 1.6  2003/11/28 15:13:25  grichenk
  289. * Added CSeq_entry_Handle
  290. *
  291. * Revision 1.5  2003/09/30 16:22:01  vasilche
  292. * Updated internal object manager classes to be able to load ID2 data.
  293. * SNP blobs are loaded as ID2 split blobs - readers convert them automatically.
  294. * Scope caches results of requests for data to data loaders.
  295. * Optimized CSeq_id_Handle for gis.
  296. * Optimized bioseq lookup in scope.
  297. * Reduced object allocations in annotation iterators.
  298. * CScope is allowed to be destroyed before other objects using this scope are
  299. * deleted (feature iterators, bioseq handles etc).
  300. * Optimized lookup for matching Seq-ids in CSeq_id_Mapper.
  301. * Added 'adaptive' option to objmgr_demo application.
  302. *
  303. * Revision 1.4  2003/08/04 17:02:59  grichenk
  304. * Added constructors to iterate all annotations from a
  305. * seq-entry or seq-annot.
  306. *
  307. * Revision 1.3  2003/07/25 21:41:29  grichenk
  308. * Implemented non-recursive mode for CSeq_annot_CI,
  309. * fixed friend declaration in CSeq_entry_Info.
  310. *
  311. * Revision 1.2  2003/07/25 15:25:24  grichenk
  312. * Added CSeq_annot_CI class
  313. *
  314. * Revision 1.1  2003/04/24 16:12:37  vasilche
  315. * Object manager internal structures are splitted more straightforward.
  316. * Removed excessive header dependencies.
  317. *
  318. *
  319. * ===========================================================================
  320. */
  322. #endif  /* OBJECTS_OBJMGR_IMPL___SEQ_ENTRY_INFO__HPP */