FDO API Reference Feature Data Objects

FeatureSerializer.h

Go to the documentation of this file.
00001 #ifndef FDO_XML_FEATURESERIALIZER_H_
00002 #define FDO_XML_FEATURESERIALIZER_H_
00003 
00004 //
00005 // Copyright (C) 2004-2006  Autodesk, Inc.
00006 // 
00007 // This library is free software; you can redistribute it and/or
00008 // modify it under the terms of version 2.1 of the GNU Lesser
00009 // General Public License as published by the Free Software Foundation.
00010 // 
00011 // This library is distributed in the hope that it will be useful,
00012 // but WITHOUT ANY WARRANTY; without even the implied warranty of
00013 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
00014 // Lesser General Public License for more details.
00015 // 
00016 // You should have received a copy of the GNU Lesser General Public
00017 // License along with this library; if not, write to the Free Software
00018 // Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
00019 //
00020 
00021 #ifdef _WIN32
00022 #pragma once
00023 #endif
00024 
00025 #include <FdoStd.h>
00026 
00027 class FdoXmlFeatureWriter;
00028 class FdoXmlFeatureFlags;
00029 
00030 /// \brief
00031 /// This static class provides the ability to serialize and deserialize features
00032 /// to and from GML.
00033 class FdoXmlFeatureSerializer
00034 {
00035 public:
00036 
00037     /// \brief
00038     /// writes the features retrieved by a feature reader to 
00039     /// an XML document.
00040     /// 
00041     /// \param reader 
00042     /// Input the Feature Reader.
00043     /// \param writer 
00044     /// Input XML document writer. By default, the features written are wrapped in a 
00045     /// GML FeatureCollection element. This behaviour can be changed by setting 
00046     /// flags->writeCollection. The name of the collection element can also be 
00047     /// customized by setting flags->collectionUri and flags->collectionName.
00048     /// \param flags 
00049     /// Input options for controlling the serializing of the features. If NULL then the 
00050     /// flags passed to the document writer are used.
00051     /// 
00052     FDO_API static void XmlSerialize( 
00053         FdoIFeatureReader*              reader, 
00054         FdoXmlFeatureWriter*            writer,
00055         FdoXmlFeatureFlags*             flags = NULL
00056     );
00057 
00058 };
00059 
00060 
00061 
00062 #endif
00063 
00064 

Comments or suggestions? Send us feedback.