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

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

生物技术

开发平台：

C/C++

bioseq_set_handle.hpp：源码内容
  1. /*
  2.  * ===========================================================================
  3.  * PRODUCTION $Log: bioseq_set_handle.hpp,v $
  4.  * PRODUCTION Revision 1000.1  2004/06/01 19:21:19  gouriano
  5.  * PRODUCTION PRODUCTION: UPGRADED [GCC34_MSVC7] Dev-tree R1.7
  6.  * PRODUCTION
  7.  * ===========================================================================
  8.  */
  10. #ifndef OBJMGR__BIOSEQ_SET_HANDLE__HPP
  11. #define OBJMGR__BIOSEQ_SET_HANDLE__HPP
  13. /*  $Id: bioseq_set_handle.hpp,v 1000.1 2004/06/01 19:21:19 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: Aleksey Grichenko, Eugene Vasilchenko
  39. *
  40. * File Description:
  41. *    Handle to Seq-entry object
  42. *
  43. */
  45. #include <corelib/ncbiobj.hpp>
  47. #include <objects/seqset/Bioseq_set.hpp>
  49. #include <objmgr/impl/heap_scope.hpp>
  51. BEGIN_NCBI_SCOPE
  52. BEGIN_SCOPE(objects)
  54. /////////////////////////////////////////////////////////////////////////////
  55. // CSeq_entry_Handle
  56. /////////////////////////////////////////////////////////////////////////////
  59. class CSeq_annot;
  60. class CSeq_entry;
  61. class CBioseq;
  62. class CBioseq_set;
  63. class CSeqdesc;
  65. class CScope;
  67. class CSeq_entry_Handle;
  68. class CBioseq_set_Handle;
  69. class CBioseq_Handle;
  70. class CSeq_annot_Handle;
  71. class CSeq_entry_EditHandle;
  72. class CBioseq_set_EditHandle;
  73. class CBioseq_EditHandle;
  74. class CSeq_annot_EditHandle;
  76. class CBioseq_set_Info;
  78. class NCBI_XOBJMGR_EXPORT CBioseq_set_Handle
  79. {
  80. public:
  81.     // Default constructor
  82.     CBioseq_set_Handle(void);
  84.     // Get scope this handle belongs to
  85.     CScope& GetScope(void) const;
  87.     // owner Seq-entry
  88.     CSeq_entry_Handle GetParentEntry(void) const;
  89.     CSeq_entry_Handle GetTopLevelEntry(void) const;
  91.     // Get 'edit' version of handle
  92.     CBioseq_set_EditHandle GetEditHandle(void) const;
  94.     // Get controlled object
  95.     CConstRef<CBioseq_set> GetCompleteBioseq_set(void) const;
  96.     CConstRef<CBioseq_set> GetBioseq_setCore(void) const;
  98.     // member access
  99.     typedef CBioseq_set::TId TId;
  100.     bool IsSetId(void) const;
  101.     bool CanGetId(void) const;
  102.     const TId& GetId(void) const;
  104.     typedef CBioseq_set::TColl TColl;
  105.     bool IsSetColl(void) const;
  106.     bool CanGetColl(void) const;
  107.     const TColl& GetColl(void) const;
  109.     typedef CBioseq_set::TLevel TLevel;
  110.     bool IsSetLevel(void) const;
  111.     bool CanGetLevel(void) const;
  112.     TLevel GetLevel(void) const;
  114.     typedef CBioseq_set::TClass TClass;
  115.     bool IsSetClass(void) const;
  116.     bool CanGetClass(void) const;
  117.     TClass GetClass(void) const;
  119.     typedef CBioseq_set::TRelease TRelease;
  120.     bool IsSetRelease(void) const;
  121.     bool CanGetRelease(void) const;
  122.     const TRelease& GetRelease(void) const;
  124.     typedef CBioseq_set::TDate TDate;
  125.     bool IsSetDate(void) const;
  126.     bool CanGetDate(void) const;
  127.     const TDate& GetDate(void) const;
  129.     typedef CBioseq_set::TDescr TDescr;
  130.     bool IsSetDescr(void) const;
  131.     bool CanGetDescr(void) const;
  132.     const TDescr& GetDescr(void) const;
  134.     // Utility methods/operators
  135.     operator bool(void) const;
  136.     bool operator!(void) const;
  137.     void Reset(void);
  139.     bool operator ==(const CBioseq_set_Handle& handle) const;
  140.     bool operator !=(const CBioseq_set_Handle& handle) const;
  141.     bool operator <(const CBioseq_set_Handle& handle) const;
  143. protected:
  144.     friend class CScope_Impl;
  145.     friend class CBioseq_Handle;
  146.     friend class CSeq_entry_Handle;
  148.     friend class CSeqMap_CI;
  149.     friend class CSeq_entry_CI;
  150.     friend class CSeq_annot_CI;
  151.     friend class CAnnotTypes_CI;
  153.     CBioseq_set_Handle(CScope& scope, const CBioseq_set_Info& info);
  155.     CHeapScope          m_Scope;
  156.     CConstRef<CObject>  m_Info;
  158. public: // non-public section
  159.     const CBioseq_set_Info& x_GetInfo(void) const;
  160. };
  163. class NCBI_XOBJMGR_EXPORT CBioseq_set_EditHandle : public CBioseq_set_Handle
  164. {
  165. public:
  166.     // Default constructor
  167.     CBioseq_set_EditHandle(void);
  169.     // Navigate object tree
  170.     CSeq_entry_EditHandle GetParentEntry(void) const;
  172.     // Member modification
  173.     void ResetId(void) const;
  174.     void SetId(TId& id) const;
  176.     void ResetColl(void) const;
  177.     void SetColl(TColl& v) const;
  179.     void ResetLevel(void) const;
  180.     void SetLevel(TLevel v) const;
  182.     void ResetClass(void) const;
  183.     void SetClass(TClass v) const;
  185.     void ResetRelease(void) const;
  186.     void SetRelease(TRelease& v) const;
  188.     void ResetDate(void) const;
  189.     void SetDate(TDate& v) const;
  191.     void ResetDescr(void) const;
  192.     void SetDescr(TDescr& v) const;
  193.     bool AddDesc(CSeqdesc& v) const;
  194.     bool RemoveDesc(CSeqdesc& v) const;
  195.     void AddAllDescr(CSeq_descr& v) const;
  197.     // Modify object tree
  198.     CSeq_entry_EditHandle AddNewEntry(int index) const;
  200.     CSeq_annot_EditHandle AttachAnnot(const CSeq_annot& annot) const;
  201.     CSeq_annot_EditHandle CopyAnnot(const CSeq_annot_Handle&annot) const;
  202.     CSeq_annot_EditHandle TakeAnnot(const CSeq_annot_EditHandle& annot) const;
  204.     CBioseq_EditHandle AttachBioseq(CBioseq& seq,
  205.                                     int index = -1) const;
  206.     CBioseq_EditHandle CopyBioseq(const CBioseq_Handle& seq,
  207.                                   int index = -1) const;
  208.     CBioseq_EditHandle TakeBioseq(const CBioseq_EditHandle& seq,
  209.                                   int index = -1) const;
  211.     CSeq_entry_EditHandle AttachEntry(CSeq_entry& entry,
  212.                                       int index = -1) const;
  213.     CSeq_entry_EditHandle CopyEntry(const CSeq_entry_Handle& entry,
  214.                                     int index = -1) const;
  215.     CSeq_entry_EditHandle TakeEntry(const CSeq_entry_EditHandle& entry,
  216.                                     int index = -1) const;
  218.     void Remove(void) const;
  220. protected:
  221.     friend class CScope_Impl;
  222.     friend class CBioseq_EditHandle;
  223.     friend class CSeq_entry_EditHandle;
  225.     CBioseq_set_EditHandle(const CBioseq_set_Handle& h);
  226.     CBioseq_set_EditHandle(CScope& scope, CBioseq_set_Info& info);
  228. public: // non-public section
  229.     CBioseq_set_Info& x_GetInfo(void) const;
  230. };
  233. /////////////////////////////////////////////////////////////////////////////
  234. // CBioseq_set_Handle inline methods
  235. /////////////////////////////////////////////////////////////////////////////
  238. inline
  239. CBioseq_set_Handle::CBioseq_set_Handle(void)
  240. {
  241. }
  244. inline
  245. CScope& CBioseq_set_Handle::GetScope(void) const
  246. {
  247.     return m_Scope;
  248. }
  251. inline
  252. void CBioseq_set_Handle::Reset(void)
  253. {
  254.     m_Scope.Reset();
  255.     m_Info.Reset();
  256. }
  259. inline
  260. const CBioseq_set_Info& CBioseq_set_Handle::x_GetInfo(void) const
  261. {
  262.     return reinterpret_cast<const CBioseq_set_Info&>(*m_Info);
  263. }
  266. inline
  267. CBioseq_set_Handle::operator bool(void) const
  268. {
  269.     return m_Info;
  270. }
  273. inline
  274. bool CBioseq_set_Handle::operator!(void) const
  275. {
  276.     return !m_Info;
  277. }
  280. inline
  281. bool CBioseq_set_Handle::operator ==(const CBioseq_set_Handle& handle) const
  282. {
  283.     return m_Scope == handle.m_Scope  &&  m_Info == handle.m_Info;
  284. }
  287. inline
  288. bool CBioseq_set_Handle::operator !=(const CBioseq_set_Handle& handle) const
  289. {
  290.     return m_Scope != handle.m_Scope  ||  m_Info != handle.m_Info;
  291. }
  294. inline
  295. bool CBioseq_set_Handle::operator <(const CBioseq_set_Handle& handle) const
  296. {
  297.     if ( m_Scope != handle.m_Scope ) {
  298.         return m_Scope < handle.m_Scope;
  299.     }
  300.     return m_Info < handle.m_Info;
  301. }
  304. /////////////////////////////////////////////////////////////////////////////
  305. // CBioseq_set_EditHandle
  306. /////////////////////////////////////////////////////////////////////////////
  309. inline
  310. CBioseq_set_EditHandle::CBioseq_set_EditHandle(void)
  311. {
  312. }
  315. inline
  316. CBioseq_set_EditHandle::CBioseq_set_EditHandle(const CBioseq_set_Handle& h)
  317.     : CBioseq_set_Handle(h)
  318. {
  319. }
  322. inline
  323. CBioseq_set_EditHandle::CBioseq_set_EditHandle(CScope& scope,
  324.                                                CBioseq_set_Info& info)
  325.     : CBioseq_set_Handle(scope, info)
  326. {
  327. }
  330. inline
  331. CBioseq_set_Info& CBioseq_set_EditHandle::x_GetInfo(void) const
  332. {
  333.     return const_cast<CBioseq_set_Info&>(CBioseq_set_Handle::x_GetInfo());
  334. }
  337. END_SCOPE(objects)
  338. END_NCBI_SCOPE
  340. /*
  341. * ---------------------------------------------------------------------------
  342. * $Log: bioseq_set_handle.hpp,v $
  343. * Revision 1000.1  2004/06/01 19:21:19  gouriano
  344. * PRODUCTION: UPGRADED [GCC34_MSVC7] Dev-tree R1.7
  345. *
  346. * Revision 1.7  2004/05/06 17:32:37  grichenk
  347. * Added CanGetXXXX() methods
  348. *
  349. * Revision 1.6  2004/04/29 15:44:30  grichenk
  350. * Added GetTopLevelEntry()
  351. *
  352. * Revision 1.5  2004/03/31 19:54:07  vasilche
  353. * Fixed removal of bioseqs and bioseq-sets.
  354. *
  355. * Revision 1.4  2004/03/31 17:08:06  vasilche
  356. * Implemented ConvertSeqToSet and ConvertSetToSeq.
  357. *
  358. * Revision 1.3  2004/03/29 20:13:05  vasilche
  359. * Implemented whole set of methods to modify Seq-entry object tree.
  360. * Added CBioseq_Handle::GetExactComplexityLevel().
  361. *
  362. * Revision 1.2  2004/03/24 18:30:28  vasilche
  363. * Fixed edit API.
  364. * Every *_Info object has its own shallow copy of original object.
  365. *
  366. * Revision 1.1  2004/03/16 15:47:26  vasilche
  367. * Added CBioseq_set_Handle and set of EditHandles
  368. *
  369. * Revision 1.3  2004/02/09 19:18:50  grichenk
  370. * Renamed CDesc_CI to CSeq_descr_CI. Redesigned CSeq_descr_CI
  371. * and CSeqdesc_CI to avoid using data directly.
  372. *
  373. * Revision 1.2  2003/12/03 16:40:03  grichenk
  374. * Added GetParentEntry()
  375. *
  376. * Revision 1.1  2003/11/28 15:12:30  grichenk
  377. * Initial revision
  378. *
  379. *
  380. * ===========================================================================
  381. */
  383. #endif//OBJMGR__BIOSEQ_SET_HANDLE__HPP