FDO .NET API Reference Feature Data Objects

mgByteValue.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 FdoByteValue;
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 ByteValue class derives from DataValue and represents a literal
00036 /// byte value.
00037 public __gc class ByteValue : public NAMESPACE_OSGEO_FDO_EXPRESSION::DataValue
00038 {
00039 public:
00040     /// \brief
00041     /// A cast operator to get the byte value.
00042     /// 
00043     /// \return
00044     /// Returns a byte
00045     /// 
00046     static System::Byte op_Explicit( NAMESPACE_OSGEO_FDO_EXPRESSION::ByteValue* value);
00047 
00048     /// \brief
00049     /// Constructs a default instance of an ByteValue with a value of null.
00050     /// 
00051     /// \return
00052     /// Returns the created ByteValue
00053     /// 
00054     ByteValue();
00055 
00056     /// \brief
00057     /// Constructs a default instance of an ByteValue using the specified arguments.
00058     /// 
00059     /// \param value 
00060     /// Input a byte
00061     /// 
00062     /// \return
00063     /// Returns the created ByteValue
00064     /// 
00065     ByteValue(System::Byte value);
00066 
00067     /// \brief
00068     /// Gets the data type of the ByteValue.
00069     /// 
00070     /// \return
00071     /// Returns an DataType
00072     /// 
00073     __property NAMESPACE_OSGEO_FDO_SCHEMA::DataType get_DataType();
00074 
00075     /// \brief
00076     /// Gets the ByteValue.
00077     /// 
00078     /// \return
00079     /// Returns a byte
00080     /// 
00081     __property System::Byte get_Byte();
00082 
00083     /// \brief
00084     /// Sets the byte value.
00085     /// 
00086     /// \param value 
00087     /// Input a byte
00088     /// 
00089     /// \return
00090     /// Returns nothing
00091     /// 
00092     __property System::Void set_Byte(System::Byte value);
00093 
00094     /// \brief
00095     /// Overrides Expression.Process to pass the ByteValue to the appropriate
00096     /// expression processor operation.
00097     /// 
00098     /// \param processor 
00099     /// Input an IExpressionProcessor
00100     /// 
00101     /// \return
00102     /// Returns nothing
00103     /// 
00104     System::Void Process(NAMESPACE_OSGEO_FDO_EXPRESSION::IExpressionProcessor* processor);
00105 
00106     /// \brief
00107     /// Returns the well defined text representation of this expression.
00108     /// 
00109     /// \return
00110     /// Returns a text string
00111     /// 
00112     System::String* ToString();
00113 
00114     /// \brief
00115     /// Constructs a ByteValue object based on an unmanaged instance of the object
00116     /// 
00117     /// \param unmanaged 
00118     /// Input A Pointer to the unmanaged object.
00119     /// 
00120     /// \param autoDelete 
00121     /// Input Indicates if the constructed object should be automatically deleted 
00122     /// once it no longer referenced.
00123     /// 
00124     ByteValue(System::IntPtr unmanaged, System::Boolean autoDelete);
00125 
00126 public private:
00127     inline FdoByteValue* GetImpObj();
00128 };
00129 END_NAMESPACE_OSGEO_FDO_EXPRESSION
00130 
00131 

Comments or suggestions? Send us feedback.