item.hpp

ncbi源码

/*
 * ===========================================================================
 * PRODUCTION $Log: item.hpp,v $
 * PRODUCTION Revision 1000.0  2004/04/14 19:20:37  gouriano
 * PRODUCTION PRODUCTION: IMPORTED [CATCHUP_003] Dev-tree R1.1
 * PRODUCTION
 * ===========================================================================
 */

#ifndef OBJTOOLS_FORMAT_ITEMS___ITEM__HPP
#define OBJTOOLS_FORMAT_ITEMS___ITEM__HPP

/*  $Id: item.hpp,v 1000.0 2004/04/14 19:20:37 gouriano Exp $
* ===========================================================================
*
*                            PUBLIC DOMAIN NOTICE
*               National Center for Biotechnology Information
*
*  This software/database is a "United States Government Work" under the
*  terms of the United States Copyright Act.  It was written as part of
*  the author's official duties as a United States Government employee and
*  thus cannot be copyrighted.  This software/database is freely available
*  to the public for use. The National Library of Medicine and the U.S.
*  Government have not placed any restriction on its use or reproduction.
*
*  Although all reasonable efforts have been taken to ensure the accuracy
*  and reliability of the software and data, the NLM and the U.S.
*  Government do not and cannot warrant the performance or results that
*  may be obtained by using this software or data. The NLM and the U.S.
*  Government disclaim all warranties, express or implied, including
*  warranties of performance, merchantability or fitness for any particular
*  purpose.
*
*  Please cite the author in any work or product based on this material.
*
* ===========================================================================
*
* Author:  Aaron Ucko, NCBI
*          Mati Shomrat
*
* File Description:
*   new (early 2003) flat-file generator -- base class for items
*   (which roughly correspond to blocks/paragraphs in the C version)
*
*/
#include <corelib/ncbistd.hpp>
#include <corelib/ncbiobj.hpp>
#include <serial/serialbase.hpp>


BEGIN_NCBI_SCOPE
BEGIN_SCOPE(objects)


class IFlatTextOStream;
class IFormatter;


class IFlatItem : public CObject
{
public:
    virtual void Format(IFormatter& formatter,
                        IFlatTextOStream& text_os) const = 0;

    // For editing, return the underlying serial object (if exists).
    virtual const CSerialObject* GetObject(void) const = 0;

    // returns true, if the formatter should skip this object
    virtual bool Skip(void) const = 0;

    virtual ~IFlatItem(void) {}
};


END_SCOPE(objects)
END_NCBI_SCOPE


/*
* ===========================================================================
*
* $Log: item.hpp,v $
* Revision 1000.0  2004/04/14 19:20:37  gouriano
* PRODUCTION: IMPORTED [CATCHUP_003] Dev-tree R1.1
*
* Revision 1.1  2003/12/17 19:48:07  shomrat
* Initial revision (adapted from flat lib)
*
*
* ===========================================================================
*/

#endif  /* OBJTOOLS_FORMAT_ITEMS___ITEM__HPP */