FDO .NET API Reference

Feature Data Objects

mgILTCheckpointReaderImp.h

Go to the documentation of this file.

/*
* Copyright (C) 2004-2006  Autodesk, Inc.
* 
* This library is free software; you can redistribute it and/or
* modify it under the terms of version 2.1 of the GNU Lesser
* General Public License as published by the Free Software Foundation.
* 
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
* Lesser General Public License for more details.
* 
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
*
*/

#pragma once

#include "FDO\Commands\LongTransaction\mgILongTransactionCheckpointReader.h"

class FdoILongTransactionCheckpointReader;

BEGIN_NAMESPACE_OSGEO_FDO_COMMANDS_LONGTRANSACTION

/// \ingroup (OSGeoFDOCommandsLongTransaction)
/// \brief
/// The ILongTransactionCheckpointReaderImp class is a concrete
/// implementation of ILongTransactionCheckpointReader.
/// The ILongTransactionCheckpointReader interface provides forward only,
/// read-only functionality for enumerating long transaction checkpoints.
/// A reference to an ILongTransactionCheckpointReader is returned from
/// the GetLongTransactionCheckpoints command. The initial position of
/// the ILongTransactionCheckpointReader is prior to the first item.
/// Thus, you must call ReadNext to begin accessing any data.
private __gc class ILongTransactionCheckpointReaderImp : public NAMESPACE_OSGEO_RUNTIME::Disposable, 
                                                         public NAMESPACE_OSGEO_FDO_COMMANDS_LONGTRANSACTION::ILongTransactionCheckpointReader
{
public:
    /// \brief
    /// Gets the name of the checkpoint currently being read.
    /// 
    /// \return
    /// Returns the checkpoint name
    /// 
    System::String* GetCheckpointName();

    /// \brief
    /// Gets the description of the checkpoint currently being read.
    /// 
    /// \return
    /// Returns the checkpoint description
    /// 
    System::String* GetCheckpointDescription();

    /// \brief
    /// Gets the creation date of the checkpoint currently being read.
    /// 
    /// \return
    /// Returns the creation date
    /// 
    System::DateTime GetCreationDate();

    /// \brief
    /// Returns true if the checkpoint currently being read is the active
    /// checkpoint.
    /// 
    /// \return
    /// Returns true if the checkpoint is active.
    /// 
    System::Boolean IsActive();

    /// \brief
    /// Advances the reader to the next item. The default position of the
    /// reader is prior to the first item. Thus, you must call ReadNext
    /// to begin accessing any data.
    /// 
    /// \return
    /// Returns true if there is a next item.
    /// 
    System::Boolean ReadNext();

    /// \brief
    /// Closes the ILongTransactionCheckpointReader object, freeing any
    /// resources it may be holding.
    /// 
    /// \return
    /// Returns nothing
    /// 
    System::Void Close();

public private:
    ILongTransactionCheckpointReaderImp(System::IntPtr unmanaged, System::Boolean autoDelete) : NAMESPACE_OSGEO_RUNTIME::Disposable(unmanaged, autoDelete)
    {

    }

    inline FdoILongTransactionCheckpointReader* GetImpObj();

/// \cond DOXYGEN-IGNORE
protected:
    System::Void ReleaseUnmanagedObject();
/// \endcond

};

END_NAMESPACE_OSGEO_FDO_COMMANDS_LONGTRANSACTION

---

Comments or suggestions? Send us feedback.