FDO .NET API Reference Feature Data Objects

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

Comments or suggestions? Send us feedback.