FDO API Reference Feature Data Objects

BLOBValue.h

Go to the documentation of this file.
00001 #ifndef _BLOBVALUE_H_
00002 #define _BLOBVALUE_H_
00003 // 
00004 
00005 //
00006 // Copyright (C) 2004-2006  Autodesk, Inc.
00007 // 
00008 // This library is free software; you can redistribute it and/or
00009 // modify it under the terms of version 2.1 of the GNU Lesser
00010 // General Public License as published by the Free Software Foundation.
00011 // 
00012 // This library is distributed in the hope that it will be useful,
00013 // but WITHOUT ANY WARRANTY; without even the implied warranty of
00014 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
00015 // Lesser General Public License for more details.
00016 // 
00017 // You should have received a copy of the GNU Lesser General Public
00018 // License along with this library; if not, write to the Free Software
00019 // Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
00020 //
00021 
00022 #ifdef _WIN32
00023 #pragma once
00024 #endif
00025 
00026 #include <FdoStd.h>
00027 #include <Fdo/Expression/LOBValue.h>
00028 #include <Fdo/Schema/DataType.h>
00029 
00030 /// \brief
00031 /// The FdoBLOBValue class derives from FdoLOBValue and represents a literal
00032 /// BLOB value.
00033 class FdoBLOBValue : public FdoLOBValue 
00034 {
00035 public:
00036     /// \brief
00037     /// Constructs a default instance of an FdoBLOBValue with a value of null.
00038     /// 
00039     /// \return
00040     /// Returns the created FdoBLOBValue
00041     /// 
00042     FDO_API static FdoBLOBValue* Create();
00043 
00044     /// \brief
00045     /// Constructs an instance of an FdoBLOBValue using the specified arguments.
00046     /// 
00047     /// \param value 
00048     /// Input a byte array
00049     /// 
00050     /// \return
00051     /// Returns the created FdoBLOBValue
00052     /// 
00053     FDO_API static FdoBLOBValue* Create(FdoByteArray* value);
00054 
00055 
00056     FDO_API FdoDataType GetDataType();
00057     FDO_API FdoByteArray* GetData();
00058     FDO_API void SetData(FdoByteArray* value);
00059     FDO_API void SetNull();
00060     FDO_API void Process(FdoIExpressionProcessor* p);
00061     FDO_API FdoString* ToString();
00062 
00063 
00064 protected:
00065 /// \cond DOXYGEN-IGNORE
00066     /// \brief
00067     /// Constructs a default instance of an FdoBLOBValue with a value of null.
00068     /// \return
00069     /// Returns nothing
00070     /// 
00071     FdoBLOBValue();
00072 
00073     /// \brief
00074     /// Constructs a default instance of an FdoBLOBValue using the specified arguments.
00075     /// \param value 
00076     /// Input a byte array
00077     /// 
00078     /// \return
00079     /// Returns nothing
00080     /// 
00081     FdoBLOBValue(FdoByteArray* value);
00082 
00083     /// \brief
00084     /// Default destructor for FdoBLOBValue.
00085     /// \return
00086     /// Returns nothing
00087     /// 
00088     virtual ~FdoBLOBValue();
00089 
00090     virtual void Dispose();
00091 
00092 };
00093 /// \endcond
00094 #endif
00095 
00096 

Comments or suggestions? Send us feedback.