FDO .NET API Reference Feature Data Objects

mgSpatialCondition.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\Filter\mgGeometricCondition.h"
00022 #include "FDO\Filter\mgSpatialOperations.h"
00023 
00024 class FdoSpatialCondition;
00025 
00026 BEGIN_NAMESPACE_OSGEO_FDO_EXPRESSION
00027 public __gc class Expression;
00028 public __gc class Identifier;
00029 END_NAMESPACE_OSGEO_FDO_EXPRESSION
00030 
00031 BEGIN_NAMESPACE_OSGEO_FDO_FILTER
00032 public __gc __interface IFilterProcessor;
00033 
00034 /// \ingroup (OSGeoFDOFilter)
00035 /// \brief
00036 /// The SpatialCondition class derives from GeometricCondition and can be used
00037 /// to test whether the value of a geometric property (referenced using the name
00038 /// of the property) and another geometric value satisfy the spatial
00039 /// relationship implied by the operation. Some feature providers may only
00040 /// support literal geometric values; if so, the provider's capabilities 
00041 /// will indicate this limitation.
00042 public __gc class SpatialCondition : public NAMESPACE_OSGEO_FDO_FILTER::GeometricCondition
00043 {
00044 public:
00045     /// \brief
00046     /// Constructs a default instance of an SpatialCondition.
00047     /// 
00048     /// \return
00049     /// Returns SpatialCondition
00050     /// 
00051     SpatialCondition();
00052 
00053     /// \brief
00054     /// Constructs an instance of an SpatialCondition using the specified arguments.
00055     /// 
00056     /// \param propertyName 
00057     /// Input property name
00058     /// \param operation 
00059     /// Input spatial operation
00060     /// \param geometry 
00061     /// Input geometry
00062     /// 
00063     /// \return
00064     /// Returns SpatialCondition
00065     /// 
00066     SpatialCondition(System::String* propertyName, NAMESPACE_OSGEO_FDO_FILTER::SpatialOperations operation, NAMESPACE_OSGEO_FDO_EXPRESSION::Expression* geometry);
00067 
00068     /// \brief
00069     /// Constructs an instance of an SpatialCondition using the specified arguments.
00070     /// 
00071     /// \param propertyName 
00072     /// Input property name
00073     /// \param operation 
00074     /// Input spatial operation
00075     /// \param geometry 
00076     /// Input geometry
00077     /// 
00078     /// \return
00079     /// Returns SpatialCondition
00080     /// 
00081     SpatialCondition(NAMESPACE_OSGEO_FDO_EXPRESSION::Identifier* propertyName, NAMESPACE_OSGEO_FDO_FILTER::SpatialOperations operation,  NAMESPACE_OSGEO_FDO_EXPRESSION::Expression* geometry);
00082 
00083     /// \brief
00084     /// Gets the spatial operation to use.
00085     /// 
00086     /// \return
00087     /// Returns the spatial operation to use
00088     /// 
00089     __property NAMESPACE_OSGEO_FDO_FILTER::SpatialOperations get_Operation();
00090 
00091     /// \brief
00092     /// Sets the spatial operation to use.
00093     /// 
00094     /// \param value 
00095     /// Input the spatial operation to use
00096     /// 
00097     /// \return
00098     /// Returns nothing
00099     /// 
00100     __property System::Void set_Operation(NAMESPACE_OSGEO_FDO_FILTER::SpatialOperations value);
00101 
00102     /// \brief
00103     /// Gets the literal geometric value.
00104     /// 
00105     /// \return
00106     /// Returns the literal geometric valueg
00107     /// 
00108     __property NAMESPACE_OSGEO_FDO_EXPRESSION::Expression* get_Geometry();
00109 
00110     /// \brief
00111     /// Sets the literal geometric value.
00112     /// 
00113     /// \param value 
00114     /// Input the literal geometric value
00115     /// 
00116     /// \return
00117     /// Returns nothing
00118     /// 
00119     __property System::Void set_Geometry(NAMESPACE_OSGEO_FDO_EXPRESSION::Expression* value);
00120 
00121     /// \brief
00122     /// Overrides Filter.Process to pass SpatialCondition to the
00123     /// appropriate filter processor operation.
00124     /// 
00125     /// \param processor 
00126     /// Input filter processor
00127     /// 
00128     /// \return
00129     /// Returns nothing
00130     /// 
00131     System::Void Process(NAMESPACE_OSGEO_FDO_FILTER::IFilterProcessor* processor);
00132 
00133     /// \brief
00134     /// Constructs a SpatialCondition object based on an unmanaged instance of the object
00135     /// 
00136     /// \param unmanaged 
00137     /// Input A Pointer to the unmanaged object.
00138     /// 
00139     /// \param autoDelete 
00140     /// Input Indicates if the constructed object should be automatically deleted 
00141     /// once it no longer referenced.
00142     /// 
00143     SpatialCondition(System::IntPtr unmanaged, System::Boolean autoDelete);
00144 
00145 public private:
00146     inline FdoSpatialCondition* GetImpObj();
00147 };
00148 
00149 END_NAMESPACE_OSGEO_FDO_FILTER
00150 
00151 

Comments or suggestions? Send us feedback.