FDO .NET API Reference Feature Data Objects

mgLOBValue.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\mgDataValue.h"
00022 
00023 class FdoLOBValue;
00024 
00025 BEGIN_NAMESPACE_OSGEO_FDO_SCHEMA
00026 public __value enum DataType;
00027 END_NAMESPACE_OSGEO_FDO_SCHEMA
00028 
00029 BEGIN_NAMESPACE_OSGEO_FDO_EXPRESSION
00030 
00031 public __gc __interface IExpressionProcessor;
00032 
00033 /// \ingroup (OSGeoFDOExpression)
00034 /// \brief
00035 /// The LOBValue class derives from DataValue and represents a literal
00036 /// BLOB value.
00037 public __gc class LOBValue : public NAMESPACE_OSGEO_FDO_EXPRESSION::DataValue
00038 {
00039 public:
00040     /// \brief
00041     /// Transforms the FDO LOB value into a byte array.
00042     /// 
00043     /// \param value 
00044     /// Input an FDO LOBValue object
00045     /// 
00046     /// \return
00047     /// Returns a byte array
00048     /// 
00049     static System::Byte op_Explicit( NAMESPACE_OSGEO_FDO_EXPRESSION::LOBValue* value ) [];
00050 
00051     /// \brief
00052     /// Gets the data type of the LOBValue.
00053     /// 
00054     /// \return
00055     /// Returns an DataType
00056     /// 
00057     __property NAMESPACE_OSGEO_FDO_SCHEMA::DataType get_DataType();
00058 
00059     /// \brief
00060     /// Gets the LOB data.
00061     /// 
00062     /// \return
00063     /// Returns a byte array
00064     /// 
00065     __property System::Byte get_Data() [];
00066 
00067     /// \brief
00068     /// Sets the LOB data.
00069     /// 
00070     /// \param value 
00071     /// Input an array of bytes
00072     /// 
00073     /// \return
00074     /// Returns nothing
00075     /// 
00076     __property System::Void set_Data(System::Byte value []);
00077 
00078     /// \brief
00079     /// Sets the LOBValue to a null value.
00080     /// 
00081     /// \return
00082     /// Returns nothing
00083     /// 
00084     System::Void SetNull();
00085 
00086     /// \brief
00087     /// Overrides Expression.Process to pass the LOBValue to the appropriate
00088     /// expression processor operation.
00089     /// 
00090     /// \param processor 
00091     /// Input the IExpressionProcessor
00092     /// 
00093     /// \return
00094     /// Returns nothing
00095     /// 
00096     System::Void Process(NAMESPACE_OSGEO_FDO_EXPRESSION::IExpressionProcessor* processor);
00097 
00098     /// \brief
00099     /// Returns the well defined text representation of this expression.
00100     /// 
00101     /// \return
00102     /// Returns a text string
00103     /// 
00104     System::String* ToString(); 
00105 
00106     /// \brief
00107     /// Constructs a LOBValue object based on an unmanaged instance of the object
00108     /// 
00109     /// \param unmanaged 
00110     /// Input A Pointer to the unmanaged object.
00111     /// 
00112     /// \param autoDelete 
00113     /// Input Indicates if the constructed object should be automatically deleted 
00114     /// once it no longer referenced.
00115     /// 
00116     LOBValue(System::IntPtr unmanaged, System::Boolean autoDelete);
00117 
00118 public private:
00119     inline FdoLOBValue* GetImpObj();
00120 };
00121 END_NAMESPACE_OSGEO_FDO_EXPRESSION
00122 
00123 

Comments or suggestions? Send us feedback.