| FDO API Reference | Feature Data Objects |
00001 #ifndef _IDESTROYSPATIALCONTEXT_H_ 00002 #define _IDESTROYSPATIALCONTEXT_H_ 00003 // 00004 00005 // 00006 // Copyright (C) 2004-2006 Autodesk, Inc. 00007 // 00008 // This library is free software; you can redistribute it and/or 00009 // modify it under the terms of version 2.1 of the GNU Lesser 00010 // General Public License as published by the Free Software Foundation. 00011 // 00012 // This library is distributed in the hope that it will be useful, 00013 // but WITHOUT ANY WARRANTY; without even the implied warranty of 00014 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 00015 // Lesser General Public License for more details. 00016 // 00017 // You should have received a copy of the GNU Lesser General Public 00018 // License along with this library; if not, write to the Free Software 00019 // Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA 00020 // 00021 00022 #ifdef _WIN32 00023 #pragma once 00024 #endif 00025 00026 #include <FdoStd.h> 00027 #include <Fdo/Connections/IConnection.h> 00028 #include <Fdo/Commands/ICommand.h> 00029 00030 /// \brief 00031 /// The FdoIDestroySpatialContext 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 class FdoIDestroySpatialContext : public FdoICommand 00036 { 00037 friend class FdoIConnection; 00038 00039 public: 00040 /// \brief 00041 /// Gets the name of the context to destroy as a string. 00042 /// 00043 /// \return 00044 /// Returns the name of the spatial context to be deleted 00045 /// 00046 FDO_API virtual FdoString* GetName() = 0; 00047 00048 /// \brief 00049 /// Sets the name of the context to destroy as a string. 00050 /// 00051 /// \param value 00052 /// Input the name of the spatial context to be deleted 00053 /// 00054 /// \return 00055 /// Returns nothing 00056 /// 00057 FDO_API virtual void SetName(FdoString* value) = 0; 00058 00059 /// \brief 00060 /// Executes the DestroySpatialContext command, removing all data stored 00061 /// in that context. An exception is thrown if the spatial context does not exist. 00062 /// 00063 /// \return 00064 /// Returns nothing 00065 /// 00066 FDO_API virtual void Execute() = 0; 00067 }; 00068 #endif 00069 00070
| Comments or suggestions? Send us feedback. |