FDO API Reference | Feature Data Objects |
00001 #ifndef _IACTIVATESPATIALCONTEXT_H_ 00002 #define _IACTIVATESPATIALCONTEXT_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 FdoIActivateSpatialContext interface defines the ActivateSpatialContext 00032 /// command, which activates a specified spatial context. Input to the command 00033 /// is the name of the context to activate. 00034 class FdoIActivateSpatialContext : public FdoICommand 00035 { 00036 friend class FdoIConnection; 00037 00038 public: 00039 /// \brief 00040 /// Gets the name of the context to activate as a string. 00041 /// 00042 /// \return 00043 /// Returns the name of the spatial context 00044 /// 00045 FDO_API virtual FdoString* GetName() = 0; 00046 00047 /// \brief 00048 /// Sets the name of the context to activate as a string. 00049 /// 00050 /// \param value 00051 /// Input the name of the spatial context 00052 /// 00053 /// \return 00054 /// Returns nothing 00055 /// 00056 FDO_API virtual void SetName(FdoString* value) = 0; 00057 00058 /// \brief 00059 /// Executes the ActivateSpatialContext command. An exception is thrown 00060 /// if the spatial context does not exist. 00061 /// 00062 /// \return 00063 /// Returns nothing 00064 /// 00065 FDO_API virtual void Execute() = 0; 00066 }; 00067 #endif 00068 00069
Comments or suggestions? Send us feedback. |