FDO .NET API Reference | Feature Data Objects |
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\LongTransaction\mgILongTransactionCheckpointReader.h" 00022 00023 class FdoILongTransactionCheckpointReader; 00024 00025 BEGIN_NAMESPACE_OSGEO_FDO_COMMANDS_LONGTRANSACTION 00026 00027 /// \ingroup (OSGeoFDOCommandsLongTransaction) 00028 /// \brief 00029 /// The ILongTransactionCheckpointReaderImp class is a concrete 00030 /// implementation of ILongTransactionCheckpointReader. 00031 /// The ILongTransactionCheckpointReader interface provides forward only, 00032 /// read-only functionality for enumerating long transaction checkpoints. 00033 /// A reference to an ILongTransactionCheckpointReader is returned from 00034 /// the GetLongTransactionCheckpoints command. The initial position of 00035 /// the ILongTransactionCheckpointReader is prior to the first item. 00036 /// Thus, you must call ReadNext to begin accessing any data. 00037 private __gc class ILongTransactionCheckpointReaderImp : public NAMESPACE_OSGEO_RUNTIME::Disposable, 00038 public NAMESPACE_OSGEO_FDO_COMMANDS_LONGTRANSACTION::ILongTransactionCheckpointReader 00039 { 00040 public: 00041 /// \brief 00042 /// Gets the name of the checkpoint currently being read. 00043 /// 00044 /// \return 00045 /// Returns the checkpoint name 00046 /// 00047 System::String* GetCheckpointName(); 00048 00049 /// \brief 00050 /// Gets the description of the checkpoint currently being read. 00051 /// 00052 /// \return 00053 /// Returns the checkpoint description 00054 /// 00055 System::String* GetCheckpointDescription(); 00056 00057 /// \brief 00058 /// Gets the creation date of the checkpoint currently being read. 00059 /// 00060 /// \return 00061 /// Returns the creation date 00062 /// 00063 System::DateTime GetCreationDate(); 00064 00065 /// \brief 00066 /// Returns true if the checkpoint currently being read is the active 00067 /// checkpoint. 00068 /// 00069 /// \return 00070 /// Returns true if the checkpoint is active. 00071 /// 00072 System::Boolean IsActive(); 00073 00074 /// \brief 00075 /// Advances the reader to the next item. The default position of the 00076 /// reader is prior to the first item. Thus, you must call ReadNext 00077 /// to begin accessing any data. 00078 /// 00079 /// \return 00080 /// Returns true if there is a next item. 00081 /// 00082 System::Boolean ReadNext(); 00083 00084 /// \brief 00085 /// Closes the ILongTransactionCheckpointReader object, freeing any 00086 /// resources it may be holding. 00087 /// 00088 /// \return 00089 /// Returns nothing 00090 /// 00091 System::Void Close(); 00092 00093 public private: 00094 ILongTransactionCheckpointReaderImp(System::IntPtr unmanaged, System::Boolean autoDelete) : NAMESPACE_OSGEO_RUNTIME::Disposable(unmanaged, autoDelete) 00095 { 00096 00097 } 00098 00099 inline FdoILongTransactionCheckpointReader* GetImpObj(); 00100 00101 /// \cond DOXYGEN-IGNORE 00102 protected: 00103 System::Void ReleaseUnmanagedObject(); 00104 /// \endcond 00105 00106 }; 00107 00108 END_NAMESPACE_OSGEO_FDO_COMMANDS_LONGTRANSACTION 00109 00110
Comments or suggestions? Send us feedback. |