| 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\Expression\mgValueExpression.h" 00022 00023 class FdoParameter; 00024 00025 BEGIN_NAMESPACE_OSGEO_FDO_EXPRESSION 00026 00027 public __gc __interface IExpressionProcessor; 00028 00029 /// \ingroup (OSGeoFDOExpression) 00030 /// \brief 00031 /// The Parameter class derives from ValueExpression and represents a 00032 /// substitution parameter in the expression. Parameters are represented by a 00033 /// name: when expressions are evaluated, the caller must supply a value to be 00034 /// bound to each parameter name. 00035 /// \remarks 00036 /// For information on how to set the value of a parameter, see the 00037 /// ICommand interface and ParameterValue. 00038 public __gc class Parameter : public NAMESPACE_OSGEO_FDO_EXPRESSION::ValueExpression 00039 { 00040 public: 00041 00042 /// \brief 00043 /// Constructs a default instance of a parameter. 00044 /// 00045 /// \return 00046 /// Returns Parameter 00047 /// 00048 Parameter(); 00049 00050 /// \brief 00051 /// Constructs an instance of a parameter using the specified arguments. 00052 /// 00053 /// \param name 00054 /// Input parameter name 00055 /// 00056 /// \return 00057 /// Returns Parameter 00058 /// 00059 Parameter(System::String* name); 00060 00061 /// \brief 00062 /// Gets the name of the parameter. 00063 /// 00064 /// \return 00065 /// Returns the parameter name 00066 /// 00067 __property System::String* get_Name(); 00068 00069 /// \brief 00070 /// Sets the name of the parameter. 00071 /// 00072 /// \param value 00073 /// Input parameter name 00074 /// 00075 /// \return 00076 /// Returns nothing 00077 /// 00078 __property System::Void set_Name(System::String* value); 00079 00080 /// \brief 00081 /// Overrides Expression.Process to pass the Parameter to the appropriate 00082 /// expression processor operation. 00083 /// 00084 /// \param processor 00085 /// Input an IExpressionProcessor 00086 /// 00087 /// \return 00088 /// Returns nothing 00089 /// 00090 System::Void Process(NAMESPACE_OSGEO_FDO_EXPRESSION::IExpressionProcessor* processor); 00091 00092 /// \brief 00093 /// Returns the well defined text representation of this expression. 00094 /// 00095 /// \return 00096 /// Returns the well defined text string 00097 /// 00098 System::String* ToString(); 00099 00100 /// \brief 00101 /// Constructs a Parameter object based on an unmanaged instance of the object 00102 /// 00103 /// \param unmanaged 00104 /// Input A Pointer to the unmanaged object. 00105 /// 00106 /// \param autoDelete 00107 /// Input Indicates if the constructed object should be automatically deleted 00108 /// once it no longer referenced. 00109 /// 00110 Parameter(System::IntPtr unmanaged, System::Boolean autoDelete); 00111 00112 public private: 00113 inline FdoParameter* GetImpObj(); 00114 }; 00115 00116 END_NAMESPACE_OSGEO_FDO_EXPRESSION 00117 00118
| Comments or suggestions? Send us feedback. |