FDO .NET API Reference Feature Data Objects

mgDataValue.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 #include "FDO\Schema\mgDataType.h"
00023 
00024 class FdoDataValue;
00025 
00026 BEGIN_NAMESPACE_OSGEO_FDO_EXPRESSION
00027 
00028 /// \ingroup (OSGeoFDOExpression)
00029 /// \brief
00030 /// The DataValue class derives from LiteralValue and represents a literal
00031 /// value such as a string or a number.
00032 public __gc class DataValue : public NAMESPACE_OSGEO_FDO_EXPRESSION::LiteralValue
00033 {
00034 public:
00035     /// \brief
00036     /// Constructs an instance of a null DataValue using the specified arguments.
00037     /// 
00038     /// \param dataType 
00039     /// Input data type
00040     /// 
00041     /// \return
00042     /// Returns nothing
00043     /// 
00044     DataValue(NAMESPACE_OSGEO_FDO_SCHEMA::DataType dataType);
00045 
00046     /// \brief
00047     /// Constructs an instance of an BooleanValue using the specified argument.
00048     /// 
00049     /// \param value 
00050     /// Input a Boolean value
00051     /// 
00052     /// \return
00053     /// Returns an BooleanValue
00054     /// 
00055     DataValue(System::Boolean value);
00056 
00057     /// \brief
00058     /// Constructs an instance of an ByteValue using the specified argument.
00059     /// 
00060     /// \param value 
00061     /// Input a byte
00062     /// 
00063     /// \return
00064     /// Returns an ByteValue
00065     /// 
00066     DataValue(System::Byte value);
00067 
00068     /// \brief
00069     /// Constructs an instance of an DateTimeValue using the specified argument.
00070     /// 
00071     /// \param value 
00072     /// Input a DateTime
00073     /// 
00074     /// \return
00075     /// Returns an DateTimeValue
00076     /// 
00077     DataValue(System::DateTime value);
00078 
00079     /// \brief
00080     /// Constructs an instance of an DecimalValue or DoubleValue using 
00081     /// the specified arguments.
00082     /// 
00083     /// \param value 
00084     /// Input a double
00085     /// \param dataType 
00086     /// Input a data type
00087     /// 
00088     /// \return
00089     /// Returns an DecimalValue or DoubleValue
00090     /// 
00091     DataValue(System::Double value, NAMESPACE_OSGEO_FDO_SCHEMA::DataType dataType);
00092 
00093     /// \brief
00094     /// Constructs an instance of an Int16Value using the specified argument.
00095     /// 
00096     /// \param value 
00097     /// Input a 16 bit integer
00098     /// 
00099     /// \return
00100     /// Returns an Int16Value
00101     /// 
00102     DataValue(System::Int16 value);
00103 
00104     /// \brief
00105     /// Constructs an instance of an Int32Value using the specified argument.
00106     /// 
00107     /// \param value 
00108     /// Input a 32 bit integer
00109     /// 
00110     /// \return
00111     /// Returns an Int32Value
00112     /// 
00113     DataValue(System::Int32 value);
00114 
00115     /// \brief
00116     /// Constructs an instance of an Int64Value using the specified argument.
00117     /// 
00118     /// \param value 
00119     /// Input a 64 bit integer
00120     /// 
00121     /// \return
00122     /// Returns an Int64Value
00123     /// 
00124     DataValue(System::Int64 value);
00125 
00126     /// \brief
00127     /// Constructs an instance of an SingleValue using the specified argument.
00128     /// 
00129     /// \param value 
00130     /// Input a single precision floating point value
00131     /// 
00132     /// \return
00133     /// Returns an SingleValue
00134     /// 
00135     DataValue(System::Single value);
00136 
00137     /// \brief
00138     /// Constructs an instance of an StringValue using the specified argument.
00139     /// 
00140     /// \param value 
00141     /// Input a character string
00142     /// 
00143     /// \return
00144     /// Returns an StringValue
00145     /// 
00146     DataValue(System::String* value);
00147 
00148     /// \brief
00149     /// Constructs an instance of an BLOBValue or CLOBValue using the specified arguments.
00150     /// 
00151     /// \param value 
00152     /// Input a byte array
00153     ///
00154     /// \param dataType 
00155     /// Input the type of value to create
00156     /// 
00157     /// \return
00158     /// Returns an BLOBValue or an CLOBValue
00159     /// 
00160     DataValue(System::Byte value [], NAMESPACE_OSGEO_FDO_SCHEMA::DataType dataType);
00161     
00162     /// \brief
00163     /// Gets the data type of the DataValue.
00164     /// 
00165     /// \return
00166     /// Returns an DataType
00167     /// 
00168     __property NAMESPACE_OSGEO_FDO_SCHEMA::DataType get_DataType();
00169 
00170     /// \brief
00171     /// Returns true if the DataValue represents a null value.
00172     /// 
00173     /// \return
00174     /// Returns true if the DataValue represents a null value
00175     /// 
00176     System::Boolean IsNull();
00177 
00178     /// \brief
00179     /// Sets the DataValue to a null value of the specified type.
00180     /// 
00181     /// \return
00182     /// Returns nothing
00183     /// 
00184     System::Void SetNull();
00185 
00186     /// \brief
00187     /// Constructs a DataValue object based on an unmanaged instance of the object
00188     /// 
00189     /// \param unmanaged 
00190     /// Input A Pointer to the unmanaged object.
00191     /// 
00192     /// \param autoDelete 
00193     /// Input Indicates if the constructed object should be automatically deleted 
00194     /// once it no longer referenced.
00195     /// 
00196     DataValue(System::IntPtr unmanaged, System::Boolean autoDelete);
00197 
00198 public private:
00199     inline FdoDataValue* GetImpObj();
00200 };
00201 END_NAMESPACE_OSGEO_FDO_EXPRESSION
00202 
00203 

Comments or suggestions? Send us feedback.