FDO .NET API Reference Feature Data Objects

mgIPhysicalPropertyMapping.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\Schema\mgIPhysicalElementMapping.h"
00022 
00023 BEGIN_NAMESPACE_OSGEO_COMMON_XML
00024 public __gc class XmlSaxContext;
00025 public __gc class XmlAttributeCollection;
00026 public __gc class XmlWriter;
00027 END_NAMESPACE_OSGEO_COMMON_XML
00028 
00029 BEGIN_NAMESPACE_OSGEO_FDO_XML
00030 public __gc class XmlFlags;
00031 END_NAMESPACE_OSGEO_FDO_XML
00032 
00033 BEGIN_NAMESPACE_OSGEO_FDO_COMMANDS_SCHEMA
00034 
00035 /// \ingroup (OSGeoFDOCommandsSchema)
00036 /// \interface OSGeo::FDO::Commands::Schema::IPhysicalPropertyMapping
00037 /// \brief
00038 /// IPhysicalPropertyMapping is an abstract interface that acts as a base interface for all 
00039 /// Physical Schema Mapping property overrides.
00040 public __gc __interface IPhysicalPropertyMapping : public NAMESPACE_OSGEO_FDO_COMMANDS_SCHEMA::IPhysicalElementMapping
00041 {
00042 public:
00043     /// \brief
00044     /// Initializes this Physical Property Mapping from its XML attributes. Called when
00045     /// this element is deserialized from XML. This function decodes any
00046     /// encoded property names (See _writeXml). Can be extended to handle 
00047     /// particular XML attributes for derived classes.
00048     /// 
00049     /// \param context 
00050     /// Input context contain information about the current deserialization operation
00051     /// \param attributes 
00052     /// Input the XML attributes.
00053     /// 
00054     /// \return
00055     /// Returns nothing
00056     /// 
00057     System::Void InitFromXml(NAMESPACE_OSGEO_COMMON_XML::XmlSaxContext* context, NAMESPACE_OSGEO_COMMON_XML::XmlAttributeCollection* attributes);
00058 
00059     /// \brief
00060     /// Writes this Physical Property Mapping to XML. Called when
00061     /// this element is serialized to XML. This function converts (encodes) 
00062     /// property names to be valid XML element names. Can be extended to handle 
00063     /// particular XML attributes and sub-elements for derived classes.
00064     /// <p><b>Note:</b> Schema Override elements that do not require name encoding
00065     /// should be based on PhysicalElementMapping instead of this class.
00066     /// 
00067     /// \param xmlWriter 
00068     /// Input write the element to this XML writer
00069     /// \param flags 
00070     /// Input flags that control the writing of the element.
00071     /// 
00072     /// \return
00073     /// Returns nothing
00074     /// 
00075     System::Void WriteXml(NAMESPACE_OSGEO_COMMON_XML::XmlWriter* xmlWriter, NAMESPACE_OSGEO_FDO_XML::XmlFlags* flags);
00076 };
00077 
00078 END_NAMESPACE_OSGEO_FDO_COMMANDS_SCHEMA
00079 
00080 

Comments or suggestions? Send us feedback.