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

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

生物技术

开发平台：

C/C++

annot_types_ci.hpp：源码内容
  1. /*
  2.  * ===========================================================================
  3.  * PRODUCTION $Log: annot_types_ci.hpp,v $
  4.  * PRODUCTION Revision 1000.3  2004/04/12 17:27:00  gouriano
  5.  * PRODUCTION PRODUCTION: UPGRADED [CATCHUP_003] Dev-tree R1.70
  6.  * PRODUCTION
  7.  * ===========================================================================
  8.  */
  10. #ifndef ANNOT_TYPES_CI__HPP
  11. #define ANNOT_TYPES_CI__HPP
  13. /*  $Id: annot_types_ci.hpp,v 1000.3 2004/04/12 17:27:00 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, Michael Kimelman, Eugene Vasilchenko
  39. *
  40. * File Description:
  41. *   Object manager iterators
  42. *
  43. */
  45. #include <objmgr/impl/annot_collector.hpp>
  47. BEGIN_NCBI_SCOPE
  49. BEGIN_SCOPE(objects)
  51. // Base class for specific annotation iterators
  52. class NCBI_XOBJMGR_EXPORT CAnnotTypes_CI
  53. {
  54. public:
  55.     typedef SAnnotSelector::TAnnotType TAnnotType;
  57.     CAnnotTypes_CI(void);
  59.     // short methods
  60.     CAnnotTypes_CI(TAnnotType type,
  61.                    CScope& scope,
  62.                    const CSeq_loc& loc,
  63.                    const SAnnotSelector& params);
  64.     CAnnotTypes_CI(TAnnotType type,
  65.                    const CBioseq_Handle& bioseq,
  66.                    TSeqPos start, TSeqPos stop,
  67.                    const SAnnotSelector& params);
  68.     // Iterate everything from the seq-annot
  69.     CAnnotTypes_CI(TAnnotType type,
  70.                    const CSeq_annot_Handle& annot);
  71.     // Iterate everything from the seq-annot
  72.     CAnnotTypes_CI(TAnnotType type,
  73.                    const CSeq_annot_Handle& annot,
  74.                    const SAnnotSelector& params);
  75.     // Iterate everything from the seq-entry
  76.     CAnnotTypes_CI(TAnnotType type,
  77.                    const CSeq_entry_Handle& entry);
  78.     // Iterate everything from the seq-entry
  79.     CAnnotTypes_CI(TAnnotType type,
  80.                    const CSeq_entry_Handle& entry,
  81.                    const SAnnotSelector& params);
  83.     // Search all TSEs in all datasources, by default get annotations defined
  84.     // on segments in the same TSE (eResolve_TSE method).
  85.     CAnnotTypes_CI(TAnnotType type,
  86.                    CScope& scope,
  87.                    const CSeq_loc& loc,
  88.                    //const SAnnotSelector& selector,
  89.                    SAnnotSelector::EOverlapType overlap_type,
  90.                    SAnnotSelector::EResolveMethod resolve);
  91.     // Search only in TSE, containing the bioseq, by default get annotations
  92.     // defined on segments in the same TSE (eResolve_TSE method).
  93.     // If "entry" is set, search only annotations from the seq-entry specified
  94.     // (but no its sub-entries or parent entry).
  95.     CAnnotTypes_CI(TAnnotType type,
  96.                    const CBioseq_Handle& bioseq,
  97.                    TSeqPos start, TSeqPos stop,
  98.                    //const SAnnotSelector& selector,
  99.                    SAnnotSelector::EOverlapType overlap_type,
  100.                    SAnnotSelector::EResolveMethod resolve);
  101.     virtual ~CAnnotTypes_CI(void);
  103.     // Rewind annot iterator to point to the very first annot object,
  104.     // the same as immediately after construction.
  105.     void Rewind(void);
  107.     CSeq_annot_Handle GetAnnot(void) const;
  108.     const CSeq_annot& GetSeq_annot(void) const;
  110.     // Get number of annotations
  111.     size_t GetSize(void) const;
  113. protected:
  114.     typedef CAnnot_Collector::TAnnotSet TAnnotSet;
  115.     typedef TAnnotSet::const_iterator   TIterator;
  117.     // Check if a datasource and an annotation are selected.
  118.     bool IsValid(void) const;
  119.     // Move to the next valid position
  120.     void Next(void);
  121.     void Prev(void);
  122.     // Return current annotation
  123.     const CAnnotObject_Ref& Get(void) const;
  124.     CScope& GetScope(void) const;
  126.     CAnnot_Collector& GetCollector(void);
  127.     const TIterator& GetIterator(void) const;
  129. private:
  130.     const TAnnotSet& x_GetAnnotSet(void) const;
  132.     CRef<CAnnot_Collector> m_DataCollector;
  133.     // Current annotation
  134.     TIterator              m_CurrAnnot;
  135. };
  138. /////////////////////////////////////////////////////////////////////////////
  139. // CAnnotTypes_CI
  140. /////////////////////////////////////////////////////////////////////////////
  143. inline
  144. const CAnnotTypes_CI::TAnnotSet& CAnnotTypes_CI::x_GetAnnotSet(void) const
  145. {
  146.     _ASSERT(m_DataCollector);
  147.     return m_DataCollector->GetAnnotSet();
  148. }
  151. inline
  152. bool CAnnotTypes_CI::IsValid(void) const
  153. {
  154.     return bool(m_DataCollector)
  155.         &&  m_CurrAnnot != x_GetAnnotSet().end();
  156. }
  159. inline
  160. void CAnnotTypes_CI::Rewind(void)
  161. {
  162.     m_CurrAnnot = x_GetAnnotSet().begin();
  163. }
  166. inline
  167. void CAnnotTypes_CI::Next(void)
  168. {
  169.     ++m_CurrAnnot;
  170. }
  173. inline
  174. void CAnnotTypes_CI::Prev(void)
  175. {
  176.     --m_CurrAnnot;
  177. }
  180. inline
  181. const CAnnotObject_Ref& CAnnotTypes_CI::Get(void) const
  182. {
  183.     _ASSERT( IsValid() );
  184.     return *m_CurrAnnot;
  185. }
  188. inline
  189. CAnnot_Collector& CAnnotTypes_CI::GetCollector(void)
  190. {
  191.     _ASSERT(m_DataCollector);
  192.     return *m_DataCollector;
  193. }
  196. inline
  197. const CAnnotTypes_CI::TIterator& CAnnotTypes_CI::GetIterator(void) const
  198. {
  199.     _ASSERT( IsValid() );
  200.     return m_CurrAnnot;
  201. }
  204. inline
  205. size_t CAnnotTypes_CI::GetSize(void) const
  206. {
  207.     return x_GetAnnotSet().size();
  208. }
  210. inline
  211. CScope& CAnnotTypes_CI::GetScope(void) const
  212. {
  213.     _ASSERT(m_DataCollector);
  214.     return m_DataCollector->GetScope();
  215. }
  218. END_SCOPE(objects)
  219. END_NCBI_SCOPE
  221. /*
  222. * ---------------------------------------------------------------------------
  223. * $Log: annot_types_ci.hpp,v $
  224. * Revision 1000.3  2004/04/12 17:27:00  gouriano
  225. * PRODUCTION: UPGRADED [CATCHUP_003] Dev-tree R1.70
  226. *
  227. * Revision 1.70  2004/04/07 13:20:16  grichenk
  228. * Moved more data from iterators to CAnnot_Collector
  229. *
  230. * Revision 1.69  2004/04/05 15:56:13  grichenk
  231. * Redesigned CAnnotTypes_CI: moved all data and data collecting
  232. * functions to CAnnotDataCollector. CAnnotTypes_CI is no more
  233. * inherited from SAnnotSelector.
  234. *
  235. * Revision 1.68  2004/03/16 18:09:29  vasilche
  236. * Include <memory> for auto_ptr
  237. *
  238. * Revision 1.67  2004/03/16 15:47:25  vasilche
  239. * Added CBioseq_set_Handle and set of EditHandles
  240. *
  241. * Revision 1.66  2004/02/19 19:25:08  vasilche
  242. * Hidded implementation of CAnnotObject_Ref.
  243. * Added necessary access methods.
  244. *
  245. * Revision 1.65  2004/02/19 17:14:36  vasilche
  246. * Removed unused include.
  247. *
  248. * Revision 1.64  2004/02/06 18:31:53  vasilche
  249. * Fixed annot sorting class - deal with different annot types (graph align feat).
  250. *
  251. * Revision 1.63  2004/02/05 19:53:39  grichenk
  252. * Fixed type matching in SAnnotSelector. Added IncludeAnnotType().
  253. *
  254. * Revision 1.62  2004/02/04 18:05:32  grichenk
  255. * Added annotation filtering by set of types/subtypes.
  256. * Renamed *Choice to *Type in SAnnotSelector.
  257. *
  258. * Revision 1.61  2004/01/28 20:54:34  vasilche
  259. * Fixed mapping of annotations.
  260. *
  261. * Revision 1.60  2004/01/23 16:14:45  grichenk
  262. * Implemented alignment mapping
  263. *
  264. * Revision 1.59  2003/11/10 18:11:03  grichenk
  265. * Moved CSeq_loc_Conversion_Set to seq_loc_cvt
  266. *
  267. * Revision 1.58  2003/11/04 21:10:00  grichenk
  268. * Optimized feature mapping through multiple segments.
  269. * Fixed problem with CAnnotTypes_CI not releasing scope
  270. * when exception is thrown from constructor.
  271. *
  272. * Revision 1.57  2003/11/04 16:21:36  grichenk
  273. * Updated CAnnotTypes_CI to map whole features instead of splitting
  274. * them by sequence segments.
  275. *
  276. * Revision 1.56  2003/10/27 20:07:10  vasilche
  277. * Started implementation of full annotations' mapping.
  278. *
  279. * Revision 1.55  2003/10/09 20:20:59  vasilche
  280. * Added possibility to include and exclude Seq-annot names to annot iterator.
  281. * Fixed adaptive search. It looked only on selected set of annot names before.
  282. *
  283. * Revision 1.54  2003/10/07 13:43:22  vasilche
  284. * Added proper handling of named Seq-annots.
  285. * Added feature search from named Seq-annots.
  286. * Added configurable adaptive annotation search (default: gene, cds, mrna).
  287. * Fixed selection of blobs for loading from GenBank.
  288. * Added debug checks to CSeq_id_Mapper for easier finding lost CSeq_id_Handles.
  289. * Fixed leaked split chunks annotation stubs.
  290. * Moved some classes definitions in separate *.cpp files.
  291. *
  292. * Revision 1.53  2003/09/30 16:21:59  vasilche
  293. * Updated internal object manager classes to be able to load ID2 data.
  294. * SNP blobs are loaded as ID2 split blobs - readers convert them automatically.
  295. * Scope caches results of requests for data to data loaders.
  296. * Optimized CSeq_id_Handle for gis.
  297. * Optimized bioseq lookup in scope.
  298. * Reduced object allocations in annotation iterators.
  299. * CScope is allowed to be destroyed before other objects using this scope are
  300. * deleted (feature iterators, bioseq handles etc).
  301. * Optimized lookup for matching Seq-ids in CSeq_id_Mapper.
  302. * Added 'adaptive' option to objmgr_demo application.
  303. *
  304. * Revision 1.52  2003/09/12 15:50:09  grichenk
  305. * Updated adaptive-depth triggering
  306. *
  307. * Revision 1.51  2003/09/11 17:45:06  grichenk
  308. * Added adaptive-depth option to annot-iterators.
  309. *
  310. * Revision 1.50  2003/09/03 19:59:00  grichenk
  311. * Initialize m_MappedIndex to 0
  312. *
  313. * Revision 1.49  2003/08/27 21:23:35  vasilche
  314. * Fixed warning.
  315. *
  316. * Revision 1.48  2003/08/27 14:28:50  vasilche
  317. * Reduce amount of object allocations in feature iteration.
  318. *
  319. * Revision 1.47  2003/08/22 14:58:55  grichenk
  320. * Added NoMapping flag (to be used by CAnnot_CI for faster fetching).
  321. * Added GetScope().
  322. *
  323. * Revision 1.46  2003/08/15 19:19:15  vasilche
  324. * Fixed memory leak in string packing hooks.
  325. * Fixed processing of 'partial' flag of features.
  326. * Allow table packing of non-point SNP.
  327. * Allow table packing of SNP with long alleles.
  328. *
  329. * Revision 1.45  2003/08/14 20:05:18  vasilche
  330. * Simple SNP features are stored as table internally.
  331. * They are recreated when needed using CFeat_CI.
  332. *
  333. * Revision 1.44  2003/08/04 17:02:57  grichenk
  334. * Added constructors to iterate all annotations from a
  335. * seq-entry or seq-annot.
  336. *
  337. * Revision 1.43  2003/07/18 19:39:44  vasilche
  338. * Workaround for GCC 3.0.4 bug.
  339. *
  340. * Revision 1.42  2003/07/17 20:07:55  vasilche
  341. * Reduced memory usage by feature indexes.
  342. * SNP data is loaded separately through PUBSEQ_OS.
  343. * String compression for SNP data.
  344. *
  345. * Revision 1.41  2003/06/25 20:56:29  grichenk
  346. * Added max number of annotations to annot-selector, updated demo.
  347. *
  348. * Revision 1.40  2003/06/02 16:01:36  dicuccio
  349. * Rearranged include/objects/ subtree.  This includes the following shifts:
  350. *     - include/objects/alnmgr --> include/objtools/alnmgr
  351. *     - include/objects/cddalignview --> include/objtools/cddalignview
  352. *     - include/objects/flat --> include/objtools/flat
  353. *     - include/objects/objmgr/ --> include/objmgr/
  354. *     - include/objects/util/ --> include/objmgr/util/
  355. *     - include/objects/validator --> include/objtools/validator
  356. *
  357. * Revision 1.39  2003/04/29 19:51:12  vasilche
  358. * Fixed interaction of Data Loader garbage collector and TSE locking mechanism.
  359. * Made some typedefs more consistent.
  360. *
  361. * Revision 1.38  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.37  2003/03/27 19:40:10  vasilche
  366. * Implemented sorting in CGraph_CI.
  367. * Added Rewind() method to feature/graph/align iterators.
  368. *
  369. * Revision 1.36  2003/03/21 19:22:48  grichenk
  370. * Redesigned TSE locking, replaced CTSE_Lock with CRef<CTSE_Info>.
  371. *
  372. * Revision 1.35  2003/03/18 21:48:27  grichenk
  373. * Removed obsolete class CAnnot_CI
  374. *
  375. * Revision 1.34  2003/03/05 20:56:42  vasilche
  376. * SAnnotSelector now holds all parameters of annotation iterators.
  377. *
  378. * Revision 1.33  2003/02/28 19:27:20  vasilche
  379. * Cleaned Seq_loc conversion class.
  380. *
  381. * Revision 1.32  2003/02/27 20:56:51  vasilche
  382. * Use one method for lookup on main sequence and segments.
  383. *
  384. * Revision 1.31  2003/02/27 14:35:32  vasilche
  385. * Splitted PopulateTSESet() by logically independent parts.
  386. *
  387. * Revision 1.30  2003/02/26 17:54:14  vasilche
  388. * Added cached total range of mapped location.
  389. *
  390. * Revision 1.29  2003/02/24 21:35:21  vasilche
  391. * Reduce checks in CAnnotObject_Ref comparison.
  392. * Fixed compilation errors on MS Windows.
  393. * Removed obsolete file src/objects/objmgr/annot_object.hpp.
  394. *
  395. * Revision 1.28  2003/02/24 18:57:20  vasilche
  396. * Make feature gathering in one linear pass using CSeqMap iterator.
  397. * Do not use feture index by sub locations.
  398. * Sort features at the end of gathering in one vector.
  399. * Extracted some internal structures and classes in separate header.
  400. * Delay creation of mapped features.
  401. *
  402. * Revision 1.27  2003/02/13 14:34:31  grichenk
  403. * Renamed CAnnotObject -> CAnnotObject_Info
  404. * + CSeq_annot_Info and CAnnotObject_Ref
  405. * Moved some members of CAnnotObject to CSeq_annot_Info
  406. * and CAnnotObject_Ref.
  407. * Added feat/align/graph to CAnnotObject_Info map
  408. * to CDataSource.
  409. *
  410. * Revision 1.26  2003/02/04 21:44:10  grichenk
  411. * Convert seq-loc instead of seq-annot to the master coordinates
  412. *
  413. * Revision 1.25  2002/12/26 20:51:35  dicuccio
  414. * Added Win32 export specifier
  415. *
  416. * Revision 1.24  2002/12/26 16:39:21  vasilche
  417. * Object manager class CSeqMap rewritten.
  418. *
  419. * Revision 1.23  2002/12/24 15:42:44  grichenk
  420. * CBioseqHandle argument to annotation iterators made const
  421. *
  422. * Revision 1.22  2002/12/06 15:35:57  grichenk
  423. * Added overlap type for annot-iterators
  424. *
  425. * Revision 1.21  2002/11/04 21:28:58  grichenk
  426. * Fixed usage of const CRef<> and CRef<> constructor
  427. *
  428. * Revision 1.20  2002/11/01 20:46:41  grichenk
  429. * Added sorting to set< CRef<CAnnotObject> >
  430. *
  431. * Revision 1.19  2002/10/08 18:57:27  grichenk
  432. * Added feature sorting to the iterator class.
  433. *
  434. * Revision 1.18  2002/07/08 20:50:56  grichenk
  435. * Moved log to the end of file
  436. * Replaced static mutex (in CScope, CDataSource) with the mutex
  437. * pool. Redesigned CDataSource data locking.
  438. *
  439. * Revision 1.17  2002/05/31 17:52:58  grichenk
  440. * Optimized for better performance (CTSE_Info uses atomic counter,
  441. * delayed annotations indexing, no location convertions in
  442. * CAnnot_Types_CI if no references resolution is required etc.)
  443. *
  444. * Revision 1.16  2002/05/24 14:58:53  grichenk
  445. * Fixed Empty() for unsigned intervals
  446. * SerialAssign<>() -> CSerialObject::Assign()
  447. * Improved performance for eResolve_None case
  448. *
  449. * Revision 1.15  2002/05/06 03:30:35  vakatov
  450. * OM/OM1 renaming
  451. *
  452. * Revision 1.14  2002/05/03 21:28:01  ucko
  453. * Introduce T(Signed)SeqPos.
  454. *
  455. * Revision 1.13  2002/04/30 14:30:41  grichenk
  456. * Added eResolve_TSE flag in CAnnot_Types_CI, made it default
  457. *
  458. * Revision 1.12  2002/04/22 20:06:15  grichenk
  459. * Minor changes in private interface
  460. *
  461. * Revision 1.11  2002/04/17 21:11:58  grichenk
  462. * Fixed annotations loading
  463. * Set "partial" flag in features if necessary
  464. * Implemented most seq-loc types in reference resolving methods
  465. * Fixed searching for annotations within a signle TSE
  466. *
  467. * Revision 1.10  2002/04/11 12:07:28  grichenk
  468. * Redesigned CAnnotTypes_CI to resolve segmented sequences correctly.
  469. *
  470. * Revision 1.9  2002/04/05 21:26:16  grichenk
  471. * Enabled iteration over annotations defined on segments of a
  472. * delta-sequence.
  473. *
  474. * Revision 1.8  2002/03/07 21:25:31  grichenk
  475. * +GetSeq_annot() in annotation iterators
  476. *
  477. * Revision 1.7  2002/03/05 16:08:12  grichenk
  478. * Moved TSE-restriction to new constructors
  479. *
  480. * Revision 1.6  2002/03/04 15:07:46  grichenk
  481. * Added "bioseq" argument to CAnnotTypes_CI constructor to iterate
  482. * annotations from a single TSE.
  483. *
  484. * Revision 1.5  2002/02/21 19:27:00  grichenk
  485. * Rearranged includes. Added scope history. Added searching for the
  486. * best seq-id match in data sources and scopes. Updated tests.
  487. *
  488. * Revision 1.4  2002/02/15 20:36:29  gouriano
  489. * changed implementation of HandleRangeMap
  490. *
  491. * Revision 1.3  2002/02/07 21:27:33  grichenk
  492. * Redesigned CDataSource indexing: seq-id handle -> TSE -> seq/annot
  493. *
  494. * Revision 1.2  2002/01/16 16:26:35  gouriano
  495. * restructured objmgr
  496. *
  497. * Revision 1.1  2002/01/11 19:03:59  gouriano
  498. * restructured objmgr
  499. *
  500. *
  501. * ===========================================================================
  502. */
  504. #endif  // ANNOT_TYPES_CI__HPP