IModelPublisher.h
Go to the documentation of this file.
1 /*--------------------------------------------------------------------------------------+
2 |
3 | Supplied under applicable software license agreement.
4 |
5 | Copyright (c) 2018 Bentley Systems, Incorporated. All rights reserved.
6 |
7 +---------------------------------------------------------------------------------------*/
8 #pragma once
11 
12 
13 
14 #define BEGIN_BENTLEY_DGNIMODEL_NAMESPACE namespace Bentley { namespace DgnIModel {
15 #define END_BENTLEY_DGNIMODEL_NAMESPACE }}
16 
18 /*=================================================================================**/
33 /*=================================================================================**/
165 typedef IModelPublisher const& IModelPublisherCR;
169 /*=================================================================================**/
177  {
178 private:
179  virtual void MakeClassAbstract() = 0;
180 public:
181 
184  PUBLISHLIB_EXPORT PublishOptionsR GetPublishOptionsR();
185 
188  PUBLISHLIB_EXPORT PackageOptionsR GetPackageOptionsR();
189 
192  PUBLISHLIB_EXPORT DgnDbOptionsR GetDgnDbOptionsR();
193 
198  PUBLISHLIB_EXPORT static IModelPublisherPtr Create (DgnDocumentCR dgnDocument, IIModelPublishingProviderR providerInstance);
199 
205  PUBLISHLIB_EXPORT StatusInt Publish ();
206 
216  PUBLISHLIB_EXPORT StatusInt PublishAndPackage (DgnDocumentR packageDocument);
217 
234  PUBLISHLIB_EXPORT IModelStatus PublishDgnDbIModel(WStringCR packageFileName, DgnDocumentR dotIModelDocument);
235 
239  PUBLISHLIB_EXPORT StatusInt EmbedDocumentsInPackage (EmbedDocumentListR documentList);
240 
244  PUBLISHLIB_EXPORT StatusInt EmbedDocumentInPackage (WString documentName);
245 
248  PUBLISHLIB_EXPORT bvector<WString> GetErrorList ();
249 
272  PUBLISHLIB_EXPORT void SetOverrideProvenanceSourceEvent ( OverrideProvenanceSourceEvent fp );
273 
290  PUBLISHLIB_EXPORT void SetOverrideProvenanceTargetEvent ( OverrideProvenanceTargetEvent fp );
291 
292 
295  PUBLISHLIB_EXPORT void SetOnErrorCallbackEvent ( OnErrorCallbackEvent fp );
313  PUBLISHLIB_EXPORT void SetAddProvenanceConfigMetaDataCallback (AddProvenanceConfigMetaDataCallback fp);
314 
315  };
316 
IModelStatus
Different possible error types that can be used returned by DgnDb publishing.
Definition: IModelPublisherOptions.h:66
EmbedDocumentList & EmbedDocumentListR
Definition: IModelPublisherOptions.h:48
struct DgnPlatform::DgnDocument const & DgnDocumentCR
Definition: DgnPlatform.h:195
A DgnDocument represents a file.
Definition: DgnDocumentManager.h:385
StatusInt(* OverrideProvenanceSourceEvent)(WString &, WCharCP)
A callback for overriding provenance source.
Definition: IModelPublisherOptions.h:319
struct Bentley::WString const & WStringCR
Definition: Bentley.h:239
#define BEGIN_BENTLEY_DGNIMODEL_NAMESPACE
Definition: IModelPublisher.h:14
IModelPublisher * IModelPublisherP
Definition: IModelPublisher.h:167
The actual i-model publishing engine through which user can specify the publish and package options a...
Definition: IModelPublisher.h:176
StatusInt(* OverrideProvenanceTargetEvent)(WString &, WCharCP)
A callback for overriding provenance target.
Definition: IModelPublisherOptions.h:326
IModelPublisher & IModelPublisherR
Definition: IModelPublisher.h:166
Specifies the packaging and protection options to apply to a packaged i-model.
Definition: IModelPublisherOptions.h:81
Specifies the DgnDb options to apply while creating the published i-models.
Definition: IModelPublisherOptions.h:287
A shared pointer template for reference-counted objects.
Definition: RefCounted.h:119
#define END_BENTLEY_DGNIMODEL_NAMESPACE
Definition: IModelPublisher.h:15
IModelPublisher object utilizes some additional and optional interfaces implementation.IIModelPublishingProvider groups all interfaces implementation.
Definition: IModelPublishingProvider.h:104
int StatusInt
Definition: Bentley.h:222
Concrete class that can be used to implement the reference-counting pattern.
Definition: RefCounted.h:109
RefCountedPtr< IModelPublisher > IModelPublisherPtr
Definition: IModelPublisher.h:168
#define PUBLISHLIB_EXPORT
Definition: IModelPublisherOptions.h:13
StatusInt(* AddProvenanceConfigMetaDataCallback)(WString &)
Definition: IModelPublisherOptions.h:344
void(* OnErrorCallbackEvent)(WCharCP)
A callback for reporting errors during a publish or package operation.
Definition: IModelPublisherOptions.h:333
Specifies the publishing options to apply while creating the published i-models.
Definition: IModelPublisherOptions.h:216
A string class that has many of the same capabilities as std::string, plus additional functions such ...
Definition: WString.h:51
IModelPublisher const & IModelPublisherCR
Definition: IModelPublisher.h:164

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