DgnHistory.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


namespace Bentley {
class DataInternalizer;
class DataExternalizer;
};

BEGIN_BENTLEY_DGNPLATFORM_NAMESPACE
struct XAttributeChange;
namespace DgnHistory {

//=======================================================================================
//=======================================================================================
class RevisionNumber
{
// ***************************** PERSISTENT VALUES *********************************
//  *****************************   DO NOT CHANGE   *********************************
private:
    /*-----------------------------------------------------------------------------------
        Fields
    -----------------------------------------------------------------------------------*/
    /*  We don't store a data format version # -- that would be too much space used
            for such a small structure. Instead, we have reserved a couple of fields (zeroed!)
            for future use. One of them could be used as a version # in the future. */
    UInt8       length;
    UInt8       flags;
    UInt16      _unused2_;
    UInt32*     d;

public:
    DGNPLATFORM_EXPORT ~RevisionNumber ();
    DGNPLATFORM_EXPORT RevisionNumber ();
    DGNPLATFORM_EXPORT RevisionNumber (RevisionNumber const& r2);
    DGNPLATFORM_EXPORT RevisionNumber& operator= (RevisionNumber const& r2);

    DGNPLATFORM_EXPORT bool operator< (RevisionNumber const& rn2) const;
    DGNPLATFORM_EXPORT bool operator<= (RevisionNumber const& rn2) const;
    DGNPLATFORM_EXPORT bool operator> (RevisionNumber const& rn2) const;
    DGNPLATFORM_EXPORT bool operator>= (RevisionNumber const& rn2) const;
    DGNPLATFORM_EXPORT bool operator== (RevisionNumber const& rn2) const;
    DGNPLATFORM_EXPORT bool operator!= (RevisionNumber const& rn2) const;

    DGNPLATFORM_EXPORT static RevisionNumber Recent ();

    DGNPLATFORM_EXPORT bool IsRecent () const;

    DGNPLATFORM_EXPORT bool IsValid () const;

/*---------------------------------------------------------------------------------**/
    DGNPLATFORM_EXPORT WString Format () const;

/*---------------------------------------------------------------------------------**/
DGNPLATFORM_EXPORT WString FormatCustom (WChar const* fmt) const;

DGNPLATFORM_EXPORT static RevisionNumber ParseCustom (WChar const* fmt, WChar const* str);

DGNPLATFORM_EXPORT static RevisionNumber Parse (WChar const *str);

};


//=======================================================================================
//=======================================================================================
class CommitInfo
{

WString         m_user;     
WString         m_desc;     
RevisionNumber  m_revnum;   
UInt32          m_flags;    

public:
DGNPLATFORM_EXPORT CommitInfo (WString const& desc);
DGNPLATFORM_EXPORT void SetUserName (WCharCP userName);
DGNPLATFORM_EXPORT bool IsValid () const;
};

//=======================================================================================
//=======================================================================================
class RevisionInfo
{
WString         m_user;
WString         m_desc;
double          m_time;
RevisionNumber  m_num;
RevisionNumber  m_next;
    UInt32      m_flags;
public:

DGNPLATFORM_EXPORT RevisionInfo ();
DGNPLATFORM_EXPORT RevisionInfo (RevisionInfo const&);
DGNPLATFORM_EXPORT RevisionInfo& operator= (RevisionInfo const&);
DGNPLATFORM_EXPORT ~RevisionInfo ();

DGNPLATFORM_EXPORT WString     GetUser() const;
DGNPLATFORM_EXPORT WString     GetDescription() const;
DGNPLATFORM_EXPORT double      GetTime() const;
DGNPLATFORM_EXPORT RevisionNumber GetRevisionNumber() const;
};

typedef bvector<RevisionInfo> T_RevisionInfoVector;

//=======================================================================================
//=======================================================================================
enum AuditTrailRecordType
{
    AUDIT_TRAIL_RECORD_TYPE_CombineRevisions   =0,
    AUDIT_TRAIL_RECORD_TYPE_RetireRevisions    =1,
    AUDIT_TRAIL_RECORD_TYPE_ChangeDescription  =2,
    AUDIT_TRAIL_RECORD_TYPE_ChangeUser         =3,
    AUDIT_TRAIL_RECORD_TYPE_MakeShared         =4,
    AUDIT_TRAIL_RECORD_TYPE_Create             =5,
};

//=======================================================================================
//=======================================================================================
// ***************************** PERSISTENT VALUES *********************************
//  *****************************   DO NOT CHANGE   *********************************
class AuditTrailRecord
{
public:
DGNPLATFORM_EXPORT WString     GetUser() const;
DGNPLATFORM_EXPORT WString     GetDescription() const;
DGNPLATFORM_EXPORT double      GetTime() const;
DGNPLATFORM_EXPORT RevisionNumber GetStartRevisionNumber() const;
DGNPLATFORM_EXPORT RevisionNumber GetEndRevisionNumber() const;
DGNPLATFORM_EXPORT AuditTrailRecordType GetType () const;
};

//=======================================================================================

// ***************************** PERSISTENT VALUES *********************************
//  *****************************   DO NOT CHANGE   *********************************
class ElementChangeFlags
{
    //  Fields
protected:
    /*  ChangeRecord data version is governed by the Admin version */
    enum {FLAGS_Mask=0xF0, FLAG_Have8ByteID=0x80};

