FDO .NET API Reference Feature Data Objects

mgIDataStoreReaderImp.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\Commands\DataStore\mgIDataStoreReader.h"
00022 
00023 class FdoIDataStoreReader;
00024 
00025 BEGIN_NAMESPACE_OSGEO_FDO_COMMANDS_DATASTORE
00026 public __gc __interface IDataStorePropertyDictionary;
00027 
00028 /// \ingroup (OSGeoFDOCommandsDataStore)
00029 /// \brief
00030 /// The IDataStoreReaderImp class is a concrete implementation class of the
00031 /// IDataStoreReader interface. IDataStoreReader provides a forward-only, read-only iterator
00032 /// for reading feature data.  A reference to an IDataStoreReader is returned
00033 /// from the IListDataStores command. Because the initial position of the
00034 /// IDataStoreReader is prior to the first item, you must call
00035 /// ReadNext to begin accessing any data.
00036 private __gc class IDataStoreReaderImp : public NAMESPACE_OSGEO_RUNTIME::Disposable, public NAMESPACE_OSGEO_FDO_COMMANDS_DATASTORE::IDataStoreReader
00037 {
00038 public:
00039     /// \brief
00040     /// Gets the name of the datastore currently being read.
00041     /// 
00042     /// \return
00043     /// Returns the description of the datastore.
00044     /// 
00045     System::String* GetName();
00046 
00047     /// \brief
00048     /// Gets the description of the datastore currently being read.
00049     /// 
00050     /// \return
00051     /// Returns the description of the datastore.
00052     /// 
00053     System::String* GetDescription();
00054 
00055     /// \brief
00056     /// Gets the flag that indicates whether the datastore is FDO enabled.
00057     /// Non-FDO databases are also referred to as “Foreign?datastores.
00058     /// 
00059     /// \return
00060     /// Returns the flag
00061     /// 
00062     System::Boolean GetIsFdoEnabled();
00063 
00064     /// \brief
00065     /// Gets the IDataStorePropertyDictionary interface that 
00066     /// includes the properties of the datastores set at datastore create 
00067     /// time, with the exception of password.
00068     /// 
00069     /// \return
00070     /// Returns the property dictionary
00071     /// 
00072     NAMESPACE_OSGEO_FDO_COMMANDS_DATASTORE::IDataStorePropertyDictionary* GetDataStoreProperties();
00073 
00074     /// \brief
00075     /// Advances the reader to the next item and returns true if there is
00076     /// another object to read or false if reading is complete. The default
00077     /// position of the reader is prior to the first item. Thus you must
00078     /// call ReadNext to begin accessing any data.
00079     /// 
00080     /// \return
00081     /// Returns true if there is a next item.
00082     /// 
00083     System::Boolean ReadNext();
00084 
00085     /// \brief
00086     /// Closes the IDataStoreReader object, freeing any resources it may be holding.
00087     /// 
00088     /// \return
00089     /// Returns nothing
00090     /// 
00091     System::Void Close();
00092 
00093 public private:
00094     IDataStoreReaderImp(System::IntPtr unmanaged, System::Boolean autoDelete);
00095 
00096     inline FdoIDataStoreReader* GetImpObj();
00097 
00098 /// \cond DOXYGEN-IGNORE
00099 protected:
00100     System::Void ReleaseUnmanagedObject();
00101 /// \endcond
00102 };
00103 
00104 END_NAMESPACE_OSGEO_FDO_COMMANDS_DATASTORE
00105 
00106 

Comments or suggestions? Send us feedback.