FDO .NET API Reference Feature Data Objects

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

Comments or suggestions? Send us feedback.