    //  Fields
    UInt8           m_flagsAndChangeType;       // 4-bit flags | 4-bit change type value
    UInt8           m_unused_transient_byte;    // unused -- NOT STORED -- always zero
    UInt16          m_unused_transient_short;   // unused -- NOT STORED -- always zero
    UInt32          m_unused_transient_int;     // unused -- NOT STORED -- always zero

    //  Methods
protected:
    DGNPLATFORM_EXPORT void Init (ElementChangeType);

public:
explicit
    ElementChangeFlags (ElementChangeType ct)           {Init(ct);}
    ElementChangeFlags ()                               {Init(ElementChangeType::Missing);}

    bool operator== (ElementChangeFlags const& rhs) const {return m_flagsAndChangeType == rhs.m_flagsAndChangeType;}

    DGNPLATFORM_EXPORT ElementChangeType GetChangeType () const;
    DGNPLATFORM_EXPORT void SetChangeType (ElementChangeType);
};

//=======================================================================================
//=======================================================================================
// ***************************** PERSISTENT VALUES *********************************
//  *****************************   DO NOT CHANGE   *********************************
struct    ElementChangeRecord : ElementChangeFlags
{
private:
    ElementId           m_element;
public:
    ElementChangeRecord () {}
    ElementChangeRecord (ElementId e, ElementChangeFlags c) : m_element(e), ElementChangeFlags(c) {;}
    ElementChangeRecord (ElementChangeType ct, ElementId eid) : m_element(eid), ElementChangeFlags(ct) {;}
explicit
    ElementChangeRecord (bpair<ElementId, ElementChangeFlags> const& pr) : m_element(pr.first), ElementChangeFlags(pr.second) {;}

    ElementId GetElementId() const {return m_element;}

    StatusInt Load (DataInternalizer&);
    void Store (DataExternalizer&) const;
}; // ElementChangeFlags

/*=================================================================================**/
struct   IElementChangeProcessor
{
virtual ~IElementChangeProcessor() {}
virtual void            SetModel (ModelId) = 0;

virtual StatusInt       ProcessElementChange
(
RevisionInfo const&         revision,   // =>  history revision that contains this change
ModelId                     mid,        // =>  the model that contains this element
ElementChangeRecord const&  change,     // =>  the relative change that produced this state
MSElementDescrP             element     // =>  the historical state of the element (you can call mdlElmdscr_addRef on it, but you should not otherwise modify it)
) = 0;

}; // IElementChangeProcessor

//=======================================================================================
//=======================================================================================
// ***************************** PERSISTENT VALUES *********************************
//  *****************************   DO NOT CHANGE   *********************************
struct XAUniqueId
{
UInt32  m_handler;
UInt32  m_id;

    XAUniqueId(){}
DGNPLATFORM_EXPORT XAUniqueId (UInt32 h, UInt32 i);
DGNPLATFORM_EXPORT explicit XAUniqueId (XAttributeHandle const&);

DGNPLATFORM_EXPORT explicit XAUniqueId (XAttributeChange const&);

DGNPLATFORM_EXPORT XAttributeHandlerId GetHandlerId () const;

DGNPLATFORM_EXPORT UInt32 GetId () const;

DGNPLATFORM_EXPORT UInt64 AsUInt64 () const;

bool operator == (XAUniqueId const& cc) const {return m_handler==cc.m_handler && m_id==cc.m_id;}
bool operator < (XAUniqueId const& cc) const {return AsUInt64() < cc.AsUInt64();}

DGNPLATFORM_EXPORT StatusInt CheckIsValid () const;

DGNPLATFORM_EXPORT StatusInt Load (DataInternalizer& source);
DGNPLATFORM_EXPORT void Store (DataExternalizer& sink) const;
};



}; // DgnHistory
END_BENTLEY_DGNPLATFORM_NAMESPACE