FDO .NET API Reference Feature Data Objects

mgArgumentDefinition.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\Schema\mgDataType.h"
00022 #include "FDO\Schema\mgPropertyType.h"
00023 
00024 class FdoArgumentDefinition;
00025 
00026 using namespace NAMESPACE_OSGEO_FDO_SCHEMA;
00027 BEGIN_NAMESPACE_OSGEO_FDO_CONNECTIONS_CAPABILITIES
00028 
00029 /// \ingroup (OSGeoFDOConnectionsCapabilities)
00030 /// \brief
00031 /// The ArgumentDefinition class contains metadata that describes an argument to a function.
00032 public __gc class ArgumentDefinition : public NAMESPACE_OSGEO_RUNTIME::Disposable
00033 {
00034 public:
00035     /// \brief
00036     /// Constructs an instance of an ArgumentDefinition using the specified arguments.
00037     /// 
00038     /// \param name 
00039     /// Input the name of the argument.
00040     /// \param description 
00041     /// Input a brief description of the argument.
00042     /// \param dataType 
00043     /// Input the type of argument.
00044     /// 
00045     /// \return
00046     /// Returns ArgumentDefinition
00047     /// 
00048     ArgumentDefinition(System::String* name, System::String* description, NAMESPACE_OSGEO_FDO_SCHEMA::DataType dataType);
00049 
00050     /// \brief
00051     /// Gets the name of the argument.
00052     /// 
00053     /// \return
00054     /// Returns the argument name
00055     /// 
00056     __property System::String* get_Name();
00057 
00058     /// \brief
00059     /// Gets a brief description of the argument.
00060     /// 
00061     /// \return
00062     /// Returns the argument description
00063     /// 
00064     __property System::String* get_Description();
00065 
00066     /// \brief
00067     /// Gets the PropertyType of the argument.
00068     /// 
00069     /// \return
00070     /// Returns the property type of the argument
00071     /// 
00072     __property NAMESPACE_OSGEO_FDO_SCHEMA::PropertyType get_PropertyType();
00073 
00074     /// \brief
00075     /// Gets the DataType of the argument.
00076     /// 
00077     /// \return
00078     /// Returns the data type of the argument
00079     /// 
00080     __property NAMESPACE_OSGEO_FDO_SCHEMA::DataType get_DataType();
00081 
00082 /// \cond DOXYGEN-IGNORE
00083 protected:
00084     System::Void ReleaseUnmanagedObject();
00085 /// \endcond
00086 
00087 public private:
00088     ArgumentDefinition(System::IntPtr unmanaged, System::Boolean autoDelete);
00089 
00090     inline FdoArgumentDefinition* GetImpObj();
00091 };
00092 
00093 END_NAMESPACE_OSGEO_FDO_CONNECTIONS_CAPABILITIES
00094 
00095 

Comments or suggestions? Send us feedback.