FDO .NET API Reference Feature Data Objects

mgIGetSpatialContexts.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 public __gc __interface ISpatialContextReader;
00025 
00026 /// \ingroup (OSGeoFDOCommandsSpatialContext)
00027 /// \interface OSGeo::FDO::Commands::SpatialContext::IGetSpatialContexts
00028 /// \brief
00029 /// IGetSpatialContexts interface defines the GetSpatialContexts command,
00030 /// which enumerates the existing spatial contexts.
00031 public __gc __interface IGetSpatialContexts : public NAMESPACE_OSGEO_FDO_COMMANDS::ICommand
00032 {
00033 public:
00034     /// \brief
00035     ///  Gets a Boolean flag that indicates if the GetSpatialContexts command
00036     /// will return only the active spatial context or all spatial contexts. The
00037     /// default value of this flag is false, return all spatial contexts.
00038     /// 
00039     /// \return
00040     /// Returns Boolean value
00041     /// 
00042     __property System::Boolean get_ActiveOnly();
00043 
00044     /// \brief
00045     ///  Sets a Boolean flag that indicates if the GetSpatialContexts command
00046     /// will return only the active spatial context or all spatial contexts. The
00047     /// default value of this flag is false, return all spatial contexts.
00048     /// 
00049     /// \param value 
00050     /// Input the Boolean flag
00051     /// 
00052     /// \return
00053     /// Returns nothing
00054     /// 
00055     __property System::Void set_ActiveOnly(System::Boolean value);
00056 
00057     /// \brief
00058     /// Executes the GetSpatialContexts command returning an ISpatialContextReader.
00059     /// 
00060     /// \return
00061     /// Returns nothing
00062     /// 
00063     NAMESPACE_OSGEO_FDO_COMMANDS_SPATIALCONTEXT::ISpatialContextReader* Execute();
00064 };
00065 
00066 END_NAMESPACE_OSGEO_FDO_COMMANDS_SPATIALCONTEXT
00067 
00068 

Comments or suggestions? Send us feedback.