FDO .NET API Reference Feature Data Objects

mgGeometryValue.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\mgLiteralValue.h"
00022 
00023 class FdoGeometryValue;
00024 
00025 BEGIN_NAMESPACE_OSGEO_FDO_EXPRESSION
00026 
00027 public __gc __interface IExpressionProcessor;
00028 
00029 /// \ingroup (OSGeoFDOExpression)
00030 /// \brief
00031 /// The GeometryValue class derives from LiteralValue and represents a geometric value.
00032 public __gc class GeometryValue : public NAMESPACE_OSGEO_FDO_EXPRESSION::LiteralValue
00033 {
00034 public:
00035 
00036     /// \brief
00037     /// Constructs a default instance of an GeometryValue with a value of null.
00038     /// 
00039     /// \return
00040     /// Returns GeometryValue
00041     /// 
00042     GeometryValue();
00043 
00044     /// \brief
00045     /// Constructs an instance of an GeometryValue using the specified arguments.
00046     /// 
00047     /// \param geometry 
00048     /// Input geometry byte array
00049     /// 
00050     /// \return
00051     /// Returns GeometryValue
00052     /// 
00053     GeometryValue(System::Byte geometry []);
00054 
00055     /// \brief
00056     /// Returns true if the GeometryValue represents a null value.
00057     /// 
00058     /// \return
00059     /// Returns true if null geometry
00060     /// 
00061     System::Boolean IsNull();
00062 
00063     /// \brief
00064     /// Gets the geometry as a byte array. The geometry is expected to be
00065     /// encoded in Autodesk Well-Known Binary format.
00066     /// 
00067     /// \return
00068     /// Returns geometry in FGF format
00069     /// 
00070     __property System::Byte get_Geometry() [];
00071 
00072     /// \brief
00073     /// Sets the geometry as a byte array. The geometry is expected to be
00074     /// encoded in Autodesk Well-Known Binary format.
00075     /// 
00076     /// \param value 
00077     /// Input geometry in FGF format
00078     /// 
00079     /// \return
00080     /// Returns nothing
00081     /// 
00082     __property System::Void set_Geometry(System::Byte value []);
00083 
00084     /// \brief
00085     /// Sets the GeometryValue to a null value.
00086     /// 
00087     /// \return
00088     /// Returns nothing
00089     /// 
00090     System::Void SetNull();
00091 
00092     /// \brief
00093     /// Overrides Expression.Process to pass the GeometryValue to the
00094     /// appropriate expression processor operation.
00095     /// 
00096     /// \param processor 
00097     /// Input the expression processor interface
00098     /// 
00099     /// \return
00100     /// Returns nothing
00101     /// 
00102     System::Void Process(NAMESPACE_OSGEO_FDO_EXPRESSION::IExpressionProcessor* processor);
00103 
00104     /// \brief
00105     /// Returns the well defined text representation of this expression.
00106     /// 
00107     /// \return
00108     /// Returns the well defined text string
00109     /// 
00110     System::String* ToString();
00111 
00112     /// \brief
00113     /// Constructs a GeometryValue object based on an unmanaged instance of the object
00114     /// 
00115     /// \param unmanaged 
00116     /// Input A Pointer to the unmanaged object.
00117     /// 
00118     /// \param autoDelete 
00119     /// Input Indicates if the constructed object should be automatically deleted 
00120     /// once it no longer referenced.
00121     /// 
00122     GeometryValue(System::IntPtr unmanaged, System::Boolean autoDelete);
00123 
00124 public private:
00125     inline FdoGeometryValue* GetImpObj();
00126 };
00127 
00128 END_NAMESPACE_OSGEO_FDO_EXPRESSION
00129 
00130 

Comments or suggestions? Send us feedback.