FDO .NET API Reference Feature Data Objects

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

Comments or suggestions? Send us feedback.