| FDO API Reference | Feature Data Objects |
00001 #ifndef _IGETSPATIALCONTEXT_H_ 00002 #define _IGETSPATIALCONTEXT_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/SpatialContext/ISpatialContextReader.h> 00029 #include <Fdo/Commands/ICommand.h> 00030 00031 /// \brief 00032 /// The FdoIGetSpatialContexts interface defines the GetSpatialContexts command, 00033 /// which enumerates the existing spatial contexts. 00034 class FdoIGetSpatialContexts : public FdoICommand 00035 { 00036 friend class FdoIConnection; 00037 00038 public: 00039 /// \brief 00040 /// Gets a Boolean flag that indicates if the GetSpatialContexts command 00041 /// will return only the active spatial context or all spatial contexts. The 00042 /// default value of this flag is false, return all spatial contexts. 00043 /// 00044 /// \return 00045 /// Returns Boolean value 00046 /// 00047 FDO_API virtual const bool GetActiveOnly() = 0; 00048 00049 /// \brief 00050 /// Sets a Boolean flag that indicates if the GetSpatialContexts command 00051 /// will return only the active spatial context or all spatial contexts. The 00052 /// default value of this flag is false, return all spatial contexts. 00053 /// 00054 /// \param value 00055 /// Input the Boolean flag 00056 /// 00057 /// \return 00058 /// Returns nothing 00059 /// 00060 FDO_API virtual void SetActiveOnly(const bool value) = 0; 00061 00062 /// \brief 00063 /// Executes the GetSpatialContexts command returning an FdoISpatialContextReader. 00064 /// 00065 /// \return 00066 /// Returns nothing 00067 /// 00068 FDO_API virtual FdoISpatialContextReader* Execute() = 0; 00069 }; 00070 #endif 00071 00072
| Comments or suggestions? Send us feedback. |