FDO .NET API Reference Feature Data Objects

mgBLOBValue.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\mgLOBValue.h"
00022 
00023 class FdoBLOBValue;
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 BLOBValue class derives from LOBValue and represents a literal
00036 /// BLOB value.
00037 public __gc class BLOBValue : public NAMESPACE_OSGEO_FDO_EXPRESSION::LOBValue 
00038 {
00039 public:
00040     /// \brief
00041     /// Constructs a default instance of an BLOBValue with a value of null.
00042     /// 
00043     /// \return
00044     /// Returns the created BLOBValue
00045     /// 
00046     BLOBValue();
00047 
00048     /// \brief
00049     /// Constructs an instance of an BLOBValue using the specified arguments.
00050     /// 
00051     /// \param value 
00052     /// Input a byte array
00053     /// 
00054     /// \return
00055     /// Returns the created BLOBValue
00056     /// 
00057     BLOBValue(System::Byte value []);
00058 
00059     /// \brief
00060     /// Gets the FDO DataType of the BLOB
00061     /// 
00062     /// \return
00063     /// Returns the FDO DataType
00064     /// 
00065     __property NAMESPACE_OSGEO_FDO_SCHEMA::DataType get_DataType();
00066 
00067     /// \brief
00068     /// Gets the data associated to the blob as an Byte Array
00069     /// 
00070     /// \return
00071     /// Returns the Byte Array containing the BLOB data
00072     /// 
00073     __property System::Byte get_Data() [];
00074 
00075     /// \brief
00076     /// Sets the data associated to the BLOB using an FDO ByteArray
00077     /// 
00078     /// \param value
00079     /// Input the FDO Byte Array
00080     /// 
00081     __property System::Void set_Data(System::Byte value []);
00082 
00083     /// \brief
00084     /// Sets the value of the BLOB to NULL.
00085     /// 
00086     System::Void SetNull();
00087 
00088     /// \brief
00089     /// Overrides FdoIExpression::Process to pass the DataValue to the appropriate
00090     /// expression processor operation.
00091     /// 
00092     /// \param processor
00093     /// Input the pointer to the FDO expression processor
00094     /// 
00095     System::Void Process(NAMESPACE_OSGEO_FDO_EXPRESSION::IExpressionProcessor* processor);
00096 
00097     /// \brief
00098     /// Gets the value of the BLOB as a string.
00099     /// 
00100     /// \return
00101     /// Returns the well defined text representation of the BLOB
00102     /// 
00103     System::String* ToString();
00104 
00105     /// \brief
00106     /// Constructs a BLOBValue object based on an unmanaged instance of the object
00107     /// 
00108     /// \param unmanaged 
00109     /// Input A Pointer to the unmanaged object.
00110     /// 
00111     /// \param autoDelete 
00112     /// Input Indicates if the constructed object should be automatically deleted 
00113     /// once it no longer referenced.
00114     /// 
00115     BLOBValue(System::IntPtr unmanaged, System::Boolean autoDelete);
00116 
00117 public private:
00118     inline FdoBLOBValue* GetImpObj();
00119 };
00120 END_NAMESPACE_OSGEO_FDO_EXPRESSION
00121 
00122 

Comments or suggestions? Send us feedback.