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

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

生物技术

开发平台：

C/C++

context.hpp：源码内容
  1. /*
  2.  * ===========================================================================
  3.  * PRODUCTION $Log: context.hpp,v $
  4.  * PRODUCTION Revision 1000.1  2004/06/01 19:38:24  gouriano
  5.  * PRODUCTION PRODUCTION: UPGRADED [GCC34_MSVC7] Dev-tree R1.18
  6.  * PRODUCTION
  7.  * ===========================================================================
  8.  */
  10. #ifndef OBJTOOLS_FORMAT___CONTEXT__HPP
  11. #define OBJTOOLS_FORMAT___CONTEXT__HPP
  13. /*  $Id: context.hpp,v 1000.1 2004/06/01 19:38:24 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:  Aaron Ucko, Mati Shomrat
  39. *
  40. * File Description:
  41. *   new (early 2003) flat-file generator -- context needed when (pre)formatting
  42. *
  43. */
  44. #include <corelib/ncbistd.hpp>
  45. #include <corelib/ncbiobj.hpp>
  47. #include <objects/seq/Bioseq.hpp>
  48. #include <objects/seq/Seq_inst.hpp>
  49. #include <objects/seq/MolInfo.hpp>
  50. #include <objects/seqloc/Seq_loc.hpp>
  51. #include <objects/seqloc/Seq_id.hpp>
  52. #include <objects/submit/Submit_block.hpp>
  53. #include <objmgr/bioseq_handle.hpp>
  54. #include <objmgr/seq_entry_handle.hpp>
  55. #include <objmgr/annot_selector.hpp>
  56. #include <objmgr/seq_loc_mapper.hpp>
  58. #include <util/range.hpp>
  60. #include <objtools/format/flat_file_config.hpp>
  61. #include <objtools/format/items/reference_item.hpp>
  63. #include <memory>
  65. BEGIN_NCBI_SCOPE
  66. BEGIN_SCOPE(objects)
  68. class CScope;
  69. class CMasterContext;
  70. class CFlatFileContext;
  73. /////////////////////////////////////////////////////////////////////////////
  74. //
  75. // CBioseqContext
  76. //
  77. // information on the bioseq being formatted
  79. class CBioseqContext : public CObject
  80. {
  81. public:
  82.     // types
  83.     typedef CRef<CReferenceItem>    TRef;
  84.     typedef vector<TRef>            TReferences;
  85.     typedef CRange<TSeqPos>         TRange;
  87.     // constructor
  88.     CBioseqContext(const CBioseq_Handle& seq, CFlatFileContext& ffctx,
  89.         CMasterContext* mctx = 0);
  90.     // destructor
  91.     ~CBioseqContext(void);
  93.     // Get the bioseq's handle
  94.     CBioseq_Handle& GetHandle(void) { return m_Handle; }
  95.     CScope& GetScope(void) { return m_Handle.GetScope(); }
  97.     // -- id information
  98.     CSeq_id* GetPrimaryId(void) { return m_PrimaryId; }
  99.     const CSeq_id& GetPreferredSynonym(const CSeq_id& id) const;
  100.     const string& GetAccession(void) const { return m_Accession; }
  101.     int  GetGI(void) const { return m_Gi; }
  102.     
  103.     // molecular type (nucleotide / protein)
  104.     bool IsProt(void) const { return m_IsProt;  }
  105.     bool IsNuc (void) const { return !m_IsProt; }
  107.     CSeq_inst::TRepr  GetRepr   (void) const { return m_Repr;    }
  108.     CSeq_inst::TMol   GetMol    (void) const { return m_Mol;     }
  109.     const CMolInfo*   GetMolinfo(void) const { return m_Molinfo; }
  110.     CMolInfo::TTech   GetTech   (void) const;
  111.     CMolInfo::TBiomol GetBiomol (void) const;
  112.     const CBioseq::TId& GetBioseqIds(void) const;
  114.     // segmented bioseq
  115.     bool IsSegmented(void) const { return m_Repr == CSeq_inst::eRepr_seg; }
  116.     bool HasParts(void) const { return m_HasParts; }
  117.     
  118.     // part of a segmented bioseq
  119.     bool IsPart(void) const { return m_IsPart; }
  120.     SIZE_TYPE GetPartNumber   (void) const { return m_PartNumber; }
  121.     SIZE_TYPE GetTotalNumParts(void) const;
  122.     CMasterContext& GetMaster (void) { return *m_Master; }
  123.     void SetMaster(CMasterContext& mctx);
  125.     // delta sequence
  126.     bool IsDelta(void) const { return m_Repr == CSeq_inst::eRepr_delta; }
  127.     bool IsDeltaLitOnly(void) const { return m_IsDeltaLitOnly; }
  129.     // Whole Genome Shotgun
  130.     bool IsWGS      (void) const { return m_IsWGS;       }
  131.     bool IsWGSMaster(void) const { return m_IsWGSMaster; }
  132.     const string& GetWGSMasterAccn(void) const { return m_WGSMasterAccn; }
  133.     const string& GetWGSMasterName(void) const { return m_WGSMasterName; }
  135.     TReferences& SetReferences(void) { return m_References; }
  136.     const TReferences& GetReferences(void) const { return m_References; }
  138.     // range on the bioseq to be formatted. the location is either
  139.     // whole or an interval (no complex locations allowed)
  140.     const CSeq_loc& GetLocation(void) const { return *m_Location; }
  141.     CSeq_loc_Mapper* GetMapper(void) { return m_Mapper; }
  143.     bool DoContigStyle(void) const;
  144.     bool ShowGBBSource(void) const { return m_ShowGBBSource; }
  146.     bool IsInGPS    (void) const { return m_IsInGPS;     }  // Is in a gene-prod set?
  147.     bool IsInNucProt(void) const { return m_IsInNucProt; }  // Is in a nuc-prot set?
  149.     // type of bioseq?
  150.     bool IsGED            (void) const { return m_IsGED;  }  // Genbank, EMBL or DDBJ
  151.     bool IsEMBL           (void) const { return m_IsEMBL; }  // EMBL
  152.     bool IsPDB            (void) const { return m_IsPDB;  }  // PDB
  153.     bool IsSP             (void) const { return m_IsSP;   }  // SwissProt
  154.     bool IsTPA            (void) const { return m_IsTPA;  }  // Third-Party Annotation
  155.     bool IsPatent         (void) const { return m_IsPatent; }
  156.     bool IsGbGenomeProject(void) const { return m_IsGbGenomeProject; } // AE
  157.     bool IsNcbiCONDiv     (void) const { return m_IsNcbiCONDiv; }      // CH
  158.     
  159.     // RefSeq ID queries
  160.     bool IsRefSeq(void) const { return m_IsRefSeq; }
  161.     bool IsRSCompleteGenomic  (void) const;  // NC_
  162.     bool IsRSIncompleteGenomic(void) const;  // NG_
  163.     bool IsRSMRna             (void) const;  // NM_
  164.     bool IsRSNonCodingRna     (void) const;  // NR_
  165.     bool IsRSProtein          (void) const;  // NP_
  166.     bool IsRSContig           (void) const;  // NT_
  167.     bool IsRSIntermedWGS      (void) const;  // NW_
  168.     bool IsRSPredictedMRna    (void) const;  // XM_
  169.     bool IsRSPredictedNCRna   (void) const;  // XR_
  170.     bool IsRSPredictedProtein (void) const;  // XP_
  171.     bool IsRSWGSNuc           (void) const;  // NZ_
  172.     bool IsRSWGSProt          (void) const;  // ZP_
  173.     
  174.     bool IsHup(void) const { return m_IsHup; }  // !!! should move to global?
  175.     // global data from CFlatFileContext
  176.     const CSubmit_block* GetSubmitBlock(void) const;
  177.     const CSeq_entry_Handle& GetEntry(void) const;
  178.     const CFlatFileConfig& Config(void) const;
  179.     const SAnnotSelector* GetAnnotSelector(void) const;
  180.     const CSeq_loc* GetMasterLocation(void) const;
  181.     bool IsGenbankFormat(void) const;
  183. private:
  184.     void x_Init(const CBioseq_Handle& seq, const CSeq_loc* user_loc);
  185.     void x_SetId(void);
  186.     bool x_HasParts(void) const;
  187.     bool x_IsDeltaLitOnly(void) const;
  188.     bool x_IsPart(void) const;
  189.     CBioseq_Handle x_GetMasterForPart(void) const;
  190.     SIZE_TYPE x_GetPartNumber(void);
  191.     bool x_IsInGPS(void) const;
  192.     bool x_IsInNucProt(void) const;
  193.     void x_SetLocation(const CSeq_loc* user_loc = 0);
  194.     
  195.     CSeq_inst::TRepr x_GetRepr(void) const;
  196.     const CMolInfo* x_GetMolInfo(void) const;
  198.     // data
  199.     CBioseq_Handle        m_Handle;
  200.     CRef<CSeq_id>         m_PrimaryId;
  201.     string                m_Accession;
  202.     string                m_WGSMasterAccn;
  203.     string                m_WGSMasterName;
  205.     CSeq_inst::TRepr      m_Repr;
  206.     CSeq_inst::TMol       m_Mol;
  207.     CConstRef<CMolInfo>   m_Molinfo; 
  209.     // segmented bioseq
  210.     bool        m_HasParts;
  211.     // part of a segmented bioseq
  212.     bool        m_IsPart;
  213.     SIZE_TYPE   m_PartNumber;
  214.     // delta bioseq
  215.     bool        m_IsDeltaLitOnly;
  217.     bool m_IsProt;      // Protein
  218.     bool m_IsInGPS;     // Gene-Prod Set
  219.     bool m_IsInNucProt; // Nuc-Prot Set
  220.     bool m_IsGED;       // Genbank, Embl or Ddbj
  221.     bool m_IsEMBL;      // EMBL
  222.     bool m_IsPDB;       // PDB
  223.     bool m_IsSP;        // SwissProt
  224.     bool m_IsTPA;       // Third Party Annotation
  225.     bool m_IsRefSeq;
  226.     unsigned int m_RefseqInfo;
  227.     bool m_IsGbGenomeProject;  // GenBank Genome project data
  228.     bool m_IsNcbiCONDiv;       // NCBI CON division
  229.     bool m_IsPatent;
  230.     bool m_IsGI;
  231.     bool m_IsWGS;
  232.     bool m_IsWGSMaster;
  233.     bool m_IsHup;
  234.     int  m_Gi;
  235.     bool m_ShowGBBSource;
  236.     
  237.     TReferences             m_References;
  238.     CConstRef<CSeq_loc>     m_Location;
  239.     CRef<CSeq_loc_Mapper>   m_Mapper;
  240.     CFlatFileContext&       m_FFCtx;
  241.     CRef<CMasterContext>    m_Master;
  242. };
  245. /////////////////////////////////////////////////////////////////////////////
  246. //
  247. // CMasterContext
  248. //
  249. // When formatting segmented bioseq CMasterContext holds information
  250. // on the Master bioseq.
  252. class CMasterContext : public CObject
  253. {
  254. public:
  255.     // constructor
  256.     CMasterContext(const CBioseq_Handle& master);
  257.     // destructor
  258.     ~CMasterContext(void);
  260.     // Get the segmented bioseq's handle
  261.     const CBioseq_Handle& GetHandle(void) const { return m_Handle;   }
  262.     // Get the number of parts
  263.     SIZE_TYPE GetNumParts          (void) const { return m_NumParts; }
  264.     // Get the base name
  265.     const string& GetBaseName      (void) const { return m_BaseName; }
  267.     // Find the serial number of a part in the segmented bioseq
  268.     SIZE_TYPE GetPartNumber(const CBioseq_Handle& part);
  270. private:
  271.     void x_SetBaseName(void);
  272.     void x_SetNumParts(void);
  274.     // data
  275.     CBioseq_Handle    m_Handle;
  276.     string            m_BaseName;
  277.     SIZE_TYPE         m_NumParts;
  278. };
  281. /////////////////////////////////////////////////////////////////////////////
  282. //
  283. // CFlatFileContext
  285. class CFlatFileContext : public CObject
  286. {
  287. public:
  288.     // types
  289.     typedef CRef<CBioseqContext>            TSection;
  290.     typedef vector< CRef<CBioseqContext> >  TSections;
  292.     // constructor
  293.     CFlatFileContext(const CFlatFileConfig& cfg) : m_Cfg(cfg) {}
  294.     // destructor
  295.     ~CFlatFileContext(void) {}
  297.     const CSeq_entry_Handle& GetEntry(void) const { return m_Entry;  }
  298.     void SetEntry(const CSeq_entry_Handle& entry) { m_Entry = entry; }
  300.     const CSubmit_block* GetSubmitBlock(void) const { return m_Submit; }
  301.     void SetSubmit(const CSubmit_block& sub) { m_Submit = &sub; }
  303.     const CFlatFileConfig& GetConfig(void) const { return m_Cfg; }
  305.     const SAnnotSelector* GetAnnotSelector(void) const;
  306.     SAnnotSelector& SetAnnotSelector(void);
  307.     void SetAnnotSelector(const SAnnotSelector&);
  309.     const CSeq_loc* GetLocation(void) const { return m_Loc; }
  310.     void SetLocation(const CSeq_loc* loc) { m_Loc.Reset(loc); }
  312.     void AddSection(TSection& section) { m_Sections.push_back(section); }
  314.     void Reset(void);
  316. private:
  318.     CFlatFileConfig             m_Cfg;
  319.     CSeq_entry_Handle           m_Entry;
  320.     TSections                   m_Sections;
  321.     CConstRef<CSubmit_block>    m_Submit;
  322.     auto_ptr<SAnnotSelector>    m_Selector;
  323.     CConstRef<CSeq_loc>         m_Loc;
  324. };
  327. /////////////////////////////////////////////////////////////////////////////
  328. // inline methods
  330. // -------- CBioseqContext
  332. inline
  333. const CBioseq::TId& CBioseqContext::GetBioseqIds(void) const
  334. {
  335.     return m_Handle.GetBioseqCore()->GetId();
  336. }
  338. inline
  339. SIZE_TYPE CBioseqContext::GetTotalNumParts(void) const
  340. {
  341.     return m_Master->GetNumParts();
  342. }
  344. inline
  345. void CBioseqContext::SetMaster(CMasterContext& mctx) {
  346.     m_Master.Reset(&mctx);
  347. }
  349. inline
  350. bool CBioseqContext::IsRSCompleteGenomic(void)  const
  351. {
  352.     return m_RefseqInfo == CSeq_id::eAcc_refseq_chromosome;  // NC_
  353. }
  355. inline
  356. bool CBioseqContext::IsRSIncompleteGenomic(void)  const
  357. {
  358.     return m_RefseqInfo == CSeq_id::eAcc_refseq_genomic;  // NG_
  359. }
  361. inline
  362. bool CBioseqContext::IsRSMRna(void)  const
  363. {
  364.     return m_RefseqInfo == CSeq_id::eAcc_refseq_mrna;  // NM_
  365. }
  367. inline
  368. bool CBioseqContext::IsRSNonCodingRna(void)  const
  369. {
  370.     return m_RefseqInfo == CSeq_id::eAcc_refseq_ncrna;  // NR_
  371. }
  373. inline
  374. bool CBioseqContext::IsRSProtein(void)  const
  375. {
  376.     return m_RefseqInfo == CSeq_id::eAcc_refseq_prot;  // NP_
  377. }
  379. inline
  380. bool CBioseqContext::IsRSContig(void)  const
  381. {
  382.     return m_RefseqInfo == CSeq_id::eAcc_refseq_contig;  // NT_
  383. }
  385. inline
  386. bool CBioseqContext::IsRSIntermedWGS(void)  const
  387. {
  388.     return m_RefseqInfo == CSeq_id::eAcc_refseq_wgs_intermed;  // NW_
  389. }
  391. inline
  392. bool CBioseqContext::IsRSPredictedMRna(void)  const
  393. {
  394.     return m_RefseqInfo == CSeq_id::eAcc_refseq_mrna_predicted;  // XM_
  395. }
  397. inline
  398. bool CBioseqContext::IsRSPredictedNCRna(void)  const
  399. {
  400.     return m_RefseqInfo == CSeq_id::eAcc_refseq_ncrna_predicted;  // XR_
  401. }
  403. inline
  404. bool CBioseqContext::IsRSPredictedProtein(void)  const
  405. {
  406.     return m_RefseqInfo == CSeq_id::eAcc_refseq_prot_predicted;  // XP_
  407. }
  409. inline
  410. bool CBioseqContext::IsRSWGSNuc(void)  const
  411. {
  412.     return m_RefseqInfo == CSeq_id::eAcc_refseq_wgs_nuc;  // NZ_
  413. }
  415. inline
  416. bool CBioseqContext::IsRSWGSProt(void)  const
  417. {
  418.     return m_RefseqInfo == CSeq_id::eAcc_refseq_wgs_prot;  // ZP_
  419. }
  421. inline
  422. const CFlatFileConfig& CBioseqContext::Config(void) const
  423. {
  424.     return m_FFCtx.GetConfig();
  425. }
  427. inline
  428. const CSubmit_block* CBioseqContext::GetSubmitBlock(void) const
  429. {
  430.     return m_FFCtx.GetSubmitBlock();
  431. }
  433. inline
  434. const CSeq_entry_Handle& CBioseqContext::GetEntry(void) const
  435. {
  436.     return m_FFCtx.GetEntry();
  437. }
  439. inline
  440. const SAnnotSelector* CBioseqContext::GetAnnotSelector(void) const
  441. {
  442.     return m_FFCtx.GetAnnotSelector();
  443. }
  445. inline
  446. const CSeq_loc* CBioseqContext::GetMasterLocation(void) const
  447. {
  448.     return m_FFCtx.GetLocation();
  449. }
  452. inline
  453. CMolInfo::TTech CBioseqContext::GetTech(void) const
  454. {
  455.     return m_Molinfo ? m_Molinfo->GetTech() : CMolInfo::eTech_unknown;
  456. }
  459. inline
  460. CMolInfo::TBiomol CBioseqContext::GetBiomol(void) const
  461. {
  462.     return m_Molinfo ? m_Molinfo->GetBiomol() : CMolInfo::eBiomol_unknown;
  463. }
  466. inline
  467. bool CBioseqContext::IsGenbankFormat(void) const
  468. {
  469.     return (Config().IsFormatGenbank()  ||
  470.             Config().IsFormatGBSeq()    ||
  471.             Config().IsFormatDDBJ());
  472. }
  475. // -------- CFlatFileContext
  477. inline
  478. const SAnnotSelector* CFlatFileContext::GetAnnotSelector(void) const
  479. {
  480.     return m_Selector.get();
  481. }
  483. inline
  484. SAnnotSelector& CFlatFileContext::SetAnnotSelector(void)
  485. {
  486.     if ( m_Selector.get() == 0 ) {
  487.         m_Selector.reset(new SAnnotSelector);
  488.     }
  490.     return *m_Selector;
  491. }
  494. inline
  495. void CFlatFileContext::SetAnnotSelector(const SAnnotSelector& sel)
  496. {
  497.     m_Selector.reset(new SAnnotSelector(sel));
  498. }
  501. inline
  502. void CFlatFileContext::Reset(void)
  503. {
  504.     m_Entry.Reset();
  505.     m_Sections.clear();
  506.     m_Submit.Reset();
  507.     m_Selector.reset();
  508.     m_Loc.Reset();
  509. }
  512. END_SCOPE(objects)
  513. END_NCBI_SCOPE
  515. /*
  516. * ===========================================================================
  517. *
  518. * $Log: context.hpp,v $
  519. * Revision 1000.1  2004/06/01 19:38:24  gouriano
  520. * PRODUCTION: UPGRADED [GCC34_MSVC7] Dev-tree R1.18
  521. *
  522. * Revision 1.18  2004/05/19 14:45:50  shomrat
  523. * + CFlatFileContext::Reset
  524. *
  525. * Revision 1.17  2004/05/06 17:44:28  shomrat
  526. * + IsEMBL and IsInNucProt
  527. *
  528. * Revision 1.16  2004/04/27 15:09:31  shomrat
  529. * + IsGenbankFormat
  530. *
  531. * Revision 1.15  2004/04/22 16:11:24  ucko
  532. * Move CBioseqContext::SetMaster's body to the end of the file, as some
  533. * compilers insist on seeing CMasterContext's full definition first.
  534. *
  535. * Revision 1.14  2004/04/22 15:41:38  shomrat
  536. * Refactoring of context
  537. *
  538. * Revision 1.13  2004/03/31 17:14:00  shomrat
  539. * name changes
  540. *
  541. * Revision 1.12  2004/03/25 20:28:55  shomrat
  542. * Use handle objects
  543. *
  544. * Revision 1.11  2004/03/18 15:29:38  shomrat
  545. * + flag ShowFtableRefs
  546. *
  547. * Revision 1.10  2004/03/16 19:07:48  vasilche
  548. * Include <memory> for auto_ptr<>.
  549. *
  550. * Revision 1.9  2004/03/16 15:40:21  vasilche
  551. * Added required include
  552. *
  553. * Revision 1.8  2004/03/12 16:55:10  shomrat
  554. * + ViewNuc(), ViewProt()
  555. *
  556. * Revision 1.7  2004/03/10 21:38:01  shomrat
  557. * Fixed usage of m_RefseqInfo
  558. *
  559. * Revision 1.6  2004/03/05 18:53:34  shomrat
  560. * added customization flags
  561. *
  562. * Revision 1.5  2004/02/19 17:56:21  shomrat
  563. * add flag for skipping gathering of source features
  564. *
  565. * Revision 1.4  2004/02/11 22:47:41  shomrat
  566. * using types in flag file
  567. *
  568. * Revision 1.3  2004/02/11 16:39:49  shomrat
  569. * added more user customization flags
  570. *
  571. * Revision 1.2  2004/01/14 15:50:17  shomrat
  572. * multiple changes (work in progress)
  573. *
  574. * Revision 1.1  2003/12/18 17:41:20  shomrat
  575. * file was moved from src directory
  576. *
  577. * Revision 1.1  2003/12/17 20:18:54  shomrat
  578. * Initial Revision (adapted from flat lib)
  579. *
  580. * ===========================================================================
  581. */
  583. #endif  /* OBJTOOLS_FORMAT___CONTEXT__HPP */