File Provenance Information. More...

#include <Provenance.h>

Inheritance diagram for ProvenanceFile:

Public Member Functions
DGNPLATFORM_EXPORT void	SetTimestamp (time_t time)
	Set Timestamp of the file provenance. More...

DGNPLATFORM_EXPORT void	SetProcessType (ProcessType type)
	Set Process Type. More...

DGNPLATFORM_EXPORT void	SetEngine (WStringCR engineName)
	Set Engine name. More...

DGNPLATFORM_EXPORT void	SetConfiguration (WStringCR config)
	Set Configuration that has been used with the engine. More...

DGNPLATFORM_EXPORT void	SetEngineVersion (WString engineVersion)
	Set Engine Version. More...

DGNPLATFORM_EXPORT void	SetTarget (WString target)
	Set target file name for the file provenance. More...

DGNPLATFORM_EXPORT time_t	GetTimestamp ()
	Get Timestamp of the file provenance. More...

DGNPLATFORM_EXPORT ProcessType	GetProcessType ()
	Get Process Type. More...

DGNPLATFORM_EXPORT WStringCR	GetEngine ()
	Get Engine name. More...

DGNPLATFORM_EXPORT WString	GetConfiguration ()
	Get Configuration that has been used with the engine. More...

DGNPLATFORM_EXPORT WString	GetEngineVersion ()
	Get Engine Version. More...

DGNPLATFORM_EXPORT WString	GetTarget ()
	Get target file name for the file provenance. More...

Public Member Functions inherited from ProvenanceEvent
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...

Static Public Member Functions
static DGNPLATFORM_EXPORT ProvenanceFileP	CreateFileProvenance ()
	Create an instance of ProvenanceFile. More...

static DGNPLATFORM_EXPORT void	DeleteFileProvenance (ProvenanceFileP obj)
	Delete an instance of ProvenanceFile. More...

Detailed Description

File Provenance Information.

Timestamp of the provenance
Event process type ( transform or extract )
Engine name that has been used to create the i-model
Engine configuration
Engine version
Target path

Member Function Documentation

static DGNPLATFORM_EXPORT ProvenanceFileP CreateFileProvenance ( )

static

Create an instance of ProvenanceFile.

Returns: a pointer of ProvenanceFile object

static DGNPLATFORM_EXPORT void DeleteFileProvenance ( ProvenanceFileP obj )

static

Delete an instance of ProvenanceFile.

Parameters

obj	Provenance file object to be deleted

DGNPLATFORM_EXPORT WString GetConfiguration ( )

Get Configuration that has been used with the engine.

A string identifying the configuration used during this event. This can either the actual configuration assuming it can be represented as a string or name of the configuration depending on the capabilities of the engine.

Returns: Configuration string

DGNPLATFORM_EXPORT WStringCR GetEngine ( )

Get Engine name.

A string identifying the "engine" that performed the event ( i.e. 'MicroStation' )

Returns: engine name

DGNPLATFORM_EXPORT WString GetEngineVersion ( )

Get Engine Version.

( i.e. '08.11.09.260' )

Returns: Engine Version

DGNPLATFORM_EXPORT ProcessType GetProcessType ( )

Get Process Type.

Valid types are Extract and Transform.

Returns: Process Type

See also: ProcessType

DGNPLATFORM_EXPORT WString GetTarget ( )

Get target file name for the file provenance.

i.e. i-model or package file name. ( i.e. 'file://C:\imodel\Main.i.dgn' ) For each Provenance, there should be one target file that identify the resultant of either Extract or Transform operation.

Returns: target

DGNPLATFORM_EXPORT time_t GetTimestamp ( )

Get Timestamp of the file provenance.

The time stamp of when the event occurred.

Returns: Timestamp

DGNPLATFORM_EXPORT void SetConfiguration ( WStringCR config )

Set Configuration that has been used with the engine.

A string identifying the configuration used during this event. This can either the actual configuration assuming it can be represented as a string or name of the configuration depending on the capabilities of the engine.

Parameters

config Configuration string

DGNPLATFORM_EXPORT void SetEngine ( WStringCR engineName )

Set Engine name.

A string identifying the "engine" that performed the event ( i.e. 'MicroStation' )

Parameters

engineName engine name

DGNPLATFORM_EXPORT void SetEngineVersion ( WString engineVersion )

Set Engine Version.

( i.e. '08.11.09.260' )

Parameters

engineVersion Engine Version

DGNPLATFORM_EXPORT void SetProcessType ( ProcessType type )

Set Process Type.

Valid types are Extract and Transform.

Parameters

type	Process Type

See also: ProcessType

DGNPLATFORM_EXPORT void SetTarget ( WString target )

Set target file name for the file provenance.

i.e. i-model or package file name. ( i.e. 'file://C:\imodel\Main.i.dgn' ) For each Provenance, there should be one target file that identify the resultant of either Extract or Transform operation.

Parameters

target target file path

DGNPLATFORM_EXPORT void SetTimestamp ( time_t time )

Set Timestamp of the file provenance.

The time stamp of when the event occurred.

Parameters

time Timestamp

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

Provenance.h

Public Member Functions

Static Public Member Functions

Detailed Description

Member Function Documentation