FDO .NET API Reference | Feature Data Objects |
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\SpatialContext\mgSpatialContextExtentType.h" 00022 00023 BEGIN_NAMESPACE_OSGEO_FDO_COMMANDS_SPATIALCONTEXT 00024 00025 /// \ingroup (OSGeoFDOCommandsSpatialContext) 00026 /// \interface OSGeo::FDO::Commands::SpatialContext::ISpatialContextReader 00027 /// \brief 00028 /// ISpatialContextReader interface provides forward-only, read-only 00029 /// functionality for enumerating spatial contexts. A reference to an 00030 /// ISpatialContextReader is returned from the GetSpatialContexts command. 00031 /// The initial position of the ISpatialContextReader interface is prior to the 00032 /// first item. Thus, you must call ReadNext to begin accessing any data. 00033 public __gc __interface ISpatialContextReader : public System::IDisposable 00034 { 00035 public: 00036 /// \brief 00037 /// Gets the name of the spatial context currently being read. 00038 /// 00039 /// \return 00040 /// Returns the name of the spatial context. 00041 /// 00042 System::String* GetName(); 00043 00044 /// \brief 00045 /// Gets the description of the spatial context currently being read. 00046 /// 00047 /// \return 00048 /// Returns the description of the spatial context. 00049 /// 00050 System::String* GetDescription(); 00051 00052 /// \brief 00053 /// Gets the name of the coordinate system of the spatial context currently 00054 /// being read. If the result is a null or empty string, the coordinate system is 00055 /// unknown to the spatial context. 00056 /// 00057 /// \return 00058 /// Returns the coordinate system name of the spatial context. 00059 /// 00060 System::String* GetCoordinateSystem(); 00061 00062 /// \brief 00063 /// Gets the name of the coordinate system in OpenGIS SRS WKT format of the spatial context currently 00064 /// being read. If the result is an empty string, the coordinate system WKT description is 00065 /// not available. 00066 /// 00067 /// \return 00068 /// Returns the coordinate system description in WKT of of the spatial context. 00069 /// 00070 System::String* GetCoordinateSystemWkt(); 00071 00072 /// \brief 00073 /// Gets the extent type of the spatial context currently being read. 00074 /// 00075 /// \return 00076 /// Returns the extent type. 00077 /// 00078 NAMESPACE_OSGEO_FDO_COMMANDS_SPATIALCONTEXT::SpatialContextExtentType GetExtentType(); 00079 00080 /// \brief 00081 /// Gets the extent of the spatial context currently being read as a byte 00082 /// array in FGF format. 00083 /// 00084 /// \return 00085 /// Returns the extent as a byte array in FGF format. 00086 /// 00087 System::Byte GetExtent() []; 00088 00089 /// \brief 00090 /// Gets the tolerance value for XY ordinates of the spatial context 00091 /// currently being read. Tolerances are used in some geometric tests, 00092 /// mostly for equality between coordinates. This occurs frequently in spatial 00093 /// queries, especially with "on boundary" or "just touching" conditions. 00094 /// It is also an objective amount that can be used when formulating step 00095 /// distances for parametric curve interpolation. 00096 /// 00097 /// \return 00098 /// Returns the tolerance 00099 /// 00100 System::Double GetXYTolerance(); 00101 00102 /// \brief 00103 /// Gets the tolerance value for Z ordinates of the spatial context 00104 /// currently being read. Tolerances are used in some geometric tests, 00105 /// mostly for equality between coordinates. This occurs a frequently in spatial 00106 /// queries, especially with "on boundary" or "just touching" conditions. 00107 /// It is also an objective amount that can be used when formulating step 00108 /// distances for parametric curve interpolation. 00109 /// 00110 /// \return 00111 /// Returns the tolerance 00112 /// 00113 System::Double GetZTolerance(); 00114 00115 /// \brief 00116 /// Returns true if the spatial context currently being read is the active 00117 /// spatial context. 00118 /// 00119 /// \return 00120 /// Returns true if the current spatial context is the active one. 00121 /// 00122 System::Boolean IsActive(); 00123 00124 /// \brief 00125 /// Advances the reader to the next item. The default position of the reader 00126 /// is prior to the first item. Thus, you must call ReadNext to begin 00127 /// accessing any data. 00128 /// 00129 /// \return 00130 /// Returns true if there is a next item. 00131 /// 00132 System::Boolean ReadNext(); 00133 }; 00134 00135 END_NAMESPACE_OSGEO_FDO_COMMANDS_SPATIALCONTEXT 00136 00137
Comments or suggestions? Send us feedback. |