FDO .NET API Reference Feature Data Objects

mgXmlFeatureSerializer.h

Go to the documentation of this file.
00001 /*
00002 * Copyright (C) 2004-2006  Autodesk, Inc.
00003 * 
00004 * This library is free software; you can redistribute it and/or
00005 * modify it under the terms of version 2.1 of the GNU Lesser
00006 * General Public License as published by the Free Software Foundation.
00007 * 
00008 * This library is distributed in the hope that it will be useful,
00009 * but WITHOUT ANY WARRANTY; without even the implied warranty of
00010 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
00011 * Lesser General Public License for more details.
00012 * 
00013 * You should have received a copy of the GNU Lesser General Public
00014 * License along with this library; if not, write to the Free Software
00015 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
00016 *
00017 */
00018 
00019 #pragma  once
00020 
00021 #include "FDO\Commands\Feature\mgIFeatureReader.h"
00022 #include "FDO\Xml\mgXmlFeatureHandler.h"
00023 
00024 BEGIN_NAMESPACE_OSGEO_FDO_SCHEMA
00025 public __gc class FeatureSchemaCollection;
00026 END_NAMESPACE_OSGEO_FDO_SCHEMA
00027 
00028 BEGIN_NAMESPACE_OSGEO_FDO_CONNECTIONS
00029 public __gc __interface IConnection;
00030 END_NAMESPACE_OSGEO_FDO_CONNECTIONS
00031 
00032 BEGIN_NAMESPACE_OSGEO_FDO_COMMANDS_FEATURE
00033 public __gc __interface IFeatureReader;
00034 END_NAMESPACE_OSGEO_FDO_COMMANDS_FEATURE
00035 
00036 BEGIN_NAMESPACE_OSGEO_FDO_XML
00037 public __gc class XmlFeatureFlags;
00038 public __gc class XmlFeatureWriter;
00039 
00040 /// \ingroup (OSGeoFDOXml)
00041 /// \brief
00042 /// This static class provides the ability to serialize and deserialize features
00043 /// to and from GML.
00044 public __gc __sealed class XmlFeatureSerializer
00045 {
00046 public:
00047     /// \brief
00048     /// writes the features retrieved by a feature reader to 
00049     /// an XML document.
00050     /// 
00051     /// \param reader 
00052     /// Input the Feature Reader.
00053     /// \param writer 
00054     /// Input XML document writer. By default, the features written are wrapped in a 
00055     /// GML FeatureCollection element. This behaviour can be changed by setting 
00056     /// flags->writeCollection. The name of the collection element can also be 
00057     /// customized by setting flags->collectionUri and flags->collectionName.
00058     /// 
00059     static System::Void XmlSerialize(NAMESPACE_OSGEO_FDO_COMMANDS_FEATURE::IFeatureReader* reader, NAMESPACE_OSGEO_FDO_XML::XmlFeatureWriter* writer);
00060 
00061     /// \brief
00062     /// writes the features retrieved by a feature reader to 
00063     /// an XML document.
00064     /// 
00065     /// \param reader 
00066     /// Input the Feature Reader.
00067     /// \param writer 
00068     /// Input XML document writer. By default, the features written are wrapped in a 
00069     /// GML FeatureCollection element. This behaviour can be changed by setting 
00070     /// flags->writeCollection. The name of the collection element can also be 
00071     /// customized by setting flags->collectionUri and flags->collectionName.
00072     /// \param flags 
00073     /// Input options for controlling the serializing of the features. If NULL then the 
00074     /// flags passed to the document writer are used.
00075     /// 
00076     static System::Void XmlSerialize(NAMESPACE_OSGEO_FDO_COMMANDS_FEATURE::IFeatureReader* reader, NAMESPACE_OSGEO_FDO_XML::XmlFeatureWriter* writer, NAMESPACE_OSGEO_FDO_XML::XmlFeatureFlags* flags);
00077 
00078 private:
00079     XmlFeatureSerializer(){}
00080 };
00081 
00082 END_NAMESPACE_OSGEO_FDO_XML
00083 
00084 

Comments or suggestions? Send us feedback.