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

生物技术

开发平台:

C/C++

  1. /*
  2.  * ===========================================================================
  3.  * PRODUCTION $Log: flat_gbseq_formatter.hpp,v $
  4.  * PRODUCTION Revision 1000.0  2003/10/29 20:59:05  gouriano
  5.  * PRODUCTION PRODUCTION: IMPORTED [ORIGINAL] Dev-tree R1.5
  6.  * PRODUCTION
  7.  * ===========================================================================
  8.  */
  9. #ifndef OBJECTS_FLAT___FLAT_GBSEQ_FORMATTER__HPP
  10. #define OBJECTS_FLAT___FLAT_GBSEQ_FORMATTER__HPP
  11. /*  $Id: flat_gbseq_formatter.hpp,v 1000.0 2003/10/29 20:59:05 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 -- GBSeq output
  40. *
  41. */
  42. #include <objtools/flat/flat_formatter.hpp>
  43. #include <serial/objostr.hpp>
  44. #include <objects/gbseq/GBSeq.hpp>
  45. #include <objects/gbseq/GBSet.hpp>
  46. BEGIN_NCBI_SCOPE
  47. BEGIN_SCOPE(objects)
  48. class NCBI_FLAT_EXPORT CFlatGBSeqFormatter : public IFlatFormatter
  49. {
  50. public:
  51.     // populates a GBSet, but does not send it anywhere
  52.     CFlatGBSeqFormatter(CScope& scope, EMode mode,
  53.                         EStyle style = eStyle_Normal, TFlags flags = 0)
  54.         : IFlatFormatter(scope, mode, style, flags), m_Set(new CGBSet),
  55.           m_Out(0) { }
  56.     // for automatic seq-by-seq output
  57.     CFlatGBSeqFormatter(CObjectOStream& out, CScope& scope, EMode mode,
  58.                         EStyle style = eStyle_Normal, TFlags flags = 0);
  59.     ~CFlatGBSeqFormatter();
  60.     const CGBSet& GetGBSet(void) const { return *m_Set; }
  61. protected:
  62.     EDatabase GetDatabase(void) const { return eDB_NCBI; }
  63.     void BeginSequence   (CFlatContext& context);
  64.     void FormatHead      (const CFlatHead& head);
  65.     void FormatKeywords  (const CFlatKeywords& keys);
  66.     void FormatSegment   (const CFlatSegment& seg);
  67.     void FormatSource    (const CFlatSource& source);
  68.     void FormatReference (const CFlatReference& ref);
  69.     void FormatComment   (const CFlatComment& comment);
  70.     void FormatPrimary   (const CFlatPrimary& prim); // TPAs
  71.     void FormatFeatHeader(const CFlatFeatHeader& /* fh */) { }
  72.     void FormatFeature   (const IFlattishFeature& f);
  73.     void FormatDataHeader(const CFlatDataHeader& /* dh */) { }
  74.     void FormatData      (const CFlatData& data);
  75.     // alternatives to DataHeader + Data...
  76.     void FormatContig    (const CFlatContig& contig);
  77.     // no (current) representation for these two:
  78.     void FormatWGSRange  (const CFlatWGSRange& /* range */) { }
  79.     void FormatGenomeInfo(const CFlatGenomeInfo& /* g */) { } // NS_*
  80.     void EndSequence     (void);
  81. private:
  82.     CRef<CGBSet> m_Set;
  83.     CRef<CGBSeq> m_Seq;
  84.     CObjectOStream* m_Out;
  85. };
  86. END_SCOPE(objects)
  87. END_NCBI_SCOPE
  88. /*
  89. * ===========================================================================
  90. *
  91. * $Log: flat_gbseq_formatter.hpp,v $
  92. * Revision 1000.0  2003/10/29 20:59:05  gouriano
  93. * PRODUCTION: IMPORTED [ORIGINAL] Dev-tree R1.5
  94. *
  95. * Revision 1.5  2003/10/09 17:01:48  dicuccio
  96. * Added export specifiers
  97. *
  98. * Revision 1.4  2003/06/02 16:01:39  dicuccio
  99. * Rearranged include/objects/ subtree.  This includes the following shifts:
  100. *     - include/objects/alnmgr --> include/objtools/alnmgr
  101. *     - include/objects/cddalignview --> include/objtools/cddalignview
  102. *     - include/objects/flat --> include/objtools/flat
  103. *     - include/objects/objmgr/ --> include/objmgr/
  104. *     - include/objects/util/ --> include/objmgr/util/
  105. *     - include/objects/validator --> include/objtools/validator
  106. *
  107. * Revision 1.3  2003/04/10 20:08:22  ucko
  108. * Arrange to pass the item as an argument to IFlatTextOStream::AddParagraph
  109. *
  110. * Revision 1.2  2003/03/21 18:47:47  ucko
  111. * Turn most structs into (accessor-requiring) classes; replace some
  112. * formerly copied fields with pointers to the original data.
  113. *
  114. * Revision 1.1  2003/03/10 16:39:08  ucko
  115. * Initial check-in of new flat-file generator
  116. *
  117. *
  118. * ===========================================================================
  119. */
  120. #endif  /* OBJECTS_FLAT___FLAT_GBSEQ_FORMATTER__HPP */