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

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

生物技术

开发平台：

C/C++

feat_ci.hpp：源码内容
  1. /*
  2.  * ===========================================================================
  3.  * PRODUCTION $Log: feat_ci.hpp,v $
  4.  * PRODUCTION Revision 1000.3  2004/06/01 19:21:22  gouriano
  5.  * PRODUCTION PRODUCTION: UPGRADED [GCC34_MSVC7] Dev-tree R1.41
  6.  * PRODUCTION
  7.  * ===========================================================================
  8.  */
  10. #ifndef FEAT_CI__HPP
  11. #define FEAT_CI__HPP
  13. /*  $Id: feat_ci.hpp,v 1000.3 2004/06/01 19:21:22 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 <corelib/ncbistd.hpp>
  46. #include <objmgr/annot_types_ci.hpp>
  47. #include <objmgr/seq_annot_handle.hpp>
  48. #include <objmgr/seq_entry_handle.hpp>
  49. #include <objects/seqfeat/Seq_feat.hpp>
  50. #include <objects/seqloc/Seq_loc.hpp>
  51. #include <objmgr/seq_feat_handle.hpp>
  53. BEGIN_NCBI_SCOPE
  54. BEGIN_SCOPE(objects)
  57. class NCBI_XOBJMGR_EXPORT CMappedFeat
  58. {
  59. public:
  60.     CMappedFeat(void);
  61.     CMappedFeat(const CMappedFeat& feat);
  62.     CMappedFeat& operator=(const CMappedFeat& feat);
  63.     ~CMappedFeat(void);
  65.     // Original feature with unmapped location/product
  66.     const CSeq_feat& GetOriginalFeature(void) const;
  67.     // Original feature handle
  68.     CSeq_feat_Handle GetSeq_feat_Handle(void) const;
  70.     // Feature mapped to the master sequence.
  71.     // WARNING! The function is rather slow and should be used with care.
  72.     const CSeq_feat& GetMappedFeature(void) const;
  74.     bool IsSetId(void) const
  75.         { return GetOriginalFeature().IsSetId(); }
  76.     const CFeat_id& GetId(void) const
  77.         { return GetOriginalFeature().GetId(); }
  79.     const CSeqFeatData& GetData(void) const
  80.         { return GetOriginalFeature().GetData(); }
  82.     bool IsSetPartial(void) const
  83.         { return m_FeatRef->IsPartial(); }
  84.     bool GetPartial(void) const
  85.         { return m_FeatRef->IsPartial(); }
  87.     bool IsSetExcept(void) const
  88.         { return GetOriginalFeature().IsSetExcept(); }
  89.     bool GetExcept(void) const
  90.         { return GetOriginalFeature().GetExcept(); }
  92.     bool IsSetComment(void) const
  93.         { return GetOriginalFeature().IsSetComment(); }
  94.     const string& GetComment(void) const
  95.         { return GetOriginalFeature().GetComment(); }
  97.     bool IsSetProduct(void) const
  98.         { return GetOriginalFeature().IsSetProduct(); }
  99.     const CSeq_loc& GetProduct(void) const
  100.         {
  101.             return m_FeatRef->IsMappedProduct()?
  102.                 GetMappedLocation(): GetOriginalFeature().GetProduct();
  103.         }
  105.     const CSeq_loc& GetLocation(void) const
  106.         {
  107.             return m_FeatRef->IsMappedLocation()?
  108.                 GetMappedLocation(): GetOriginalFeature().GetLocation();
  109.         }
  111.     bool IsSetQual(void) const
  112.         { return GetOriginalFeature().IsSetQual(); }
  113.     const CSeq_feat::TQual& GetQual(void) const
  114.         { return GetOriginalFeature().GetQual(); }
  116.     bool IsSetTitle(void) const
  117.         { return GetOriginalFeature().IsSetTitle(); }
  118.     const string& GetTitle(void) const
  119.         { return GetOriginalFeature().GetTitle(); }
  121.     bool IsSetExt(void) const
  122.         { return GetOriginalFeature().IsSetExt(); }
  123.     const CUser_object& GetExt(void) const
  124.         { return GetOriginalFeature().GetExt(); }
  126.     bool IsSetCit(void) const
  127.         { return GetOriginalFeature().IsSetCit(); }
  128.     const CPub_set& GetCit(void) const
  129.         { return GetOriginalFeature().GetCit(); }
  131.     bool IsSetExp_ev(void) const
  132.         { return GetOriginalFeature().IsSetExp_ev(); }
  133.     CSeq_feat::EExp_ev GetExp_ev(void) const
  134.         { return GetOriginalFeature().GetExp_ev(); }
  136.     bool IsSetXref(void) const
  137.         { return GetOriginalFeature().IsSetXref(); }
  138.     const CSeq_feat::TXref& GetXref(void) const
  139.         { return GetOriginalFeature().GetXref(); }
  141.     bool IsSetDbxref(void) const
  142.         { return GetOriginalFeature().IsSetDbxref(); }
  143.     const CSeq_feat::TDbxref& GetDbxref(void) const
  144.         { return GetOriginalFeature().GetDbxref(); }
  146.     bool IsSetPseudo(void) const
  147.         { return GetOriginalFeature().IsSetPseudo(); }
  148.     bool GetPseudo(void) const
  149.         { return GetOriginalFeature().GetPseudo(); }
  151.     bool IsSetExcept_text(void) const
  152.         { return GetOriginalFeature().IsSetExcept_text(); }
  153.     const string& GetExcept_text(void) const
  154.         { return GetOriginalFeature().GetExcept_text(); }
  156.     CSeq_annot_Handle GetAnnot(void) const;
  157.     const CSeq_annot& GetSeq_annot(void) const;
  159. private:
  160.     friend class CFeat_CI;
  161.     friend class CAnnot_CI;
  163.     typedef CAnnot_Collector::TAnnotSet TAnnotSet;
  164.     typedef TAnnotSet::const_iterator   TIterator;
  166.     CMappedFeat& Set(CAnnot_Collector& collector,
  167.                      const TIterator& annot);
  168.     void Reset(void);
  170.     const CSeq_feat& x_MakeOriginalFeature(void) const;
  171.     const CSeq_feat& x_MakeMappedFeature(void) const;
  172.     const CSeq_loc& x_MakeMappedLocation(void) const;
  174.     const CSeq_loc& GetMappedLocation(void) const;
  176.     mutable CRef<CAnnot_Collector> m_Collector;
  177.     TIterator                      m_FeatRef;
  179.     mutable CConstRef<CSeq_feat> m_OriginalSeq_feat;
  180.     mutable CConstRef<CSeq_feat> m_MappedSeq_feat;
  181.     mutable CConstRef<CSeq_loc>  m_MappedSeq_loc;
  182. };
  185. class CSeq_annot_Handle;
  188. class NCBI_XOBJMGR_EXPORT CFeat_CI : public CAnnotTypes_CI
  189. {
  190. public:
  191.     enum EFeat_Location {
  192.         e_Location,
  193.         e_Product
  194.     };
  195.     CFeat_CI(void);
  197.     CFeat_CI(CScope& scope,
  198.              const CSeq_loc& loc);
  199.     CFeat_CI(const CBioseq_Handle& bioseq,
  200.              TSeqPos start, TSeqPos stop);
  201.     CFeat_CI(CScope& scope,
  202.              const CSeq_loc& loc,
  203.              const SAnnotSelector& sel);
  204.     CFeat_CI(const CBioseq_Handle& bioseq,
  205.              TSeqPos start, TSeqPos stop,
  206.              const SAnnotSelector& sel);
  208.     // Iterate all features from the object regardless of their location
  209.     CFeat_CI(CScope& scope, const CSeq_annot& annot);
  210.     CFeat_CI(CScope& scope, const CSeq_annot& annot,
  211.              const SAnnotSelector& sel);
  212.     CFeat_CI(const CSeq_annot_Handle& annot);
  213.     CFeat_CI(const CSeq_annot_Handle& annot,
  214.              const SAnnotSelector& sel);
  216.     CFeat_CI(CScope& scope, const CSeq_entry& entry);
  217.     CFeat_CI(CScope& scope, const CSeq_entry& entry,
  218.              const SAnnotSelector& sel);
  219.     CFeat_CI(const CSeq_entry_Handle& entry);
  220.     CFeat_CI(const CSeq_entry_Handle& entry,
  221.              const SAnnotSelector& sel);
  223.     typedef SAnnotSelector::TFeatType TFeatType;
  225.     // Search all TSEs in all datasources. By default search sequence segments
  226.     // (for constructed sequences) only if the referenced sequence is in the
  227.     // same TSE as the master one. Use CFeat_CI::eResolve_All flag to search
  228.     // features on all referenced sequences or CFeat_CI::eResolve_None to
  229.     // disable references resolving.
  230.     CFeat_CI(CScope& scope,
  231.              const CSeq_loc& loc,
  232.              TFeatType feat_type,
  233.              SAnnotSelector::EOverlapType overlap_type
  234.              = SAnnotSelector::eOverlap_Intervals,
  235.              SAnnotSelector::EResolveMethod resolve
  236.              = SAnnotSelector::eResolve_TSE,
  237.              EFeat_Location loc_type = e_Location);
  238.     // Search only in TSE, containing the bioseq. If both start & stop are 0,
  239.     // the whole bioseq is searched. References are resolved depending on the
  240.     // "resolve" flag (see above).
  241.     // If "entry" is set, search only features from the seq-entry specified
  242.     // (but no its sub-entries or parent entry).
  243.     CFeat_CI(const CBioseq_Handle& bioseq,
  244.              TSeqPos start, TSeqPos stop,
  245.              TFeatType feat_type,
  246.              SAnnotSelector::EOverlapType overlap_type
  247.              = SAnnotSelector::eOverlap_Intervals,
  248.              SAnnotSelector::EResolveMethod resolve
  249.              = SAnnotSelector::eResolve_TSE,
  250.              EFeat_Location loc_type = e_Location);
  251.     CFeat_CI(const CBioseq_Handle& bioseq,
  252.              TSeqPos start, TSeqPos stop,
  253.              TFeatType feat_type,
  254.              SAnnotSelector::EOverlapType overlap_type,
  255.              SAnnotSelector::EResolveMethod resolve,
  256.              EFeat_Location loc_type,
  257.              const CSeq_entry_Handle& limitEntry);
  258.     CFeat_CI(const CBioseq_Handle& bioseq,
  259.              TSeqPos start, TSeqPos stop,
  260.              TFeatType feat_type,
  261.              SAnnotSelector::EOverlapType overlap_type,
  262.              SAnnotSelector::EResolveMethod resolve,
  263.              EFeat_Location loc_type,
  264.              const CSeq_entry* limitEntry);
  265.     CFeat_CI(const CFeat_CI& iter);
  266.     virtual ~CFeat_CI(void);
  267.     CFeat_CI& operator= (const CFeat_CI& iter);
  269.     CFeat_CI& operator++(void);
  270.     CFeat_CI& operator--(void);
  271.     operator bool (void) const;
  273.     void Update(void);
  274.     void Rewind(void);
  276.     const CMappedFeat& operator* (void) const;
  277.     const CMappedFeat* operator-> (void) const;
  279. private:
  280.     CFeat_CI& operator++ (int);
  281.     CFeat_CI& operator-- (int);
  283.     mutable CMappedFeat m_OriginalSeq_feat; // current feature object returned by operator->()
  284. };
  288. inline
  289. void CFeat_CI::Update(void)
  290. {
  291.     if ( IsValid() ) {
  292.         m_OriginalSeq_feat.Set(GetCollector(), GetIterator());
  293.     }
  294.     else {
  295.         m_OriginalSeq_feat.Reset();
  296.     }
  297. }
  300. inline
  301. CFeat_CI::operator bool (void) const
  302. {
  303.     return IsValid();
  304. }
  307. inline
  308. CFeat_CI& CFeat_CI::operator++ (void)
  309. {
  310.     Next();
  311.     Update();
  312.     return *this;
  313. }
  316. inline
  317. CFeat_CI& CFeat_CI::operator-- (void)
  318. {
  319.     Prev();
  320.     Update();
  321.     return *this;
  322. }
  325. inline
  326. void CFeat_CI::Rewind(void)
  327. {
  328.     CAnnotTypes_CI::Rewind();
  329.     Update();
  330. }
  333. inline
  334. const CMappedFeat& CFeat_CI::operator* (void) const
  335. {
  336.     return m_OriginalSeq_feat;
  337. }
  340. inline
  341. const CMappedFeat* CFeat_CI::operator-> (void) const
  342. {
  343.     return &**this;
  344. }
  347. inline
  348. const CSeq_feat& CMappedFeat::GetOriginalFeature(void) const
  349. {
  350.     return m_OriginalSeq_feat? *m_OriginalSeq_feat: x_MakeOriginalFeature();
  351. }
  354. inline
  355. const CSeq_feat& CMappedFeat::GetMappedFeature(void) const
  356. {
  357.     return m_MappedSeq_feat? *m_MappedSeq_feat: x_MakeMappedFeature();
  358. }
  361. inline
  362. const CSeq_loc& CMappedFeat::GetMappedLocation(void) const
  363. {
  364.     return m_MappedSeq_loc? *m_MappedSeq_loc: x_MakeMappedLocation();
  365. }
  368. END_SCOPE(objects)
  369. END_NCBI_SCOPE
  371. /*
  372. * ---------------------------------------------------------------------------
  373. * $Log: feat_ci.hpp,v $
  374. * Revision 1000.3  2004/06/01 19:21:22  gouriano
  375. * PRODUCTION: UPGRADED [GCC34_MSVC7] Dev-tree R1.41
  376. *
  377. * Revision 1.41  2004/05/04 18:08:47  grichenk
  378. * Added CSeq_feat_Handle, CSeq_align_Handle and CSeq_graph_Handle
  379. *
  380. * Revision 1.40  2004/04/07 13:20:17  grichenk
  381. * Moved more data from iterators to CAnnot_Collector
  382. *
  383. * Revision 1.39  2004/04/05 15:56:13  grichenk
  384. * Redesigned CAnnotTypes_CI: moved all data and data collecting
  385. * functions to CAnnotDataCollector. CAnnotTypes_CI is no more
  386. * inherited from SAnnotSelector.
  387. *
  388. * Revision 1.38  2004/03/16 15:47:26  vasilche
  389. * Added CBioseq_set_Handle and set of EditHandles
  390. *
  391. * Revision 1.37  2004/02/04 18:05:32  grichenk
  392. * Added annotation filtering by set of types/subtypes.
  393. * Renamed *Choice to *Type in SAnnotSelector.
  394. *
  395. * Revision 1.36  2004/01/28 20:54:34  vasilche
  396. * Fixed mapping of annotations.
  397. *
  398. * Revision 1.35  2004/01/23 16:14:46  grichenk
  399. * Implemented alignment mapping
  400. *
  401. * Revision 1.34  2003/11/07 16:01:26  vasilche
  402. * Added CMappedFeat::GetSeq_annot().
  403. *
  404. * Revision 1.33  2003/08/27 14:28:50  vasilche
  405. * Reduce amount of object allocations in feature iteration.
  406. *
  407. * Revision 1.32  2003/08/15 19:19:15  vasilche
  408. * Fixed memory leak in string packing hooks.
  409. * Fixed processing of 'partial' flag of features.
  410. * Allow table packing of non-point SNP.
  411. * Allow table packing of SNP with long alleles.
  412. *
  413. * Revision 1.31  2003/08/15 15:22:41  grichenk
  414. * +CAnnot_CI
  415. *
  416. * Revision 1.30  2003/08/14 20:05:18  vasilche
  417. * Simple SNP features are stored as table internally.
  418. * They are recreated when needed using CFeat_CI.
  419. *
  420. * Revision 1.29  2003/08/04 17:02:57  grichenk
  421. * Added constructors to iterate all annotations from a
  422. * seq-entry or seq-annot.
  423. *
  424. * Revision 1.28  2003/07/22 21:48:02  vasilche
  425. * Use typedef for member access.
  426. *
  427. * Revision 1.27  2003/06/02 16:01:36  dicuccio
  428. * Rearranged include/objects/ subtree.  This includes the following shifts:
  429. *     - include/objects/alnmgr --> include/objtools/alnmgr
  430. *     - include/objects/cddalignview --> include/objtools/cddalignview
  431. *     - include/objects/flat --> include/objtools/flat
  432. *     - include/objects/objmgr/ --> include/objmgr/
  433. *     - include/objects/util/ --> include/objmgr/util/
  434. *     - include/objects/validator --> include/objtools/validator
  435. *
  436. * Revision 1.26  2003/04/24 16:12:37  vasilche
  437. * Object manager internal structures are splitted more straightforward.
  438. * Removed excessive header dependencies.
  439. *
  440. * Revision 1.25  2003/03/26 14:55:57  vasilche
  441. * Removed redundant 'const' from methods returning 'const bool'.
  442. *
  443. * Revision 1.24  2003/03/05 20:56:42  vasilche
  444. * SAnnotSelector now holds all parameters of annotation iterators.
  445. *
  446. * Revision 1.23  2003/02/25 14:24:19  dicuccio
  447. * Added Win32 export specifier to CMappedFeat
  448. *
  449. * Revision 1.22  2003/02/24 18:57:20  vasilche
  450. * Make feature gathering in one linear pass using CSeqMap iterator.
  451. * Do not use feture index by sub locations.
  452. * Sort features at the end of gathering in one vector.
  453. * Extracted some internal structures and classes in separate header.
  454. * Delay creation of mapped features.
  455. *
  456. * Revision 1.21  2003/02/13 14:57:36  dicuccio
  457. * Changed interface to match new 'dataool'-generated code (built-in types
  458. * returned by value, not reference).
  459. *
  460. * Revision 1.20  2003/02/13 14:34:31  grichenk
  461. * Renamed CAnnotObject -> CAnnotObject_Info
  462. * + CSeq_annot_Info and CAnnotObject_Ref
  463. * Moved some members of CAnnotObject to CSeq_annot_Info
  464. * and CAnnotObject_Ref.
  465. * Added feat/align/graph to CAnnotObject_Info map
  466. * to CDataSource.
  467. *
  468. * Revision 1.19  2003/02/10 22:03:55  grichenk
  469. * operator++(int) made private
  470. *
  471. * Revision 1.18  2003/02/10 15:50:44  grichenk
  472. * + CMappedFeat, CFeat_CI resolves to CMappedFeat
  473. *
  474. * Revision 1.17  2002/12/26 20:50:18  dicuccio
  475. * Added Win32 export specifier.  Removed unimplemented (private) operator++(int)
  476. *
  477. * Revision 1.16  2002/12/24 15:42:44  grichenk
  478. * CBioseqHandle argument to annotation iterators made const
  479. *
  480. * Revision 1.15  2002/12/20 20:54:23  grichenk
  481. * Added optional location/product switch to CFeat_CI
  482. *
  483. * Revision 1.14  2002/12/06 15:35:57  grichenk
  484. * Added overlap type for annot-iterators
  485. *
  486. * Revision 1.13  2002/12/05 19:28:30  grichenk
  487. * Prohibited postfix operator ++()
  488. *
  489. * Revision 1.12  2002/07/08 20:50:56  grichenk
  490. * Moved log to the end of file
  491. * Replaced static mutex (in CScope, CDataSource) with the mutex
  492. * pool. Redesigned CDataSource data locking.
  493. *
  494. * Revision 1.11  2002/05/06 03:30:35  vakatov
  495. * OM/OM1 renaming
  496. *
  497. * Revision 1.10  2002/05/03 21:28:01  ucko
  498. * Introduce T(Signed)SeqPos.
  499. *
  500. * Revision 1.9  2002/04/30 14:30:42  grichenk
  501. * Added eResolve_TSE flag in CAnnot_Types_CI, made it default
  502. *
  503. * Revision 1.8  2002/04/17 20:57:50  grichenk
  504. * Added full type for "resolve" argument
  505. *
  506. * Revision 1.7  2002/04/16 19:59:45  grichenk
  507. * Updated comments
  508. *
  509. * Revision 1.6  2002/04/05 21:26:16  grichenk
  510. * Enabled iteration over annotations defined on segments of a
  511. * delta-sequence.
  512. *
  513. * Revision 1.5  2002/03/05 16:08:12  grichenk
  514. * Moved TSE-restriction to new constructors
  515. *
  516. * Revision 1.4  2002/03/04 15:07:46  grichenk
  517. * Added "bioseq" argument to CAnnotTypes_CI constructor to iterate
  518. * annotations from a single TSE.
  519. *
  520. * Revision 1.3  2002/02/21 19:27:00  grichenk
  521. * Rearranged includes. Added scope history. Added searching for the
  522. * best seq-id match in data sources and scopes. Updated tests.
  523. *
  524. * Revision 1.2  2002/01/16 16:26:35  gouriano
  525. * restructured objmgr
  526. *
  527. * Revision 1.1  2002/01/11 19:04:02  gouriano
  528. * restructured objmgr
  529. *
  530. *
  531. * ===========================================================================
  532. */
  534. #endif  // FEAT_CI__HPP