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

生物技术

开发平台:

C/C++

  1. /*
  2.  * ===========================================================================
  3.  * PRODUCTION $Log: item_base.hpp,v $
  4.  * PRODUCTION Revision 1000.1  2004/06/01 19:39:44  gouriano
  5.  * PRODUCTION PRODUCTION: UPGRADED [GCC34_MSVC7] Dev-tree R1.5
  6.  * PRODUCTION
  7.  * ===========================================================================
  8.  */
  9. #ifndef OBJTOOLS_FORMAT_ITEMS___ITEM_BASE_ITEM__HPP
  10. #define OBJTOOLS_FORMAT_ITEMS___ITEM_BASE_ITEM__HPP
  11. /*  $Id: item_base.hpp,v 1000.1 2004/06/01 19:39:44 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. *          Mati Shomrat
  38. *
  39. * File Description:
  40. *   Base class for the various item objects
  41. *
  42. */
  43. #include <corelib/ncbistd.hpp>
  44. #include <serial/serialbase.hpp>
  45. #include <objtools/format/items/item.hpp>
  46. //#include <objtools/format/context.hpp>
  47. BEGIN_NCBI_SCOPE
  48. BEGIN_SCOPE(objects)
  49. class CBioseqContext;
  50. class CFlatItem : public IFlatItem
  51. {
  52. public:
  53.     virtual void Format(IFormatter& formatter,
  54.                         IFlatTextOStream& text_os) const = 0;
  55.     bool IsSetObject(void) const;
  56.     const CSerialObject* GetObject(void) const;
  57.     CBioseqContext* GetContext(void);
  58.     CBioseqContext* GetContext(void) const;
  59.     // should this item be skipped during formatting?
  60.     bool Skip(void) const;
  61.     ~CFlatItem(void);
  62. protected:
  63.     CFlatItem(CBioseqContext* ctx = 0);
  64.     virtual void x_GatherInfo(CBioseqContext&) {}
  65.     void x_SetObject(const CSerialObject& obj);
  66.     void x_SetContext(CBioseqContext& ctx);
  67.     void x_SetSkip(void);
  68. private:
  69.     // The underlying CSerialObject from the information is obtained.
  70.     CConstRef<CSerialObject>    m_Object;
  71.     // a context associated with this item
  72.     CBioseqContext*             m_Context;
  73.     // should this item be skipped?
  74.     bool                        m_Skip;
  75. };
  76. ///////////////////////////////////////////////////////////
  77. ///////////////////// inline methods //////////////////////
  78. ///////////////////////////////////////////////////////////
  79. // public methods
  80. inline
  81. const CSerialObject* CFlatItem::GetObject(void) const
  82. {
  83.     return m_Object;
  84. }
  85. inline
  86. bool CFlatItem::IsSetObject(void) const
  87. {
  88.     return m_Object; 
  89. }
  90. inline
  91. CBioseqContext* CFlatItem::GetContext(void)
  92. {
  93.     return m_Context;
  94. }
  95. inline
  96. CBioseqContext* CFlatItem::GetContext(void) const
  97. {
  98.     return m_Context;
  99. }
  100. inline
  101. bool CFlatItem::Skip(void) const
  102. {
  103.     return m_Skip;
  104. }
  105. inline
  106. CFlatItem::~CFlatItem(void)
  107. {
  108. }
  109. // protected methods:
  110. // constructor
  111. inline
  112. CFlatItem::CFlatItem(CBioseqContext* ctx) :
  113.     m_Object(0),
  114.     m_Context(ctx),
  115.     m_Skip(false)
  116. {
  117. }
  118. // Shared utility functions
  119. inline
  120. void CFlatItem::x_SetObject(const CSerialObject& obj) 
  121. {
  122.     m_Object.Reset(&obj);
  123. }
  124. inline
  125. void CFlatItem::x_SetSkip(void)
  126. {
  127.     m_Skip = true;
  128.     m_Object.Reset();
  129.     m_Context = 0;
  130. }
  131. ///////////////////////////////////////////////////////////
  132. ////////////////// end of inline methods //////////////////
  133. ///////////////////////////////////////////////////////////
  134. END_SCOPE(objects)
  135. END_NCBI_SCOPE
  136. /*
  137. * ===========================================================================
  138. *
  139. * $Log: item_base.hpp,v $
  140. * Revision 1000.1  2004/06/01 19:39:44  gouriano
  141. * PRODUCTION: UPGRADED [GCC34_MSVC7] Dev-tree R1.5
  142. *
  143. * Revision 1.5  2004/04/22 15:37:04  shomrat
  144. * Changes in context
  145. *
  146. * Revision 1.4  2004/02/12 20:21:00  shomrat
  147. * using pointer instead of CRef
  148. *
  149. * Revision 1.3  2004/02/11 16:34:43  shomrat
  150. * inlined implementation
  151. *
  152. * Revision 1.2  2003/12/18 17:42:18  shomrat
  153. * context.hpp moved
  154. *
  155. * Revision 1.1  2003/12/17 19:48:27  shomrat
  156. * Initial revision (adapted from flat lib)
  157. *
  158. *
  159. * ===========================================================================
  160. */
  161. #endif  /* OBJTOOLS_FORMAT_ITEMS___ITEM_BASE_ITEM__HPP */