FDO .NET API Reference Feature Data Objects

mgFunction.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\Expression\mgExpression.h"
00022 
00023 class FdoFunction;
00024 
00025 BEGIN_NAMESPACE_OSGEO_FDO_EXPRESSION
00026 
00027 public __gc class ExpressionCollection;
00028 public __gc __interface IExpressionProcessor;
00029 
00030 /// \ingroup (OSGeoFDOExpression)
00031 /// \brief
00032 /// The Function class derives from Expression and represents a function call. As
00033 /// such it defines the name of the function and the collection of arguments to
00034 /// be passed to it.
00035 public __gc class Function : public NAMESPACE_OSGEO_FDO_EXPRESSION::Expression
00036 {
00037 public:
00038     /// \brief
00039     /// Constructs a default instance of an Function.
00040     /// 
00041     /// \return
00042     /// Returns Function class
00043     /// 
00044     Function();
00045 
00046     /// \brief
00047     /// Constructs an instance of a function using the specified arguments.
00048     /// 
00049     /// \param name 
00050     /// Input name of the function
00051     /// \param arguments 
00052     /// Input pointer to arguments
00053     /// 
00054     /// \return
00055     /// Returns Function
00056     /// 
00057     Function(System::String* name, NAMESPACE_OSGEO_FDO_EXPRESSION::Expression* arguments []);
00058 
00059     /// \brief
00060     /// Constructs an instance of a function using the specified arguments.
00061     /// 
00062     /// \param name 
00063     /// Input name of the function
00064     /// \param arguments 
00065     /// Input arguments as collection
00066     /// 
00067     /// \return
00068     /// Returns Function
00069     /// 
00070     Function(System::String* name, NAMESPACE_OSGEO_FDO_EXPRESSION::ExpressionCollection* arguments);
00071 
00072     /// \brief
00073     /// Gets the name of the function.
00074     /// 
00075     /// \return
00076     /// Returns name of the function
00077     /// 
00078     __property System::String* get_Name();
00079 
00080     /// \brief
00081     /// Sets the name of the function.
00082     /// 
00083     /// \param value 
00084     /// Input name of the function
00085     /// 
00086     /// \return
00087     /// Returns nothing
00088     /// 
00089     __property System::Void set_Name(System::String* value);
00090 
00091     /// \brief
00092     /// Gets the ExpressionCollection that contains the arguments to the
00093     /// function.
00094     /// 
00095     /// \return
00096     /// Returns arguments as collection
00097     /// 
00098     __property NAMESPACE_OSGEO_FDO_EXPRESSION::ExpressionCollection* get_Arguments();
00099 
00100     /// \brief
00101     /// Overrides Expression.Process to pass the Function to the appropriate
00102     /// expression processor operation.
00103     /// 
00104     /// \param processor 
00105     /// Input expression processor
00106     /// 
00107     /// \return
00108     /// Returns nothing
00109     /// 
00110     System::Void Process(NAMESPACE_OSGEO_FDO_EXPRESSION::IExpressionProcessor* processor);
00111 
00112     /// \brief
00113     /// Returns the well defined text representation of this expression.
00114     /// 
00115     /// \return
00116     /// Returns the well defined text representation of this expression
00117     /// 
00118     System::String* ToString();
00119 
00120     /// \brief
00121     /// Constructs a Function object based on an unmanaged instance of the object
00122     /// 
00123     /// \param unmanaged 
00124     /// Input A Pointer to the unmanaged object.
00125     /// 
00126     /// \param autoDelete 
00127     /// Input Indicates if the constructed object should be automatically deleted 
00128     /// once it no longer referenced.
00129     /// 
00130     Function(System::IntPtr unmanaged, System::Boolean autoDelete);
00131 
00132 public private:
00133     inline FdoFunction* GetImpObj();
00134 };
00135 
00136 END_NAMESPACE_OSGEO_FDO_EXPRESSION
00137 
00138 

Comments or suggestions? Send us feedback.