Public Member Functions | List of all members
ProvenanceEvent Class Referenceabstract

Event Events are the operations that cause the change from source files to target files. More...

#include <Provenance.h>

Inheritance diagram for ProvenanceEvent:
ProvenanceFile

Public Member Functions

DGNPLATFORM_EXPORT void SetEventCategory (EventType scope)
 Set Event Category that identify type of Provenance. More...
 
DGNPLATFORM_EXPORT void SetSourceList (bvector< SourcePtr > list)
 Set Source List that contribute to a imodel creation. More...
 
DGNPLATFORM_EXPORT void AddProvenanceAttribute (ProvenanceAttributeR attribute)
 Add single ProvenanceAttribute to the provenance. More...
 
DGNPLATFORM_EXPORT void AddProvenanceSource (SourceR source)
 Add single Source to the provenance. More...
 
DGNPLATFORM_EXPORT void SetID (WString eventId)
 Set Provenance ID ( i.e. More...
 
DGNPLATFORM_EXPORT EventType GetEventCategory ()
 Get Event Category that identify type of Provenance. More...
 
DGNPLATFORM_EXPORT bvector
< SourcePtr
GetSourceList ()
 Get Source List that contribute to a imodel creation. More...
 
DGNPLATFORM_EXPORT int GetSourceCount ()
 Get Source count. More...
 
DGNPLATFORM_EXPORT bvector
< ProvenanceAttributePtr
GetAttributeList ()
 Get ProvenanceAttribute List. More...
 
DGNPLATFORM_EXPORT WString GetId ()
 Get Provenance ID ( i.e. More...
 

Detailed Description

Event Events are the operations that cause the change from source files to target files.

Member Function Documentation

DGNPLATFORM_EXPORT void AddProvenanceAttribute ( ProvenanceAttributeR  attribute)

Add single ProvenanceAttribute to the provenance.

Parameters
attributeProvenanceAttribute of the provenance
DGNPLATFORM_EXPORT void AddProvenanceSource ( SourceR  source)

Add single Source to the provenance.

Parameters
sourcesource of the provenance

Get ProvenanceAttribute List.

Returns
Attribute vector
DGNPLATFORM_EXPORT EventType GetEventCategory ( )

Get Event Category that identify type of Provenance.

Returns
Event Category
See also
EventType for possible value

Get Provenance ID ( i.e.

a5461029-5c7c-4da9-8c83-1107e503c770 ). Provenance ID is a unique key within this set of provenance records.

Returns
ID
DGNPLATFORM_EXPORT int GetSourceCount ( )

Get Source count.

Returns
Source count.
DGNPLATFORM_EXPORT bvector<SourcePtr> GetSourceList ( )

Get Source List that contribute to a imodel creation.

Returns
Source vector
DGNPLATFORM_EXPORT void SetEventCategory ( EventType  scope)

Set Event Category that identify type of Provenance.

Parameters
scopetype of the provenance
See also
EventType for possible value
DGNPLATFORM_EXPORT void SetID ( WString  eventId)

Set Provenance ID ( i.e.

a5461029-5c7c-4da9-8c83-1107e503c770 ). Provenance ID is a unique key within this set of provenance records.

Parameters
eventIdUnique ID of provenance
DGNPLATFORM_EXPORT void SetSourceList ( bvector< SourcePtr list)

Set Source List that contribute to a imodel creation.

Parameters
listlist of sources

The documentation for this class was generated from the following file:

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