FDO API Reference

Feature Data Objects

Serializable.h

Go to the documentation of this file.

#ifndef FDO_XML_SERIALIZABLE_H
#define FDO_XML_SERIALIZABLE_H

//
// Copyright (C) 2004-2006  Autodesk, Inc.
// 
// This library is free software; you can redistribute it and/or
// modify it under the terms of version 2.1 of the GNU Lesser
// General Public License as published by the Free Software Foundation.
// 
// This library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
// Lesser General Public License for more details.
// 
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
//

#include <FdoStd.h>
#include <Fdo/Xml/Flags.h>

/// \brief
/// FdoXmlSerializable provides the ability to serialize an FDO object 
/// to an XML Document. Serialization support can be added to any class by basing
/// it on FdoXmlSerializable and implementing the _writeXml callback.
class FdoXmlSerializable 
{
public:

    /// \brief
    /// Writes this object to a file. A complete XML document,
    /// containing this object, is written.
    /// 
    /// \param fileName 
    /// Input the file name.
    /// \param flags 
    /// Input controls the writing of the elements to the document.
    /// If NULL then the default flags are used (see FdoXmlFlags::Create())
    /// 
    FDO_API virtual void WriteXml(
        FdoString* fileName, 
        FdoXmlFlags* flags = NULL
    );

    /// \brief
    /// Writes to an XML writer. This object is appended to the XML document
    /// being written. Unlike the other WriteXml() functions it is not necessarily 
    /// the only object in its document.
    /// 
    /// \param xmlWriter 
    /// Input the XML writer. When this function completes, the
    /// XML writer's current position will be just after this object.
    /// \param flags 
    /// Input controls the writing of the elements to the writer.
    /// If NULL then the default flags are used (see FdoXmlFlags::Create())
    /// 
    FDO_API virtual void WriteXml(
        FdoXmlWriter* xmlWriter, 
        FdoXmlFlags* flags = NULL
    );

    /// \brief
    /// Writes to a text writer. A complete XML document,
    /// containing this object, is written.
    /// 
    /// \param textWriter 
    /// Input the text writer.When this function completes, the
    /// text writer's current position will be just after this object.
    /// \param flags 
    /// Input controls the writing of the elements to the writer.
    /// If NULL then the default flags are used (see FdoXmlFlags::Create())
    /// 
    FDO_API virtual void WriteXml(
        FdoIoTextWriter* textWriter, 
        FdoXmlFlags* flags = NULL
    );

    /// \brief
    /// Writes to a stream. A complete XML document,
    /// containing this object, is written.
    /// 
    /// \param stream 
    /// Input the stream. When this function completes, the
    /// stream's current position will be just after this object.
    /// \param flags 
    /// Input controls the writing of the elements to the stream.
    /// If NULL then the default flags are used (see FdoXmlFlags::Create())
    /// 
    FDO_API virtual void WriteXml(
        FdoIoStream* stream, 
        FdoXmlFlags* flags = NULL
    );

    /// \brief
    /// Gets the stylesheet for converting the XML document from 
    /// internal to external format. When classes derived from FdoXmlSerializable
    /// define an internal format, they must override this function to return a
    /// stylesheet that does the conversion.
    /// 
    /// \return
    /// Returns NULL by default (no internal format defined)
    /// 
    FDO_API virtual FdoXmlReader* GetFromInternalStylesheet();

protected:
    /// \brief
    /// Callback for writing to XML. Derived classes must implement this function
    /// to serialize the class into XML element(s). The class must be written as one 
    /// XML element (with 0 or more sub-elements).
    /// 
    /// \param xmlWriter 
    /// Input serialize to this XML writer. FdoXmlWriter provides
    /// functions for writing elements and attributes.
    /// \param flags 
    /// Input the XML flags that were passed to FdoXmlSerializable::WriteXml()
    /// 
    FDO_API virtual void _writeXml(
        FdoXmlWriter* xmlWriter, 
        const FdoXmlFlags* flags
    ) = 0;

};

#endif

---

Comments or suggestions? Send us feedback.