serializable.hpp

ncbi源码

/*
 * ===========================================================================
 * PRODUCTION $Log: serializable.hpp,v $
 * PRODUCTION Revision 1000.1  2004/04/12 17:15:47  gouriano
 * PRODUCTION PRODUCTION: UPGRADED [CATCHUP_003] Dev-tree R1.9
 * PRODUCTION
 * ===========================================================================
 */

#ifndef SERIALIZABLE__HPP
#define SERIALIZABLE__HPP

/*  $Id: serializable.hpp,v 1000.1 2004/04/12 17:15:47 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:  Michael Kholodov, Denis Vakatov
*
* File Description:
*   General serializable interface for different output formats
*/

#include <corelib/ncbistd.hpp>


/** @addtogroup SerialDef
 *
 * @{
 */


BEGIN_NCBI_SCOPE


class NCBI_XSERIAL_EXPORT CSerializable
{
public:
    enum EOutputType {
        eAsFasta, 
        eAsAsnText, 
        eAsAsnBinary, 
        eAsXML, 
        eAsString
    };

    class NCBI_XSERIAL_EXPORT CProxy {
    public:
        CProxy(const CSerializable& obj, EOutputType output_type)
            : m_Obj(obj), m_OutputType(output_type) { }

    private:
        const CSerializable& m_Obj;
        EOutputType          m_OutputType;
        friend NCBI_XSERIAL_EXPORT
        CNcbiOstream& operator << (CNcbiOstream& out, const CProxy& src);
    };

    CProxy Dump(EOutputType output_type) const;

protected:
    virtual void WriteAsFasta     (CNcbiOstream& out) const;
    virtual void WriteAsAsnText   (CNcbiOstream& out) const;
    virtual void WriteAsAsnBinary (CNcbiOstream& out) const;
    virtual void WriteAsXML       (CNcbiOstream& out) const;
    virtual void WriteAsString    (CNcbiOstream& out) const;

    friend NCBI_XSERIAL_EXPORT
    CNcbiOstream& operator << (CNcbiOstream& out, const CProxy& src);
};


inline
CSerializable::CProxy CSerializable::Dump(EOutputType output_type)
    const
{
    return CProxy(*this, output_type);
}


NCBI_XSERIAL_EXPORT
CNcbiOstream& operator << (CNcbiOstream& out,
                           const CSerializable::CProxy& src);


END_NCBI_SCOPE

#endif  /* SERIALIZABLE__HPP */


/* @} */


/* ---------------------------------------------------------------------------
* $Log: serializable.hpp,v $
* Revision 1000.1  2004/04/12 17:15:47  gouriano
* PRODUCTION: UPGRADED [CATCHUP_003] Dev-tree R1.9
*
* Revision 1.9  2004/01/20 15:11:19  dicuccio
* Oops, forgot one export specifier.  Fixed code formatting.
*
* Revision 1.8  2004/01/20 14:58:47  dicuccio
* FIxed use of export specifiers - located before return type of function
*
* Revision 1.7  2004/01/16 22:10:40  ucko
* Tweak to use a proxy class to avoid clashing with new support for
* feeding CSerialObject to streams.
*
* Revision 1.6  2003/04/15 16:18:53  siyan
* Added doxygen support
*
* Revision 1.5  2003/03/26 16:13:33  vasilche
* Removed TAB symbols. Some formatting.
*
* Revision 1.4  2002/12/23 18:38:51  dicuccio
* Added WIn32 export specifier: NCBI_XSERIAL_EXPORT.
* Moved all CVS logs to the end.
*
* Revision 1.3  2001/05/21 14:38:38  kholodov
* Added: method WriteAsString() for string representation of an object.
*
* Revision 1.2  2001/04/17 04:08:01  vakatov
* Redesigned from a pure interface (ISerializable) into a regular
* base class (CSerializable) to make its usage safer, more formal and
* less bulky.
*
* Revision 1.1  2001/04/12 17:01:04  kholodov
* General serializable interface for different output formats
*
* ===========================================================================
*/