flat_head.hpp
上传用户:yhdzpy8989
上传日期:2007-06-13
资源大小:13604k
文件大小:6k
源码类别:

生物技术

开发平台:

C/C++

  1. /*
  2.  * ===========================================================================
  3.  * PRODUCTION $Log: flat_head.hpp,v $
  4.  * PRODUCTION Revision 1000.0  2003/10/29 20:59:17  gouriano
  5.  * PRODUCTION PRODUCTION: IMPORTED [ORIGINAL] Dev-tree R1.4
  6.  * PRODUCTION
  7.  * ===========================================================================
  8.  */
  9. #ifndef OBJECTS_FLAT___FLAT_HEAD__HPP
  10. #define OBJECTS_FLAT___FLAT_HEAD__HPP
  11. /*  $Id: flat_head.hpp,v 1000.0 2003/10/29 20:59:17 gouriano Exp $
  12. * ===========================================================================
  13. *
  14. *                            PUBLIC DOMAIN NOTICE
  15. *               National Center for Biotechnology Information
  16. *
  17. *  This software/database is a "United States Government Work" under the
  18. *  terms of the United States Copyright Act.  It was written as part of
  19. *  the author's official duties as a United States Government employee and
  20. *  thus cannot be copyrighted.  This software/database is freely available
  21. *  to the public for use. The National Library of Medicine and the U.S.
  22. *  Government have not placed any restriction on its use or reproduction.
  23. *
  24. *  Although all reasonable efforts have been taken to ensure the accuracy
  25. *  and reliability of the software and data, the NLM and the U.S.
  26. *  Government do not and cannot warrant the performance or results that
  27. *  may be obtained by using this software or data. The NLM and the U.S.
  28. *  Government disclaim all warranties, express or implied, including
  29. *  warranties of performance, merchantability or fitness for any particular
  30. *  purpose.
  31. *
  32. *  Please cite the author in any work or product based on this material.
  33. *
  34. * ===========================================================================
  35. *
  36. * Author:  Aaron Ucko, NCBI
  37. *
  38. * File Description:
  39. *   New (early 2003) flat-file generator -- representation of "header"
  40. *   data, which translates into a format-dependent sequence of paragraphs.
  41. *
  42. */
  43. #include <objtools/flat/flat_formatter.hpp>
  44. #include <serial/enumvalues.hpp>
  45. #include <objects/seq/Bioseq.hpp>
  46. #include <objects/seq/Seqdesc.hpp>
  47. #include <objects/seqblock/EMBL_block.hpp>
  48. BEGIN_NCBI_SCOPE
  49. BEGIN_SCOPE(objects)
  50. // Ultimately split into several paragraphs in a format-dependent manner
  51. // (e.g., LOCUS, DEFINITION, ACCESSION, [PID,] VERSION, DBSOURCE for GenPept)
  52. class CFlatHead : public IFlatItem
  53. {
  54. public:
  55.     // also fills in some fields of ctx, which we don't bother duplicating
  56.     CFlatHead(CFlatContext& ctx);
  57.     void Format(IFlatFormatter& f) const { f.FormatHead(*this); }
  58.     typedef CEMBL_block::TDiv    TEMBLDiv;
  59.     typedef CSeq_inst::TStrand   TStrand;
  60.     typedef CSeq_inst::TTopology TTopology;
  61.     const string&       GetLocus       (void) const { return m_Locus;         }
  62.     TStrand             GetStrandedness(void) const { return m_Strandedness;  }
  63.     const char*         GetMolString   (void) const;
  64.     TTopology           GetTopology    (void) const { return m_Topology;      }
  65.     string              GetDivision    (void) const;
  66.     const CDate&        GetUpdateDate  (void) const { return *m_UpdateDate;   }
  67.     const CDate&        GetCreateDate  (void) const { return *m_CreateDate;   }
  68.     const string        GetDefinition  (void) const { return m_Definition;    }
  69.     const CBioseq::TId& GetOtherIDs    (void) const { return m_OtherIDs;      }
  70.     const list<string>& GetSecondaryIDs(void) const { return m_SecondaryIDs;  }
  71.     const list<string>& GetDBSource    (void) const { return m_DBSource;      }
  72.     const CSeqdesc*     GetProteinBlock(void) const { return m_ProteinBlock;  }
  73. private:
  74.     void x_AddDate(const CDate& date);
  75.     void x_AddDBSource(void);
  76.     // helpers for various components
  77.     string x_FormatDBSourceID(const CSeq_id& id);
  78.     void x_AddPIRBlock(void);
  79.     void x_AddSPBlock(void);
  80.     void x_AddPRFBlock(void);
  81.     void x_AddPDBBlock(void);
  82.     string              m_Locus;
  83.     TStrand             m_Strandedness;
  84.     TTopology           m_Topology;
  85.     const string*       m_GBDivision;
  86.     TEMBLDiv            m_EMBLDivision;
  87.     CConstRef<CDate>    m_UpdateDate;
  88.     CConstRef<CDate>    m_CreateDate;
  89.     string              m_Definition;
  90.     CBioseq::TId        m_OtherIDs; // current
  91.     list<string>        m_SecondaryIDs; // predecessors
  92.     list<string>        m_DBSource; // for proteins; relatively free-form
  93.     CConstRef<CSeqdesc> m_ProteinBlock;
  94.     CRef<CFlatContext>  m_Context;
  95. };
  96. inline
  97. string CFlatHead::GetDivision(void) const
  98. {
  99.     if (m_Context->GetFormatter().GetDatabase() == IFlatFormatter::eDB_EMBL) {
  100.         return CEMBL_block::GetTypeInfo_enum_EDiv()->FindName
  101.             (m_EMBLDivision, true);
  102.     } else if (m_GBDivision) {
  103.         return *m_GBDivision;
  104.     } else {
  105.         return "UNK";
  106.     }
  107. }
  108. END_SCOPE(objects)
  109. END_NCBI_SCOPE
  110. /*
  111. * ===========================================================================
  112. *
  113. * $Log: flat_head.hpp,v $
  114. * Revision 1000.0  2003/10/29 20:59:17  gouriano
  115. * PRODUCTION: IMPORTED [ORIGINAL] Dev-tree R1.4
  116. *
  117. * Revision 1.4  2003/06/02 16:01:39  dicuccio
  118. * Rearranged include/objects/ subtree.  This includes the following shifts:
  119. *     - include/objects/alnmgr --> include/objtools/alnmgr
  120. *     - include/objects/cddalignview --> include/objtools/cddalignview
  121. *     - include/objects/flat --> include/objtools/flat
  122. *     - include/objects/objmgr/ --> include/objmgr/
  123. *     - include/objects/util/ --> include/objmgr/util/
  124. *     - include/objects/validator --> include/objtools/validator
  125. *
  126. * Revision 1.3  2003/04/24 16:15:57  vasilche
  127. * Added missing includes and forward class declarations.
  128. *
  129. * Revision 1.2  2003/03/21 18:47:47  ucko
  130. * Turn most structs into (accessor-requiring) classes; replace some
  131. * formerly copied fields with pointers to the original data.
  132. *
  133. * Revision 1.1  2003/03/10 16:39:08  ucko
  134. * Initial check-in of new flat-file generator
  135. *
  136. *
  137. * ===========================================================================
  138. */
  139. #endif  /* OBJECTS_FLAT___FLAT_HEAD__HPP */