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

生物技术

开发平台:

C/C++

  1. /*
  2.  * ===========================================================================
  3.  * PRODUCTION $Log: flat_file_generator.hpp,v $
  4.  * PRODUCTION Revision 1000.1  2004/06/01 19:38:34  gouriano
  5.  * PRODUCTION PRODUCTION: UPGRADED [GCC34_MSVC7] Dev-tree R1.9
  6.  * PRODUCTION
  7.  * ===========================================================================
  8.  */
  9. #ifndef OBJTOOLS_FORMAT___FLAT_FILE_GENERATOR__HPP
  10. #define OBJTOOLS_FORMAT___FLAT_FILE_GENERATOR__HPP
  11. /*  $Id: flat_file_generator.hpp,v 1000.1 2004/06/01 19:38:34 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:  Mati Shomrat
  37. *
  38. * File Description:
  39. *   User interface for generating flat file reports from ASN.1
  40. *   
  41. */
  42. #include <corelib/ncbistd.hpp>
  43. #include <corelib/ncbiobj.hpp>
  44. #include <objtools/format/flat_file_config.hpp>
  45. #include <objtools/format/context.hpp>
  46. BEGIN_NCBI_SCOPE
  47. BEGIN_SCOPE(objects)
  48. class IFlatTextOStream;
  49. class CFlatItemOStream;
  50. class CSeq_submit;
  51. class CSeq_entry;
  52. class CSeq_loc;
  53. class CSeq_entry_Handle;
  54. class CSeq_id;
  55. class NCBI_FORMAT_EXPORT CFlatFileGenerator : public CObject
  56. {
  57. public:
  58.     // types
  59.     typedef CRange<TSeqPos> TRange;
  60.     // constructors
  61.     CFlatFileGenerator(const CFlatFileConfig& cfg);
  62.     CFlatFileGenerator(
  63.         CFlatFileConfig::TFormat   format = CFlatFileConfig::eFormat_GenBank,
  64.         CFlatFileConfig::TMode     mode   = CFlatFileConfig::eMode_GBench,
  65.         CFlatFileConfig::TStyle    style  = CFlatFileConfig::eStyle_Normal,
  66.         CFlatFileConfig::TFlags    flags  = 0,
  67.         CFlatFileConfig::TView     view   = CFlatFileConfig::fViewNucleotides);
  68.     
  69.     // destructor
  70.     ~CFlatFileGenerator(void);
  71.     // Supply an annotation selector to be used in feature gathering.
  72.     SAnnotSelector& SetAnnotSelector(void);
  73.     void Generate(const CSeq_submit& submit, CScope& scope, CNcbiOstream& os);
  74.     void Generate(const CSeq_loc& loc, CScope& scope, CNcbiOstream& os);
  75.     void Generate(const CSeq_entry_Handle& entry, CNcbiOstream& os);
  76.     void Generate(const CSeq_id& id, const TRange& range, 
  77.         ENa_strand strand, CScope& scope, CNcbiOstream& os);
  78.     // NB: the item ostream should be allocated on the heap!
  79.     void Generate(const CSeq_entry_Handle& entry, CFlatItemOStream& item_os);
  80.     void Generate(const CSeq_submit& submit, CScope& scope, CFlatItemOStream& item_os);
  81.     void Generate(const CSeq_loc& loc, CScope& scope, CFlatItemOStream& item_os);
  82.     void Generate(const CSeq_id& id, const TRange& range,
  83.         ENa_strand strand, CScope& scope, CFlatItemOStream& item_os);
  84.     void Reset(void);
  85. private:
  86.     CRef<CFlatFileContext>    m_Ctx;
  87.     // forbidden
  88.     CFlatFileGenerator(const CFlatFileGenerator&);
  89.     CFlatFileGenerator& operator=(const CFlatFileGenerator&);
  90. };
  91. END_SCOPE(objects)
  92. END_NCBI_SCOPE
  93. /*
  94. * ===========================================================================
  95. *
  96. * $Log: flat_file_generator.hpp,v $
  97. * Revision 1000.1  2004/06/01 19:38:34  gouriano
  98. * PRODUCTION: UPGRADED [GCC34_MSVC7] Dev-tree R1.9
  99. *
  100. * Revision 1.9  2004/05/19 14:46:24  shomrat
  101. * + Reset()
  102. *
  103. * Revision 1.8  2004/04/22 15:47:30  shomrat
  104. * API changes
  105. *
  106. * Revision 1.7  2004/03/31 17:13:38  shomrat
  107. * name changes
  108. *
  109. * Revision 1.6  2004/03/25 20:30:53  shomrat
  110. * Use Handles
  111. *
  112. * Revision 1.5  2004/02/11 22:46:01  shomrat
  113. * enumerations moved to flat_file_flags.hpp
  114. *
  115. * Revision 1.4  2004/02/11 16:40:33  shomrat
  116. * added HideCDDFeats flag
  117. *
  118. * Revision 1.3  2004/01/15 16:57:08  dicuccio
  119. * Added private unimplemented copy ctor to satisfy MSVC
  120. *
  121. * Revision 1.2  2004/01/14 15:52:40  shomrat
  122. * Added GFF format
  123. *
  124. * Revision 1.1  2003/12/17 19:51:49  shomrat
  125. * Initial revision (adapted from flat lib)
  126. *
  127. *
  128. * ===========================================================================
  129. */
  130. #endif  /* OBJTOOLS_FORMAT___FLAT_FILE_GENERATOR__HPP */