Classes | Typedefs | Enumerations
Bentley::DgnPlatform::DgnHistory Namespace Reference

Contains classes for accessing Design History within a DgnFile. The most important class is Bentley::DgnPlatform::DgnHistory::DesignHistory. See Design History. More...

Classes

class  AuditTrailRecord
 a record in design history audit trail. More...
 
class  CommitInfo
 Associates a user name and a description with a set of changes recorded in design history. More...
 
class  DesignHistory
 Provides access to the design history of a specified file. More...
 
class  DesignHistoryRestore
 
class  ElementQueryResult
 Holds the result of querying design history for the historical version of an element. More...
 
class  ElementQueryResultsForFile
 Copies of elements in a historical state for a given file. More...
 
class  ElementQueryResultsForModel
 Copies of elements in a historical state for a given model. More...
 
class  ElementsAsOfQuery
 Performs a query to get the historical state of elements. More...
 
struct  IElementQueryResultFilter
 Interface to filter query results at the element level. More...
 
class  RevisionInfo
 Documents a set of changes in design history. More...
 
class  RevisionNumber
 A history revision number. More...
 
class  RevisionNumbersForFile
 A set of revision numbers pertaining to the design history of a specified file. More...
 

Typedefs

typedef bvector< RevisionNumberT_RevisionNumberVectorType
 
typedef bstdmap< ElementId,
ElementQueryResult
T_ElementIdToElementQueryResultMapType
 
typedef bstdmap< ModelId,
ElementQueryResultsForModel
T_ModelIdToElementQueryResultsForModelMapType
 
typedef bvector< RevisionInfoT_RevisionInfoVector
 

Enumerations

enum  HistoryCapabilities {
  HistoryCapabilities_Supported = 0x0001, HistoryCapabilities_Create = 0x0002, HistoryCapabilities_Combine = 0x0004, HistoryCapabilities_Commit = 0x0008,
  HistoryCapabilities_Browse = 0x0010, HistoryCapabilities_Delete = 0x0020, HistoryCapabilities_Retire = 0x0040, HistoryCapabilities_Trace = 0x0080,
  HistoryCapabilities_Tag = 0x0100, HistoryCapabilities_ChangeDesc = 0x0200, HistoryCapabilities_AutoUpgrade = 0x0400, HistoryCapabilities_ChangeAuthor = 0x0800,
  HistoryCapabilities_SetRevisionFormat =0x1000, HistoryCapabilities_SetVersion = 0x2000, HistoryCapabilities_ALL = 0xffff
}
 History capabilities specific to a file and/or capabilities enabled in the current configuration. More...
 
enum  RestoreType { NotRestoring = 0, EntireFile = 1, SelectedElements = 2 }
 
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
}
 Type of record in design history audit trail. More...
 
enum  ElementChangeType { Missing = 0, Added = 1, Deleted = 2, Replaced = 4 }
 The kinds of changes recorded in design history. More...
 

Detailed Description

Contains classes for accessing Design History within a DgnFile. The most important class is Bentley::DgnPlatform::DgnHistory::DesignHistory. See Design History.

Typedef Documentation

Enumeration Type Documentation

Type of record in design history audit trail.

A design history audit trail is a record of history maintenance operations. Only operations that remove information from history are recorded.

Enumerator
AUDIT_TRAIL_RECORD_TYPE_CombineRevisions 
AUDIT_TRAIL_RECORD_TYPE_RetireRevisions 
AUDIT_TRAIL_RECORD_TYPE_ChangeDescription 
AUDIT_TRAIL_RECORD_TYPE_ChangeUser 
AUDIT_TRAIL_RECORD_TYPE_MakeShared 
AUDIT_TRAIL_RECORD_TYPE_Create 
enum ElementChangeType
strong

The kinds of changes recorded in design history.

Enumerator
Missing 

Fake value used by callers to identify a missing change type.

Added 

The element or model was added.

Deleted 

The element or model was deleted.

Replaced 

The element or model header was updated.

History capabilities specific to a file and/or capabilities enabled in the current configuration.

Enumerator
HistoryCapabilities_Supported 

Does the master file format support design history?

HistoryCapabilities_Create 

Can the user initialize design history?

HistoryCapabilities_Combine 

Can the user combine revisions?

HistoryCapabilities_Commit 

Can the user commit changes to design history?

HistoryCapabilities_Browse 

Can the user browse design history?

HistoryCapabilities_Delete 

Can the user delete design history?

HistoryCapabilities_Retire 

Can the user delete early revisions from design history?

HistoryCapabilities_Trace 

Can the user turn on tracing in design history functions?

HistoryCapabilities_Tag 

Can the user add tags?

HistoryCapabilities_ChangeDesc 

Can the user change revision descriptions in design history?

HistoryCapabilities_AutoUpgrade 

Automatically upgrade design history to the newest version when modifying?

HistoryCapabilities_ChangeAuthor 

Can the user change revision author in design history?

HistoryCapabilities_SetRevisionFormat 

Can the user change the revision format?

HistoryCapabilities_SetVersion 

Can the user change the revision number discontinuously?

HistoryCapabilities_ALL 

When used as a mask, identifies all capabilities.

enum RestoreType
strong
Enumerator
NotRestoring 
EntireFile 
SelectedElements 

Copyright © 2017 Bentley Systems, Incorporated. All rights reserved.