FDO .NET API Reference Feature Data Objects

mgComputedIdentifier.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\mgIdentifier.h"
00022 
00023 class FdoComputedIdentifier;
00024 
00025 BEGIN_NAMESPACE_OSGEO_FDO_EXPRESSION
00026 
00027 public __gc class Expression;
00028 public __gc __interface IExpressionProcessor;
00029 
00030 /// \ingroup (OSGeoFDOExpression)
00031 /// \brief
00032 /// The ComputedIdentifier class derives from Identifier and represents an expression
00033 /// with alias. The name or alias must be a simple name and should not be scoped or contain the
00034 /// the schema name. The ComputedIdentifier can be used to provide an alias to an expression. 
00035 /// 
00036 public __gc class ComputedIdentifier : public NAMESPACE_OSGEO_FDO_EXPRESSION::Identifier
00037 {
00038 public:
00039     /// \brief
00040     /// Constructs a default instance of an identifier.
00041     /// 
00042     /// \return
00043     /// Returns the ComputedIdentifier
00044     /// 
00045     ComputedIdentifier();
00046 
00047     /// \brief
00048     /// Constructs an instance of an identifier using the specified arguments.
00049     /// 
00050     /// \param name 
00051     /// Input the computed identifier name
00052     /// \param expression 
00053     /// Input  expression
00054     /// 
00055     /// \return
00056     /// Returns the ComputedIdentifier
00057     /// 
00058     ComputedIdentifier(System::String* name, NAMESPACE_OSGEO_FDO_EXPRESSION::Expression* expression);
00059 
00060     /// \brief
00061     /// Gets the full text of the identifier.
00062     /// 
00063     /// \return
00064     /// Returns the identifier text
00065     /// 
00066     __property NAMESPACE_OSGEO_FDO_EXPRESSION::Expression* get_Expression();
00067 
00068     /// \brief
00069     /// Sets the full text of the identifier.
00070     /// 
00071     /// \param value 
00072     /// Input identifier text
00073     /// 
00074     /// \return
00075     /// Returns nothing
00076     /// 
00077     System::Void set_Expression(NAMESPACE_OSGEO_FDO_EXPRESSION::Expression* value);
00078 
00079     /// \brief
00080     /// Overrides Expression.Process to pass the ComputedIdentifier to the appropriate
00081     /// expression processor operation.
00082     /// 
00083     /// \param processor 
00084     /// Input expression processor interface
00085     /// 
00086     /// \return
00087     /// Returns nothing
00088     /// 
00089     System::Void Process(NAMESPACE_OSGEO_FDO_EXPRESSION::IExpressionProcessor* processor);
00090 
00091     /// \brief
00092     /// Returns the well defined text representation of this expression.
00093     /// 
00094     /// \return
00095     /// Returns the well defined text string
00096     /// 
00097     System::String* ToString();
00098 
00099     /// \brief
00100     /// Constructs a ComputedIdentifier object based on an unmanaged instance of the object
00101     /// 
00102     /// \param unmanaged 
00103     /// Input A Pointer to the unmanaged object.
00104     /// 
00105     /// \param autoDelete 
00106     /// Input Indicates if the constructed object should be automatically deleted 
00107     /// once it no longer referenced.
00108     /// 
00109     ComputedIdentifier(System::IntPtr unmanaged, System::Boolean autoDelete);
00110 
00111 public private:
00112     inline FdoComputedIdentifier* GetImpObj();
00113 };
00114 END_NAMESPACE_OSGEO_FDO_EXPRESSION
00115 
00116 

Comments or suggestions? Send us feedback.