FDO .NET API Reference Feature Data Objects

mgIDestroySpatialContext.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\mgICommand.h"
00022 
00023 BEGIN_NAMESPACE_OSGEO_FDO_COMMANDS_SPATIALCONTEXT
00024 
00025 /// \ingroup (OSGeoFDOCommandsSpatialContext)
00026 /// \interface OSGeo::FDO::Commands::SpatialContext::IDestroySpatialContext
00027 /// \brief
00028 /// The IDestroySpatialContext interface defines the DestroySpatialContext
00029 /// command, which destroys an existing spatial context. Input to the command is
00030 /// the name of the context to destroy. Destroying a spatial context destroys
00031 /// all data stored in that context.
00032 public __gc __interface IDestroySpatialContext : public NAMESPACE_OSGEO_FDO_COMMANDS::ICommand
00033 {
00034 public:
00035     /// \brief
00036     /// Gets the name of the context to destroy as a string.
00037     /// 
00038     /// \return
00039     /// Returns the name of the spatial context to be deleted
00040     /// 
00041     __property System::String* get_Name();
00042 
00043     /// \brief
00044     /// Sets the name of the context to destroy as a string.
00045     /// 
00046     /// \param value 
00047     /// Input the name of the spatial context to be deleted
00048     /// 
00049     /// \return
00050     /// Returns nothing
00051     /// 
00052     __property System::Void set_Name(System::String* value);
00053 
00054     /// \brief
00055     /// Executes the DestroySpatialContext command, removing all data stored
00056     /// in that context. An exception is thrown if the spatial context does not exist.
00057     /// 
00058     /// \return
00059     /// Returns nothing
00060     /// 
00061     System::Void Execute();
00062 };
00063 
00064 END_NAMESPACE_OSGEO_FDO_COMMANDS_SPATIALCONTEXT
00065 
00066 

Comments or suggestions? Send us feedback.