DesignHistoryRestore.h

Go to the documentation of this file.

/*--------------------------------------------------------------------------------------+
|
|   Supplied under applicable software license agreement.
|
|   Copyright (c) 2018 Bentley Systems, Incorporated. All rights reserved.
|
+---------------------------------------------------------------------------------------*/
#pragma once

#include "DesignHistory.h"

BEGIN_BENTLEY_DGNPLATFORM_NAMESPACE
namespace DgnHistory {

enum class  RestoreType
    {
    NotRestoring        = 0,
    EntireFile          = 1,
    SelectedElements    = 2,
    };

/*=================================================================================**/
class DGNPLATFORM_EXPORT DesignHistoryRestore
{
bool m_dontForceModelDelete;

public:

void        SetDontForceModelDelete (bool); // When un-creating a model, if there are existing modelrefs on the model, should the delete should fail?

DesignHistoryRestore ();

~DesignHistoryRestore ();

// ##########################################################################

// ##########################################################################

StatusInt   Restore
(
DgnFileR                        file,               
RevisionNumber const&           targetRev,          
bool                            fromUndo = false    
);

StatusInt   Restore
(
DgnFileR                            file,               
RevisionNumber const&               targetRev,          
ModelsToElementChangesMap const&    elements            
);

StatusInt   Restore
(
DgnFileR                            file,               
RevisionNumber const&               targetRev,          
IElementQueryResultFilter&          csfilter,           
ElementChangeRecordFilter const&    ssfilter           
);

static
RestoreType IsRestoreInProgress (DgnFileR file);

// ##########################################################################
// ##########################################################################

static
bool        CanRestore
(
DesignHistory&                  dh,                 
RevisionNumbersForFile&         revs,               
ElementChangeRecordFilter const& ssfilter           
);

static
bool        IsRollback
(
RevisionNumber&                 targetRev,
DesignHistory&                  dh,
RevisionNumbersForFile&         revs,
ElementChangeRecordFilter const& ssfilter
);


static long GetUndoPos();

}; // DesignHistoryRestore
}; // namespace DgnHistory 
END_BENTLEY_DGNPLATFORM_NAMESPACE