FDO .NET API Reference Feature Data Objects

mgIDestroySpatialContextImp.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\mgICommandImp.h"
00022 #include "FDO\Commands\SpatialContext\mgIDestroySpatialContext.h"
00023 
00024 class FdoIDestroySpatialContext;
00025 
00026 BEGIN_NAMESPACE_OSGEO_FDO_COMMANDS_SPATIALCONTEXT
00027 
00028 /// \ingroup (OSGeoFDOCommandsSpatialContext)
00029 /// \brief
00030 /// The IDestroySpatialContextImp class is a concrete implementation of IDestroySpatialContext.
00031 /// The IDestroySpatialContext interface defines the DestroySpatialContext
00032 /// command, which destroys an existing spatial context. Input to the command is
00033 /// the name of the context to destroy. Destroying a spatial context destroys
00034 /// all data stored in that context.
00035 private __gc class IDestroySpatialContextImp : public NAMESPACE_OSGEO_FDO_COMMANDS::ICommandImp, 
00036                                                public NAMESPACE_OSGEO_FDO_COMMANDS_SPATIALCONTEXT::IDestroySpatialContext
00037 {
00038 public:
00039     /// \brief
00040     /// Gets the name of the context to destroy as a string.
00041     /// 
00042     /// \return
00043     /// Returns the name of the spatial context to be deleted
00044     /// 
00045     __property System::String* get_Name();
00046 
00047     /// \brief
00048     /// Sets the name of the context to destroy as a string.
00049     /// 
00050     /// \param value 
00051     /// Input the name of the spatial context to be deleted
00052     /// 
00053     /// \return
00054     /// Returns nothing
00055     /// 
00056     __property System::Void set_Name(System::String* value);
00057 
00058     /// \brief
00059     /// Executes the DestroySpatialContext command, removing all data stored
00060     /// in that context. An exception is thrown if the spatial context does not exist.
00061     /// 
00062     /// \return
00063     /// Returns nothing
00064     /// 
00065     System::Void Execute();
00066 
00067 public private:
00068     IDestroySpatialContextImp(System::IntPtr unmanaged, System::Boolean autoDelete) : NAMESPACE_OSGEO_FDO_COMMANDS::ICommandImp(unmanaged, autoDelete)
00069     {
00070 
00071     }
00072 
00073     inline FdoIDestroySpatialContext* GetImpObj();
00074 };
00075 
00076 END_NAMESPACE_OSGEO_FDO_COMMANDS_SPATIALCONTEXT
00077 
00078 

Comments or suggestions? Send us feedback.