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

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

生物技术

开发平台：

C/C++

scope.hpp：源码内容
  1. /*
  2.  * ===========================================================================
  3.  * PRODUCTION $Log: scope.hpp,v $
  4.  * PRODUCTION Revision 1000.6  2004/04/16 16:59:56  gouriano
  5.  * PRODUCTION PRODUCTION: UPGRADED [CATCHUP_003] Dev-tree R1.78
  6.  * PRODUCTION
  7.  * ===========================================================================
  8.  */
  10. #ifndef OBJMGR_SCOPE__HPP
  11. #define OBJMGR_SCOPE__HPP
  13. /*  $Id: scope.hpp,v 1000.6 2004/04/16 16:59:56 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. * Authors:
  39. *           Andrei Gourianov
  40. *           Aleksey Grichenko
  41. *           Michael Kimelman
  42. *           Denis Vakatov
  43. *           Eugene Vasilchenko
  44. *
  45. * File Description:
  46. *           Scope is top-level object available to a client.
  47. *           Its purpose is to define a scope of visibility and reference
  48. *           resolution and provide access to the bio sequence data
  49. *
  50. */
  52. #include <corelib/ncbiobj.hpp>
  53. #include <objmgr/seq_id_handle.hpp>
  54. #include <objmgr/seq_entry_handle.hpp>
  55. #include <objmgr/bioseq_set_handle.hpp>
  56. #include <objmgr/bioseq_handle.hpp>
  57. #include <objmgr/seq_annot_handle.hpp>
  59. BEGIN_NCBI_SCOPE
  60. BEGIN_SCOPE(objects)
  63. // fwd decl
  64. // objects
  65. class CSeq_entry;
  66. class CBioseq_set;
  67. class CBioseq;
  68. class CSeq_annot;
  69. class CSeq_id;
  70. class CSeq_loc;
  72. // objmgr
  73. class CSeq_id_Handle;
  74. class CObjectManager;
  75. class CScope_Impl;
  76. class CSynonymsSet;
  79. /////////////////////////////////////////////////////////////////////////////
  80. // CScope
  81. /////////////////////////////////////////////////////////////////////////////
  83. class NCBI_XOBJMGR_EXPORT CScope : public CObject
  84. {
  85. public:
  86.     explicit CScope(CObjectManager& objmgr);
  87.     virtual ~CScope(void);
  89.     // CBioseq_Handle methods:
  90.     // Get bioseq handle by seq-id
  91.     CBioseq_Handle GetBioseqHandle(const CSeq_id& id);
  92.     CBioseq_Handle GetBioseqHandle(const CSeq_id_Handle& id);
  93.     CBioseq_Handle GetBioseqHandle(const CSeq_loc& loc);
  95.     // Get bioseq handle without loading new data
  96.     enum EGetBioseqFlag {
  97.         eGetBioseq_Resolved, // Search only in already resolved ids
  98.         eGetBioseq_Loaded,   // Search in all loaded TSEs in the scope
  99.         eGetBioseq_All       // Search bioseq, load if not loaded yet
  100.     };
  101.     CBioseq_Handle GetBioseqHandle(const CSeq_id& id,
  102.                                    EGetBioseqFlag get_flag);
  103.     CBioseq_Handle GetBioseqHandle(const CSeq_id_Handle& id,
  104.                                    EGetBioseqFlag get_flag);
  106.     // Deprecated interface
  107.     CBioseq_Handle GetBioseqHandle(const CBioseq& bioseq);
  108.     CSeq_entry_Handle GetSeq_entryHandle(const CSeq_entry& entry);
  109.     CSeq_annot_Handle GetSeq_annotHandle(const CSeq_annot& annot);
  111.     // Get bioseq handle for sequence withing one TSE
  112.     CBioseq_Handle GetBioseqHandleFromTSE(const CSeq_id& id,
  113.                                           const CBioseq_Handle& bh);
  114.     CBioseq_Handle GetBioseqHandleFromTSE(const CSeq_id& id,
  115.                                           const CSeq_entry_Handle& seh);
  116.     CBioseq_Handle GetBioseqHandleFromTSE(const CSeq_id_Handle& id,
  117.                                           const CBioseq_Handle& bh);
  118.     CBioseq_Handle GetBioseqHandleFromTSE(const CSeq_id_Handle& id,
  119.                                           const CSeq_entry_Handle& seh);
  121.     // CScope contents modification methods
  122.     typedef int TPriority;
  123.     enum EPriority {
  124.         kPriority_NotSet = -1
  125.     };
  127.     // Add default data loaders from object manager
  128.     void AddDefaults(TPriority pri = kPriority_NotSet);
  129.     // Add data loader by name.
  130.     // The loader (or its factory) must be known to Object Manager.
  131.     void AddDataLoader(const string& loader_name,
  132.                        TPriority pri = kPriority_NotSet);
  133.     // Add the scope's datasources as a single group with the given priority
  134.     void AddScope(CScope& scope,
  135.                   TPriority pri = kPriority_NotSet);
  138.     // Add seq_entry, default priority is higher than for defaults or loaders
  139.     CSeq_entry_Handle AddTopLevelSeqEntry(CSeq_entry& top_entry,
  140.                                           TPriority pri = kPriority_NotSet);
  141.     // Add bioseq, return bioseq handle. Try to use unresolved seq-id
  142.     // from the bioseq, fail if all ids are already resolved to
  143.     // other sequences.
  144.     CBioseq_Handle AddBioseq(CBioseq& bioseq,
  145.                              TPriority pri = kPriority_NotSet);
  146.     // Add Seq-annot
  147.     CSeq_annot_Handle AddSeq_annot(const CSeq_annot& annot,
  148.                                    TPriority pri = kPriority_NotSet);
  150.     CBioseq_EditHandle GetEditHandle(const CBioseq_Handle& seq);
  151.     CSeq_entry_EditHandle GetEditHandle(const CSeq_entry_Handle& entry);
  152.     CSeq_annot_EditHandle GetEditHandle(const CSeq_annot_Handle& annot);
  153.     CBioseq_set_EditHandle GetEditHandle(const CBioseq_set_Handle& seqset);
  155.     void ResetHistory(void);
  157.     CConstRef<CSynonymsSet> GetSynonyms(const CSeq_id& id);
  158.     CConstRef<CSynonymsSet> GetSynonyms(const CSeq_id_Handle& id);
  159.     CConstRef<CSynonymsSet> GetSynonyms(const CBioseq_Handle& bh);
  161.     // deprecated interface
  162.     void AttachEntry(CSeq_entry& parent, CSeq_entry& entry);
  163.     void RemoveEntry(CSeq_entry& entry);
  165.     void AttachAnnot(CSeq_entry& parent, CSeq_annot& annot);
  166.     void RemoveAnnot(CSeq_entry& parent, CSeq_annot& annot);
  167.     void ReplaceAnnot(CSeq_entry& entry,
  168.                       CSeq_annot& old_annot, CSeq_annot& new_annot);
  170.     CBioseq_Handle GetBioseqHandleFromTSE(const CSeq_id& id,
  171.                                           const CSeq_entry& tse);
  172.     CBioseq_Handle GetBioseqHandleFromTSE(const CSeq_id_Handle& id,
  173.                                           const CSeq_entry& tse);
  175.     enum ETSEKind {
  176.         eManualTSEs,
  177.         eAllTSEs
  178.     };
  179.     typedef vector<CSeq_entry_Handle> TTSE_Handles;
  180.     void GetAllTSEs(TTSE_Handles& tses, enum ETSEKind kind = eManualTSEs);
  182. protected:
  183.     CScope_Impl& GetImpl(void);
  185. private:
  186.     // to prevent copying
  187.     CScope(const CScope&);
  188.     CScope& operator=(const CScope&);
  190.     friend class CSeqMap_CI;
  191.     friend class CSeq_annot_CI;
  192.     friend class CAnnot_Collector;
  193.     friend class CBioseq_CI;
  194.     friend class CHeapScope;
  195.     friend class CPrefetchToken_Impl;
  197.     CRef<CScope>      m_HeapScope;
  198.     CRef<CScope_Impl> m_Impl;
  199. };
  202. /////////////////////////////////////////////////////////////////////////////
  203. // CScope inline methods
  204. /////////////////////////////////////////////////////////////////////////////
  207. inline
  208. CScope_Impl& CScope::GetImpl(void)
  209. {
  210.     return *m_Impl;
  211. }
  214. END_SCOPE(objects)
  215. END_NCBI_SCOPE
  217. /*
  218. * ---------------------------------------------------------------------------
  219. * $Log: scope.hpp,v $
  220. * Revision 1000.6  2004/04/16 16:59:56  gouriano
  221. * PRODUCTION: UPGRADED [CATCHUP_003] Dev-tree R1.78
  222. *
  223. * Revision 1.78  2004/04/16 13:31:46  grichenk
  224. * Added data pre-fetching functions.
  225. *
  226. * Revision 1.77  2004/04/13 16:39:36  grichenk
  227. * Corrected comments
  228. *
  229. * Revision 1.76  2004/04/13 15:59:35  grichenk
  230. * Added CScope::GetBioseqHandle() with id resolving flag.
  231. *
  232. * Revision 1.75  2004/04/12 18:40:24  grichenk
  233. * Added GetAllTSEs()
  234. *
  235. * Revision 1.74  2004/04/05 15:56:13  grichenk
  236. * Redesigned CAnnotTypes_CI: moved all data and data collecting
  237. * functions to CAnnotDataCollector. CAnnotTypes_CI is no more
  238. * inherited from SAnnotSelector.
  239. *
  240. * Revision 1.73  2004/03/24 18:30:28  vasilche
  241. * Fixed edit API.
  242. * Every *_Info object has its own shallow copy of original object.
  243. *
  244. * Revision 1.72  2004/03/16 15:47:26  vasilche
  245. * Added CBioseq_set_Handle and set of EditHandles
  246. *
  247. * Revision 1.71  2004/02/19 17:23:00  vasilche
  248. * Changed order of deletion of heap scope and scope impl objects.
  249. * Reduce number of calls to x_ResetHistory().
  250. *
  251. * Revision 1.70  2004/02/02 14:46:42  vasilche
  252. * Several performance fixed - do not iterate whole tse set in CDataSource.
  253. *
  254. * Revision 1.69  2004/01/29 20:33:27  vasilche
  255. * Do not resolve any Seq-ids in CScope::GetSynonyms() -
  256. * assume all not resolved Seq-id as synonym.
  257. * Seq-id conflict messages made clearer.
  258. *
  259. * Revision 1.68  2004/01/27 17:11:13  ucko
  260. * Remove redundant forward declaration of CTSE_Info
  261. *
  262. * Revision 1.67  2003/12/29 20:04:52  grichenk
  263. * CHeapScope can be initialized with null pointer.
  264. *
  265. * Revision 1.66  2003/12/18 16:38:05  grichenk
  266. * Added CScope::RemoveEntry()
  267. *
  268. * Revision 1.65  2003/11/28 15:13:24  grichenk
  269. * Added CSeq_entry_Handle
  270. *
  271. * Revision 1.64  2003/11/21 20:33:03  grichenk
  272. * Added GetBioseqHandleFromTSE(CSeq_id, CSeq_entry)
  273. *
  274. * Revision 1.63  2003/11/12 15:49:48  vasilche
  275. * Added loading annotations on non gi Seq-id.
  276. *
  277. * Revision 1.62  2003/10/07 13:43:22  vasilche
  278. * Added proper handling of named Seq-annots.
  279. * Added feature search from named Seq-annots.
  280. * Added configurable adaptive annotation search (default: gene, cds, mrna).
  281. * Fixed selection of blobs for loading from GenBank.
  282. * Added debug checks to CSeq_id_Mapper for easier finding lost CSeq_id_Handles.
  283. * Fixed leaked split chunks annotation stubs.
  284. * Moved some classes definitions in separate *.cpp files.
  285. *
  286. * Revision 1.61  2003/09/30 16:21:59  vasilche
  287. * Updated internal object manager classes to be able to load ID2 data.
  288. * SNP blobs are loaded as ID2 split blobs - readers convert them automatically.
  289. * Scope caches results of requests for data to data loaders.
  290. * Optimized CSeq_id_Handle for gis.
  291. * Optimized bioseq lookup in scope.
  292. * Reduced object allocations in annotation iterators.
  293. * CScope is allowed to be destroyed before other objects using this scope are
  294. * deleted (feature iterators, bioseq handles etc).
  295. * Optimized lookup for matching Seq-ids in CSeq_id_Mapper.
  296. * Added 'adaptive' option to objmgr_demo application.
  297. *
  298. * Revision 1.60  2003/09/05 20:50:24  grichenk
  299. * +AddBioseq(CBioseq&)
  300. *
  301. * Revision 1.59  2003/09/03 19:59:59  grichenk
  302. * Added sequence filtering by level (mains/parts/all)
  303. *
  304. * Revision 1.58  2003/08/12 18:25:39  grichenk
  305. * Fixed default priorities
  306. *
  307. * Revision 1.57  2003/08/06 20:51:14  grichenk
  308. * Removed declarations of non-existent methods
  309. *
  310. * Revision 1.56  2003/08/04 17:02:57  grichenk
  311. * Added constructors to iterate all annotations from a
  312. * seq-entry or seq-annot.
  313. *
  314. * Revision 1.55  2003/07/25 15:25:22  grichenk
  315. * Added CSeq_annot_CI class
  316. *
  317. * Revision 1.54  2003/07/17 20:07:55  vasilche
  318. * Reduced memory usage by feature indexes.
  319. * SNP data is loaded separately through PUBSEQ_OS.
  320. * String compression for SNP data.
  321. *
  322. * Revision 1.53  2003/06/30 18:42:09  vasilche
  323. * CPriority_I made to use less memory allocations/deallocations.
  324. *
  325. * Revision 1.52  2003/06/19 18:34:07  vasilche
  326. * Fixed compilation on Windows.
  327. *
  328. * Revision 1.51  2003/06/19 18:23:44  vasilche
  329. * Added several CXxx_ScopeInfo classes for CScope related information.
  330. * CBioseq_Handle now uses reference to CBioseq_ScopeInfo.
  331. * Some fine tuning of locking in CScope.
  332. *
  333. * Revision 1.49  2003/05/27 19:44:04  grichenk
  334. * Added CSeqVector_CI class
  335. *
  336. * Revision 1.48  2003/05/20 15:44:37  vasilche
  337. * Fixed interaction of CDataSource and CDataLoader in multithreaded app.
  338. * Fixed some warnings on WorkShop.
  339. * Added workaround for memory leak on WorkShop.
  340. *
  341. * Revision 1.47  2003/05/14 18:39:25  grichenk
  342. * Simplified TSE caching and filtering in CScope, removed
  343. * some obsolete members and functions.
  344. *
  345. * Revision 1.46  2003/05/12 19:18:28  vasilche
  346. * Fixed locking of object manager classes in multi-threaded application.
  347. *
  348. * Revision 1.45  2003/05/06 18:54:06  grichenk
  349. * Moved TSE filtering from CDataSource to CScope, changed
  350. * some filtering rules (e.g. priority is now more important
  351. * than scope history). Added more caches to CScope.
  352. *
  353. * Revision 1.44  2003/04/29 19:51:12  vasilche
  354. * Fixed interaction of Data Loader garbage collector and TSE locking mechanism.
  355. * Made some typedefs more consistent.
  356. *
  357. * Revision 1.43  2003/04/24 17:24:57  vasilche
  358. * SAnnotSelector is struct.
  359. * Added include required by MS VC.
  360. *
  361. * Revision 1.42  2003/04/24 16:12:37  vasilche
  362. * Object manager internal structures are splitted more straightforward.
  363. * Removed excessive header dependencies.
  364. *
  365. * Revision 1.41  2003/04/09 16:04:29  grichenk
  366. * SDataSourceRec replaced with CPriorityNode
  367. * Added CScope::AddScope(scope, priority) to allow scope nesting
  368. *
  369. * Revision 1.40  2003/04/03 14:18:08  vasilche
  370. * Added public GetSynonyms() method.
  371. *
  372. * Revision 1.39  2003/03/26 21:00:07  grichenk
  373. * Added seq-id -> tse with annotation cache to CScope
  374. *
  375. * Revision 1.38  2003/03/24 21:26:42  grichenk
  376. * Added support for CTSE_CI
  377. *
  378. * Revision 1.37  2003/03/21 19:22:48  grichenk
  379. * Redesigned TSE locking, replaced CTSE_Lock with CRef<CTSE_Info>.
  380. *
  381. * Revision 1.36  2003/03/18 14:46:36  grichenk
  382. * Set limit object type to "none" if the object is null.
  383. *
  384. * Revision 1.35  2003/03/12 20:09:30  grichenk
  385. * Redistributed members between CBioseq_Handle, CBioseq_Info and CTSE_Info
  386. *
  387. * Revision 1.34  2003/03/11 14:15:49  grichenk
  388. * +Data-source priority
  389. *
  390. * Revision 1.33  2003/03/10 16:55:16  vasilche
  391. * Cleaned SAnnotSelector structure.
  392. * Added shortcut when features are limited to one TSE.
  393. *
  394. * Revision 1.32  2003/03/03 20:32:47  vasilche
  395. * Removed obsolete method GetSynonyms().
  396. *
  397. * Revision 1.31  2003/02/28 20:02:35  grichenk
  398. * Added synonyms cache and x_GetSynonyms()
  399. *
  400. * Revision 1.30  2003/02/27 14:35:32  vasilche
  401. * Splitted PopulateTSESet() by logically independent parts.
  402. *
  403. * Revision 1.29  2003/02/24 18:57:21  vasilche
  404. * Make feature gathering in one linear pass using CSeqMap iterator.
  405. * Do not use feture index by sub locations.
  406. * Sort features at the end of gathering in one vector.
  407. * Extracted some internal structures and classes in separate header.
  408. * Delay creation of mapped features.
  409. *
  410. * Revision 1.28  2003/01/22 20:11:53  vasilche
  411. * Merged functionality of CSeqMapResolved_CI to CSeqMap_CI.
  412. * CSeqMap_CI now supports resolution and iteration over sequence range.
  413. * Added several caches to CScope.
  414. * Optimized CSeqVector().
  415. * Added serveral variants of CBioseqHandle::GetSeqVector().
  416. * Tried to optimize annotations iterator (not much success).
  417. * Rewritten CHandleRange and CHandleRangeMap classes to avoid sorting of list.
  418. *
  419. * Revision 1.27  2002/12/26 20:51:36  dicuccio
  420. * Added Win32 export specifier
  421. *
  422. * Revision 1.26  2002/12/26 16:39:21  vasilche
  423. * Object manager class CSeqMap rewritten.
  424. *
  425. * Revision 1.25  2002/11/08 22:15:50  grichenk
  426. * Added methods for removing/replacing annotations
  427. *
  428. * Revision 1.24  2002/11/01 05:34:06  kans
  429. * added GetBioseqHandle taking CBioseq parameter
  430. *
  431. * Revision 1.23  2002/10/31 22:25:09  kans
  432. * added GetBioseqHandle taking CSeq_loc parameter
  433. *
  434. * Revision 1.22  2002/10/18 19:12:39  grichenk
  435. * Removed mutex pools, converted most static mutexes to non-static.
  436. * Protected CSeqMap::x_Resolve() with mutex. Modified code to prevent
  437. * dead-locks.
  438. *
  439. * Revision 1.21  2002/10/02 17:58:21  grichenk
  440. * Added sequence type filter to CBioseq_CI
  441. *
  442. * Revision 1.20  2002/09/30 20:01:17  grichenk
  443. * Added methods to support CBioseq_CI
  444. *
  445. * Revision 1.19  2002/07/08 20:50:56  grichenk
  446. * Moved log to the end of file
  447. * Replaced static mutex (in CScope, CDataSource) with the mutex
  448. * pool. Redesigned CDataSource data locking.
  449. *
  450. * Revision 1.18  2002/06/04 17:18:32  kimelman
  451. * memory cleanup :  new/delete/Cref rearrangements
  452. *
  453. * Revision 1.17  2002/05/28 18:01:11  gouriano
  454. * DebugDump added
  455. *
  456. * Revision 1.16  2002/05/14 20:06:23  grichenk
  457. * Improved CTSE_Info locking by CDataSource and CDataLoader
  458. *
  459. * Revision 1.15  2002/05/06 03:30:36  vakatov
  460. * OM/OM1 renaming
  461. *
  462. * Revision 1.14  2002/05/03 21:28:02  ucko
  463. * Introduce T(Signed)SeqPos.
  464. *
  465. * Revision 1.13  2002/04/17 21:09:38  grichenk
  466. * Fixed annotations loading
  467. *
  468. * Revision 1.12  2002/04/08 19:14:15  gouriano
  469. * corrected comment to AddDefaults()
  470. *
  471. * Revision 1.11  2002/03/27 18:46:26  gouriano
  472. * three functions made public
  473. *
  474. * Revision 1.10  2002/03/20 21:20:38  grichenk
  475. * +CScope::ResetHistory()
  476. *
  477. * Revision 1.9  2002/02/21 19:27:00  grichenk
  478. * Rearranged includes. Added scope history. Added searching for the
  479. * best seq-id match in data sources and scopes. Updated tests.
  480. *
  481. * Revision 1.8  2002/02/07 21:27:33  grichenk
  482. * Redesigned CDataSource indexing: seq-id handle -> TSE -> seq/annot
  483. *
  484. * Revision 1.7  2002/02/06 21:46:43  gouriano
  485. * *** empty log message ***
  486. *
  487. * Revision 1.6  2002/02/05 21:47:21  gouriano
  488. * added FindSeqid function, minor tuneup in CSeq_id_mapper
  489. *
  490. * Revision 1.5  2002/01/28 19:45:33  gouriano
  491. * changed the interface of BioseqHandle: two functions moved from Scope
  492. *
  493. * Revision 1.4  2002/01/23 21:59:29  grichenk
  494. * Redesigned seq-id handles and mapper
  495. *
  496. * Revision 1.3  2002/01/18 17:07:12  gouriano
  497. * renamed GetSequence to GetSeqVector
  498. *
  499. * Revision 1.2  2002/01/16 16:26:35  gouriano
  500. * restructured objmgr
  501. *
  502. * Revision 1.1  2002/01/11 19:04:03  gouriano
  503. * restructured objmgr
  504. *
  505. *
  506. * ===========================================================================
  507. */
  509. #endif//OBJMGR_SCOPE__HPP