Public Member Functions | Static Public Member Functions | List of all members
ProvenanceManager Class Referenceabstract

The Provenance Manager allows to write provenance to an i-model and read it back. More...

#include <ProvenanceManager.h>

Inheritance diagram for ProvenanceManager:
RefCountedBase RefCounted< IRefCounted > IRefCounted

Public Member Functions

DGNPLATFORM_EXPORT StatusInt ExtractXML (WCharCP xmlFileName, bool extractEmbedded=false)
 Extract provenance xml from i-model. More...
 
DGNPLATFORM_EXPORT StatusInt ExtractBuffer (WChar **ppXmlBuffer)
 Extract provenance buffer from i-model. More...
 
DGNPLATFORM_EXPORT bvector
< SourcePtr
GetFileSources ()
 Get file sources from provenance. More...
 
DGNPLATFORM_EXPORT bvector
< SourcePtr
GetEmbeddedFileSources (int index)
 Get file sources from embedded provenance for a given index. More...
 
DGNPLATFORM_EXPORT StatusInt GetFileSourceURLList (bvector< WString > &srcFileUrlVec)
 Get all file source URL path from provenance. More...
 
DGNPLATFORM_EXPORT StatusInt GetRootFileSourceURLList (bvector< WString > &srcFileUrlVec)
 Get all root file source URL path from provenance. More...
 
DGNPLATFORM_EXPORT bool IsFilePresentAsFileSource (WStringCR sourcePath)
 Find the source path available in provenance. More...
 
DGNPLATFORM_EXPORT bool IsFilePresentAsFileSource (WStringCR sourcePath, SourcePtr &source)
 Find the source path available in provenance. More...
 
DGNPLATFORM_EXPORT
FileProvenanceCollection 
GetAllFileProvenance ()
 Get all file provenance. More...
 
DGNPLATFORM_EXPORT ProvenanceFileP GetRootFileProvenance ()
 Get root file provenance. More...
 
DGNPLATFORM_EXPORT ProvenanceFileP GetFileProvenanceFromMatchingTarget (WStringCR targetURL)
 Get file provenance that matches with the target URL. More...
 
DGNPLATFORM_EXPORT int GetFileProvenanceCount ()
 Get count of all file provenances. More...
 
DGNPLATFORM_EXPORT
FileProvenanceCollection 
GetEmbeddedFileProvenanceList (int index)
 Get file provenance from embedded provenance for a valid index value . More...
 
DGNPLATFORM_EXPORT int GetEmbeddedProvenanceCount ()
 Get embedded provenance count . More...
 
DGNPLATFORM_EXPORT bool IsEmbeddedProvenaceExist ()
 Find out if embedded provenance exists or not . More...
 
DGNPLATFORM_EXPORT StatusInt SetFileSource (WCharCP targetFileNameFuture, DgnFileR sourceFileObject, ProcessType type, WCharCP engine, WCharCP engineVersion, WCharCP configuration, ProvenanceAttributeVector &attribList)
 *------------------------------------------------------------------------------—**//** More...
 
DGNPLATFORM_EXPORT StatusInt SetFileSource (WCharCP targetFileNameFuture, WCharCP targetFileURL, DgnFileR sourceFileObject, WCharCP sourceFileURL, ProcessType type, WCharCP engine, WCharCP engineVersion, WCharCP configuration, ProvenanceAttributeVector &attribList)
 *------------------------------------------------------------------------------—**//** More...
 
DGNPLATFORM_EXPORT StatusInt SetFileSource (WCharCP targetFileNameFuture, WCharCP targetFileURL, DgnFileR sourceFileObject, WCharCP sourceFileURL, ProcessType type, WCharCP engine, WCharCP engineVersion, WCharCP configuration, const SourceVector &sources, ProvenanceAttributeVector &attribList)
 *------------------------------------------------------------------------------—**//** More...
 
DGNPLATFORM_EXPORT bool MatchFileSourceURL (WCharCP srcFileURL)
 *------------------------------------------------------------------------------—**//** More...
 
- Public Member Functions inherited from RefCounted< IRefCounted >
void * operator new (size_t size)
 
void operator delete (void *rawMemory, size_t size)
 
UInt32 AddRef () const
 
UInt32 Release () const
 
 RefCounted ()
 
 RefCounted (RefCounted const &rhs)
 
RefCountedoperator= (RefCounted const &rhs)
 
UInt32 GetRefCount () const
 

Static Public Member Functions

static DGNPLATFORM_EXPORT
ProvenanceManagerPtr 
Create (DgnFileR fileR, bool isReadOnly=true, bool readEmbeddedfiles=false)
 Create an instance of ProvenanceManager. More...
 
static DGNPLATFORM_EXPORT
ProvenanceManagerPtr 
Create (WString fileName, bool isReadOnly=true, bool readEmbeddedfiles=false)
 Create an instance of ProvenanceManager. More...
 

Additional Inherited Members

- Protected Member Functions inherited from RefCounted< IRefCounted >
virtual ~RefCounted ()
 
- Protected Member Functions inherited from IRefCounted
virtual ~IRefCounted ()
 
void * operator new (size_t size)
 
void operator delete (void *rawMemory, size_t size)
 

Detailed Description

The Provenance Manager allows to write provenance to an i-model and read it back.


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

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