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 class FdoParameterValue; 00022 00023 BEGIN_NAMESPACE_OSGEO_FDO_EXPRESSION 00024 public __gc class LiteralValue; 00025 END_NAMESPACE_OSGEO_FDO_EXPRESSION 00026 00027 BEGIN_NAMESPACE_OSGEO_FDO_COMMANDS 00028 00029 /// \ingroup (OSGeoFDOCommands) 00030 /// \brief 00031 /// The ParameterValue class specifies a value for a particular parameter. 00032 /// Instances of this class are used to specify a value to bind to a parameter 00033 /// when a command is executed. 00034 public __sealed __gc class ParameterValue : public NAMESPACE_OSGEO_RUNTIME::Disposable 00035 { 00036 public: 00037 /// \brief 00038 /// Constructs a default instance of an ParameterValue. 00039 /// 00040 ParameterValue(); 00041 00042 /// \brief 00043 /// Constructs an instance of an ParameterValue using the specified arguments. 00044 /// 00045 /// \param name 00046 /// Input the name of the parameter value 00047 /// 00048 ParameterValue(System::String* name); 00049 00050 /// \brief 00051 /// Constructs an instance of an ParameterValue using the specified arguments. 00052 /// 00053 /// \param name 00054 /// Input the name of the parameter value 00055 /// \param value 00056 /// Input the literal parameter value 00057 /// 00058 ParameterValue(System::String* name, NAMESPACE_OSGEO_FDO_EXPRESSION::LiteralValue* value); 00059 00060 /// \brief 00061 /// Gets the parameter name the value should bind to as a string. 00062 /// 00063 /// \return 00064 /// Returns the parameter name 00065 /// 00066 __property System::String* get_Name(); 00067 00068 /// \brief 00069 /// Sets the parameter name the value should bind to as a string. 00070 /// 00071 /// \param value 00072 /// Input the parameter name 00073 /// 00074 /// \return 00075 /// Returns nothing 00076 /// 00077 __property System::Void set_Name(System::String* value); 00078 00079 /// \brief 00080 /// Gets the value to bind to the parameter as an LiteralValue. 00081 /// 00082 /// \return 00083 /// Returns literal value 00084 /// 00085 __property NAMESPACE_OSGEO_FDO_EXPRESSION::LiteralValue* get_Value(); 00086 00087 /// \brief 00088 /// Sets the value to bind to the parameter as an LiteralValue. 00089 /// 00090 /// \param value 00091 /// Input the literal value 00092 /// 00093 /// \return 00094 /// Returns nothing 00095 /// 00096 __property System::Void set_Value(NAMESPACE_OSGEO_FDO_EXPRESSION::LiteralValue* value); 00097 00098 /// \brief 00099 /// Sets the value to bind to the parameter as a string. 00100 /// 00101 /// \param value 00102 /// Input the string value to bind to the parameter 00103 /// 00104 /// \return 00105 /// Returns nothing 00106 /// 00107 __property System::Void set_Value(System::String* value); 00108 00109 /// \cond DOXYGEN-IGNORE 00110 protected: 00111 System::Void ReleaseUnmanagedObject(); 00112 /// \endcond 00113 00114 public private: 00115 ParameterValue(System::IntPtr unmanaged, System::Boolean autoDelete) : NAMESPACE_OSGEO_RUNTIME::Disposable(unmanaged, autoDelete) 00116 { 00117 00118 } 00119 00120 inline FdoParameterValue* GetImpObj(); 00121 }; 00122 00123 END_NAMESPACE_OSGEO_FDO_COMMANDS 00124 00125
Comments or suggestions? Send us feedback. |