Public Member Functions | Static Public Member Functions | List of all members
IModelPublisher Struct Referenceabstract

The actual i-model publishing engine through which user can specify the publish and package options and start the publishing and packaging process. More...

#include <IModelPublisher.h>

Inheritance diagram for IModelPublisher:
RefCountedBase RefCounted< IRefCounted > IRefCounted

Public Member Functions

PUBLISHLIB_EXPORT PublishOptionsR GetPublishOptionsR ()
 Gets a reference of the current PublishOptions. More...
 
PUBLISHLIB_EXPORT PackageOptionsR GetPackageOptionsR ()
 Gets a reference of the current PackageOptions. More...
 
PUBLISHLIB_EXPORT DgnDbOptionsR GetDgnDbOptionsR ()
 Gets a reference of the current DgnDbOptions. More...
 
PUBLISHLIB_EXPORT StatusInt Publish ()
 Publishes the file which was specified in IModelPublisher::Create method of IModelPublisher. More...
 
PUBLISHLIB_EXPORT StatusInt PublishAndPackage (DgnDocumentR packageDocument)
 First publishes and then packages all the published i-models created for the master design file (and all its attached references). More...
 
PUBLISHLIB_EXPORT IModelStatus PublishDgnDbIModel (WStringCR packageFileName, DgnDocumentR dotIModelDocument)
 Converts a V8i i-model with .i.dgn extension to the DgnDb i-model (.imodel) format. More...
 
PUBLISHLIB_EXPORT StatusInt EmbedDocumentsInPackage (EmbedDocumentListR documentList)
 Once Package file is create, some additional Documents can be embedded in packaged file. More...
 
PUBLISHLIB_EXPORT StatusInt EmbedDocumentInPackage (WString documentName)
 Once Package file is create, some additional Documents can be embedded in packaged file.This adds document in embeding List of package file. More...
 
PUBLISHLIB_EXPORT bvector
< WString
GetErrorList ()
 If either publish or package operation return ERROR then call this method to get the detail description about the error. More...
 
PUBLISHLIB_EXPORT void SetOverrideProvenanceSourceEvent (OverrideProvenanceSourceEvent fp)
 Sets the callback function for overriding the provenance source in the i-models. More...
 
PUBLISHLIB_EXPORT void SetOverrideProvenanceTargetEvent (OverrideProvenanceTargetEvent fp)
 Sets the callback function for overriding the provenance target in the i-models. More...
 
PUBLISHLIB_EXPORT void SetOnErrorCallbackEvent (OnErrorCallbackEvent fp)
 Sets the callback function for reporting errors during a publish or package operation. More...
 
PUBLISHLIB_EXPORT void SetAddProvenanceConfigMetaDataCallback (AddProvenanceConfigMetaDataCallback fp)
 Sets the callback function for adding configuration information in provenance for published and packaged files This will be helpful when user want to supply some additional provenance information, which is required to be ava in published and packaged files. 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 PUBLISHLIB_EXPORT
IModelPublisherPtr 
Create (DgnDocumentCR dgnDocument, IIModelPublishingProviderR providerInstance)
 Creates an instance of IModelPublisher that you can use to publish and package an i-model. 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 actual i-model publishing engine through which user can specify the publish and package options and start the publishing and packaging process.

Remarks
Required library : publish<ApiNumber>.lib i.e. publish1.lib

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

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