FDO .NET API Reference Feature Data Objects

mgIoTextReader.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 "Runtime\Disposable.h"
00022 
00023 class FdoIoTextReader;
00024 
00025 BEGIN_NAMESPACE_OSGEO_COMMON_IO
00026 public __gc class IoStream;
00027 
00028 /// \ingroup (OSGeoFDOCommonIo)
00029 /// \brief
00030 ///     IoTextReader reads from a binary stream containing UTF8 characters.
00031 ///     It formats these UTF8 characters into Unicode wide characters. This class is 
00032 ///     not yet complete, since the Read functions still have to be added.
00033 public __sealed __gc class IoTextReader : public NAMESPACE_OSGEO_RUNTIME::Disposable
00034 {
00035 public:
00036     /// \brief
00037     ///     Constructs a text reader on a file
00038     /// 
00039     /// \param fileName 
00040     ///     Input name of the file to read.
00041     /// 
00042     IoTextReader(System::String* fileName);
00043 
00044     /// \brief
00045     ///     Constructs a text reader on a stream
00046     /// 
00047     /// \param stream 
00048     ///     Input the stream to read.
00049     /// 
00050     IoTextReader(NAMESPACE_OSGEO_COMMON_IO::IoStream* stream);
00051 
00052     /// \brief
00053     ///     Gets the underlying stream. If a stream was passed to this object
00054     ///     then this stream is returned.
00055     ///     Otherwise, an auto-generated stream (wrapped around the  file name 
00056     ///     that was passed to this object) is returned.
00057     /// 
00058     /// \return
00059     ///     Returns the underlying stream.
00060     /// 
00061     ///  
00062     __property NAMESPACE_OSGEO_COMMON_IO::IoStream* get_Stream();
00063 
00064     /// \brief
00065     ///     Constructs a text reader based on an unmanaged instance of the object
00066     /// 
00067     /// \param unmanaged 
00068     ///     Input A Pointer to the unmanaged reader.
00069     /// 
00070     /// \param autoDelete 
00071     ///     Input Indicates if the constructed object should be automatically deleted 
00072     ///     once it no longer referenced.
00073     /// 
00074     IoTextReader(System::IntPtr unmanaged, System::Boolean autoDelete);
00075 
00076 /// \cond DOXYGEN-IGNORE
00077 protected:
00078     System::Void ReleaseUnmanagedObject();
00079 
00080 public private:
00081     inline FdoIoTextReader* GetImpObj();
00082 /// \endcond
00083 };
00084 
00085 END_NAMESPACE_OSGEO_COMMON_IO
00086 
00087 

Comments or suggestions? Send us feedback.