DgnLinks.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
9 
10 #include <ECObjects/ECObjectsAPI.h>
11 #include <DgnPlatform/DgnCoreAPI.h>
12 #include <DgnPlatform/ECQuery.h>
13 #include <DgnPlatform/DgnEcInstance.h>
14 #include <Bentley/WString.h>
15 #include "DgnLinkTree.h"
16 #include "DgnECInstance.h"
17 #include "ECQuery.h"
18 #include "DgnECFinders.h"
19 #include <Bentley\BeTextFile.h>
20 
21 DGNPLATFORM_TYPEDEFS(DgnLink)
22 DGNPLATFORM_TYPEDEFS(DgnLinkTargetSpec)
23 DGNPLATFORM_TYPEDEFS(DgnFileLink)
24 DGNPLATFORM_TYPEDEFS(DgnFolderLink)
25 DGNPLATFORM_TYPEDEFS(DgnModelLink)
26 DGNPLATFORM_TYPEDEFS(LinkAdapter)
27 DGNPLATFORM_TYPEDEFS(LinkBookmarkAdapter)
28 DGNPLATFORM_TYPEDEFS(FileLinkAdapter)
29 DGNPLATFORM_TYPEDEFS(DgnRegionLink)
30 DGNPLATFORM_TYPEDEFS(DgnURLLink)
31 DGNPLATFORM_TYPEDEFS(DgnConfigVarExpressionLink)
32 DGNPLATFORM_TYPEDEFS(DgnLinkSetLink)
33 DGNPLATFORM_TYPEDEFS(DgnLinkStringUserData)
34 DGNPLATFORM_TYPEDEFS(DgnLinkComposition)
35 DGNPLATFORM_TYPEDEFS(DgnLinkFolder)
36 DGNPLATFORM_TYPEDEFS(DgnGenericLink)
37 DGNPLATFORM_TYPEDEFS(DgnLinkFollowLog)
38 DGNPLATFORM_TYPEDEFS(WordHeadingLink)
39 DGNPLATFORM_TYPEDEFS(WordBookmarkLink)
40 DGNPLATFORM_TYPEDEFS(WordHeadingInfo)
41 DGNPLATFORM_TYPEDEFS(ExcelSheetLink)
42 DGNPLATFORM_TYPEDEFS(PDFRegionLink)
43 
44 BEGIN_BENTLEY_DGNPLATFORM_NAMESPACE
45 
46 typedef RefCountedPtr<DgnLinkTargetSpec> DgnLinkTargetSpecPtr;
47 typedef RefCountedPtr<FileLinkAdapter> FileLinkAdapterPtr;
48 typedef RefCountedPtr<LinkAdapter> LinkAdapterPtr;
49 typedef RefCountedPtr<LinkBookmarkAdapter> LinkBookmarkAdapterPtr;
50 typedef RefCountedPtr<DgnLinkStringUserData> DgnLinkStringUserDataPtr;
51 typedef RefCountedPtr<DgnLinkFollowLog> DgnLinkFollowLogPtr;
52 typedef RefCountedPtr<DgnRegionLink> DgnRegionLinkPtr;
53 
55 typedef TempObjectOwner<DgnLink> TempDgnLinkOwner;
56 
57 typedef bvector<DgnLinkTargetSpecPtr> DgnLinkTargetSpecList;
58 typedef bvector<DgnLinkTreeSpecPtr> DgnLinkTreeSpecList;
59 typedef bvector<DgnLinkP> DgnLinkList;
60 
61 struct DgnFileLinkHandler;
62 struct DgnModelLinkHandler;
63 struct DgnRegionLinkHandler;
64 struct DgnFolderLinkHandler;
65 struct DgnGenericLinkHandler;
66 struct DgnURLLinkHandler;
67 struct DgnConfigVarExpressionLinkHandler;
68 struct DgnLinkSetLinkHandler;
69 struct WordBookmarkLinkHandler;
70 struct WordHeadingLinkHandler;
71 struct ExcelSheetLinkHandler;
72 struct PDFRegionLinkHandler;
73 struct DgnLinkUserDataHandler;
74 
75 
76 struct DgnModelLink;
77 struct DgnRegionLink;
78 
79 /*=================================================================================**/
84 struct DgnLinkECInstanceAdapter
85  {
86 private:
87  virtual void MakeClassAbstract() = 0;
88 public:
89  public:
92  DGNPLATFORM_EXPORT StatusInt FromECInstance (ECN::IECInstanceCR, DgnLinkTreeSpecCR);
93 
96  DGNPLATFORM_EXPORT ECN::IECInstancePtr ToECInstance ();
97 
98  };
99 
100 /*=================================================================================**/
105 struct DgnLinkTargetSpec : RefCountedBase
106  {
107 public:
110  DGNPLATFORM_EXPORT WCharCP GetAncestryKey () const;
113  DGNPLATFORM_EXPORT WCharCP GetTypeString () const;
116  DGNPLATFORM_EXPORT WCharCP GetNameString () const;
119  DGNPLATFORM_EXPORT WCharCP GetLocationString () const;
120 
124  DGNPLATFORM_EXPORT int Compare (DgnLinkTargetSpecCR targetSpec);
125 
132  DGNPLATFORM_EXPORT static DgnLinkTargetSpecPtr Create (WCharCP ancestryKey, WCharCP targetType, WCharCP targetName, WCharCP targetLocation);
133  };
134 
135 /*=================================================================================**/
140 struct DgnLinkFollowLog : public NonCopyableClass, public RefCountedBase
141  {
142 public:
144  DgnLinkFollowLog () {}
146  virtual ~DgnLinkFollowLog () {}
149  DGNPLATFORM_EXPORT WCharCP GetErrorString () const;
150 
152  DGNPLATFORM_EXPORT void SetErrorString (WCharCP);
153 
156  DGNPLATFORM_EXPORT WCharCP GetLogString () const;
157 
159  DGNPLATFORM_EXPORT void AppendToLogString (WCharCP);
160  };
161 
162 /*=================================================================================**/
167 struct DgnLink
168  {
169 private:
170  DGNPLATFORM_EXPORT bool HasTempOwner() const;
171  DGNPLATFORM_EXPORT void SetTempOwner (TempDgnLinkOwner* owner);
172  DGNPLATFORM_EXPORT void ReleaseTempOwner (TempDgnLinkOwner* owner);
173 protected:
174  virtual ~DgnLink ();
175 private:
176  virtual void MakeClassAbstract() = 0;
177 public:
178 public:
183  DGNPLATFORM_EXPORT TempDgnLinkOwner Copy (DgnLinkTreeLeafP leaf, DgnLinkTreeSpecCR dest) const;
186  DGNPLATFORM_EXPORT DgnLinkTreeLeafCP GetTreeNodeCP () const;
189  DGNPLATFORM_EXPORT DgnLinkTreeLeafP GetTreeNodeP ();
193  DGNPLATFORM_EXPORT bool IsTargetValid (DgnLinkValidationCenterP logger) const;
197  DGNPLATFORM_EXPORT bool IsTargetFullyQualified (WStringR reason) const;
200  DGNPLATFORM_EXPORT WString GetShortDescription () const;
203  DGNPLATFORM_EXPORT DgnLinkTargetSpecPtr GetTargetSpec () const;
205  DGNPLATFORM_EXPORT void GetTargetAncestry (DgnLinkTargetSpecList&) const;
210  DGNPLATFORM_EXPORT WString BuildSuggestedName (DgnLinkTreeBranchCP contextParent, bool fullContext) const;
214  DGNPLATFORM_EXPORT bool HasSameTarget (DgnLinkCR anotherLink) const;
224  DGNPLATFORM_EXPORT bool GetECTarget (FindInstancesScopePtr& scope, ECQueryPtr& query, WCharCP ancestorKey, DgnECInstanceCreateOptionsCR options) const;
225 
228  DGNPLATFORM_EXPORT DgnLinkBookmarkProvider const* GetBookmarkProvider () const;
229  }; // DgnLink
230 
231 /*=================================================================================**/
236 struct DgnLinkSet : public RefCountedBase
237  {
238 private:
239  virtual void MakeClassAbstract() = 0;
240 public:
241 public:
243  DGNPLATFORM_EXPORT DgnLinkSetPtr Copy (DgnLinkTreeBranchP) const;
244 
247  DGNPLATFORM_EXPORT DgnLinkTreeBranchCP GetTreeNodeCP () const;
248 
251  DGNPLATFORM_EXPORT DgnLinkTreeBranchP GetTreeNodeP ();
252 
254  DGNPLATFORM_EXPORT void GetInvalidChildCount (DgnLinkValidationCenterR) const;
255  }; // DgnLinkSet
256 
257 /*=================================================================================**/
262 struct DgnLinkUserData : public RefCountedBase
263  {
264 private:
265  virtual void MakeClassAbstract() = 0;
266 public:
267 public:
270  DGNPLATFORM_EXPORT DgnLinkUserDataPtr Copy () const;
273  DGNPLATFORM_EXPORT UInt32 GetAppID () const;
276  DGNPLATFORM_EXPORT UInt32 GetSubID () const;
278  DGNPLATFORM_EXPORT bool IsPersistent () const;
279  }; //DgnLinkUserData
280 
281 /*=================================================================================**/
286 struct DgnLinkBookmarkProvider
287  {
288 private:
289  virtual void MakeClassAbstract() = 0;
290 public:
291 public:
294  DGNPLATFORM_EXPORT DgnLinkTreePtr LoadBookmarkTree () ;
295  }; // DgnLinkBookmarkProvider
296 
297 
298 // Various link classes
299 /*=================================================================================**/
310 struct DgnGenericLink : public DgnLink
311  {
312  friend struct DgnGenericLinkHandler;
313 private:
314  virtual void MakeClassAbstract() = 0;
315 public:
316 public:
318  //@returns the status of function in terms of true/false
319  DGNPLATFORM_EXPORT bool IsFileBasedLink () const;
322  DGNPLATFORM_EXPORT DgnDocumentMonikerCR GetMoniker () const;
325  DGNPLATFORM_EXPORT DgnDocumentMonikerPtr GetMonikerPtr () const;
329  DGNPLATFORM_EXPORT void SetMoniker(DgnDocumentMonikerR moniker, bool createRelativePath = true);
330  };
331 
332 /*=================================================================================**/
337 struct DgnFileLink : public DgnLink
338  {
339 private:
340  virtual void MakeClassAbstract() = 0;
341 public:
342 public:
343 
344  // DgnFileLink internal methods
348  DGNPLATFORM_EXPORT void SetMoniker(DgnDocumentMonikerP moniker, bool createRelativePath = true);
351  DGNPLATFORM_EXPORT DgnDocumentMonikerCR GetMoniker () const;
354  DGNPLATFORM_EXPORT DgnDocumentMonikerPtr GetMonikerPtr () const;
355 
356  };
357 
358 
359 /*=================================================================================**/
364 struct DgnFolderLink : public DgnLink
365  {
366 private:
367  virtual void MakeClassAbstract() = 0;
368 public:
369 public:
372  DGNPLATFORM_EXPORT void SetMoniker(DgnFolderMonikerR folderMoniker);
375  DGNPLATFORM_EXPORT DgnFolderMonikerCR GetMoniker () const;
378  DGNPLATFORM_EXPORT DgnFolderMonikerPtr GetMonikerPtr () const;
379  };
380 
381 /*=================================================================================**/
397 struct DgnLinkComposition : public DgnLink
398  {
399 private:
400  virtual void MakeClassAbstract() = 0;
401 public:
402 public:
403  };
404 struct DgnModelLink : public DgnLinkComposition
405  {
406 private:
407  virtual void MakeClassAbstract() = 0;
408 public:
409 public:
412  DGNPLATFORM_EXPORT void SetModelName (WCharCP modelName);
415  DGNPLATFORM_EXPORT WString GetModelName () const;
418  DGNPLATFORM_EXPORT DgnModelType GetModelType (StatusInt &status) const;
420  DGNPLATFORM_EXPORT void SetModelType (DgnModelType);
421 
425  DGNPLATFORM_EXPORT int GetMarkupModel (StatusInt &status) const;
428  DGNPLATFORM_EXPORT void SetMarkupModel (int isMarkup);
429 
432  DGNPLATFORM_EXPORT DgnFileLinkCP GetFileLinkCP () const;
435  DGNPLATFORM_EXPORT DgnFileLinkP GetFileLinkP ();
439  DGNPLATFORM_EXPORT StatusInt SetFileLink (DgnFileLinkP fileLink);
440 
441  };
442 
443 /*=================================================================================**/
449 struct DgnRegionLink : public DgnLinkComposition
450  {
451 private:
452  virtual void MakeClassAbstract() = 0;
453 public:
454 public:
458  DGNPLATFORM_EXPORT void SetTarget (WCharCP targetType, WCharCP targetName);
461  DGNPLATFORM_EXPORT void SetTargetSubType (WString targetSubType);
462 
465  DGNPLATFORM_EXPORT WString GetTargetName () const;
468  DGNPLATFORM_EXPORT WString GetTargetType () const;
471  DGNPLATFORM_EXPORT WString GetTargetSubType () const;
472 
475  DGNPLATFORM_EXPORT DgnModelLinkCP GetModelLinkCP () const;
478  DGNPLATFORM_EXPORT DgnModelLinkP GetModelLinkP ();
479  // ! sets the model link in the region link
481  DGNPLATFORM_EXPORT StatusInt SetModelLink (DgnModelLinkP model);
484  DGNPLATFORM_EXPORT DgnFileLinkCP GetFileLinkCP () const;
487  DGNPLATFORM_EXPORT DgnFileLinkP GetFileLinkP ();
488 
489  };
490 
491 /*=================================================================================**/
497 struct DgnURLLink : public DgnLink
498  {
499 public:
501  enum Schema
502  {
503  SCHEMA_unrecognized = -1,
504  SCHEMA_http,
505  SCHEMA_https,
506  SCHEMA_ftp,
507  SCHEMA_mailto,
508  SCHEMA_MSTN_keyin,
509  SCHEMA_file
510  };
511 
512 private:
513  virtual void MakeClassAbstract() = 0;
514 public:
515 public:
519  DGNPLATFORM_EXPORT bool SetAddress (WCharCP urlAddress);
522  DGNPLATFORM_EXPORT WCharCP GetAddress () const;
525  DGNPLATFORM_EXPORT Schema GetSchema () const;
526  };
527 
528 /*=================================================================================**/
533 struct DgnConfigVarExpressionLink : public DgnLink
534  {
535 public:
538  DGNPLATFORM_EXPORT void SetExpression (WCharCP configVarExpression);
541  DGNPLATFORM_EXPORT WCharCP GetExpression () const;
542 
545  DGNPLATFORM_EXPORT void SetFilter (WCharCP filterExpression);
546 
549  DGNPLATFORM_EXPORT WCharCP GetFilter () const;
550 
552  DGNPLATFORM_EXPORT void GetExpressionValue (WString &) const;
553 
554  DGNPLATFORM_EXPORT void SetFileFilter (WString fileFilter);
555 
556  DGNPLATFORM_EXPORT WCharCP GetFileFilter () const;
557 
558  DGNPLATFORM_EXPORT void SetProcessSubDirectories (bool process);
559 
560  DGNPLATFORM_EXPORT bool GetProcessSubDirectories () const;
561 
562  };
563 
564 /*=================================================================================**/
570 struct HarvestingLogger
571  {
572  bool m_executeQueryStatus;
573  Bentley::BeTextFilePtr m_logFile;
574  bvector<WString> m_loggerStorage;
575 
576 public:
577  enum class HarvestingLoggerValues
578  {
579  None = 0,
580  IndexerBasedHarevest = 1,
581  uStationBasedHarevest = 2
582  };
583 
584  DGNPLATFORM_EXPORT HarvestingLogger();
585  DGNPLATFORM_EXPORT ~HarvestingLogger();
586 
587  //Get the harvesting strategy [index based or microstation based]
588  DGNPLATFORM_EXPORT HarvestingLoggerValues GetStrategy();
589 
590  //Get the harvesting strategy [index based or microstation based]
591  DGNPLATFORM_EXPORT void SetStrategy(HarvestingLoggerValues strategy);
592 
593  //this function stores messages in form of strings
594  DGNPLATFORM_EXPORT void SetLogMessage(WString logMsg);
595 
596  DGNPLATFORM_EXPORT bvector<WString>& GetLogMessage();
597 
598  DGNPLATFORM_EXPORT void LoggerStorageClear();
599 
600  //we are setting Execute query status so that while iterating btween the files we want to get message only once
601  DGNPLATFORM_EXPORT bool GetExecuteQueryStatus();
602  DGNPLATFORM_EXPORT void SetExecuteQueryStatus(bool status);
603 
604  Bentley::BeTextFilePtr GetLogFile ();
605  void Clear ();
606  void Init ();
607  void FlushLog ();
608  bool WriteToHarvestingLoggerFile(bvector<WString> loggerStorage);
609 private:
610  HarvestingLoggerValues m_strategyBehaviour; //it contains value indicating which strategy which are using
611  };
612 
613 /*=================================================================================**/
618 struct DgnLinkSetLink : public DgnLinkComposition
619  {
620 private:
621  virtual void MakeClassAbstract() = 0;
622 public:
623 public:
626  DGNPLATFORM_EXPORT void SetLinkSetPath (WCharCP linksetPath);
627 
630  DGNPLATFORM_EXPORT WCharCP GetLinkSetPath () const;
631 
634  DGNPLATFORM_EXPORT void SetLinkSetName (WCharCP linkSetName);
635 
637  DGNPLATFORM_EXPORT WCharCP GetLinkSetName () const;
638 
641  DGNPLATFORM_EXPORT void SetLinkTreeKey (DgnLinkTreeKey treeKey);
642 
645  DGNPLATFORM_EXPORT DgnLinkTreeKey GetLinkTreeKey () const;
646 
649  DGNPLATFORM_EXPORT DgnFileLinkCP GetFileLinkCP () const;
650 
653  DGNPLATFORM_EXPORT DgnFileLinkP GetFileLinkP ();
654 
658  DGNPLATFORM_EXPORT StatusInt SetFileLink (DgnFileLinkP fileLink);
659  };
660 
661 struct WordHeadingInfo : RefCountedBase
662  {
663  };
664 
665 typedef RefCountedPtr<WordHeadingInfo> WordHeadingInfoPtr;
666 
668 enum class WordRegionType
669  {
670  Invalid = 0,
671  Bookmark = 1,
672  Heading = 2
673  };
674 
675 /*=================================================================================**/
680 struct WordHeadingLink : public DgnPlatform::DgnLinkComposition
681 {
682 public:
685  DGNPLATFORM_EXPORT DgnFileLinkCP GetFileLinkCP () const;
686 
689  DGNPLATFORM_EXPORT DgnFileLinkP GetFileLinkP ();
690 
697  DGNPLATFORM_EXPORT void SetData (WCharCP title, WCharCP style, int sequenceNumber, WordHeadingLinkP parentLink, DgnFileLinkP wordFileLink);
698 
701  DGNPLATFORM_EXPORT void SetBranch (DgnLinkTreeBranchP branch);
702 
705  DGNPLATFORM_EXPORT DgnLinkTreePtr PeekBookmarkTree ();
706 
709  DGNPLATFORM_EXPORT WordRegionType GetTargetType () const;
710 
715  DGNPLATFORM_EXPORT bool SetTarget (WordRegionType regionType, WCharCP headingName, int sequenceNumber);
716 
719  DGNPLATFORM_EXPORT bool SetHeadingInfo (bvector<WordHeadingInfoPtr>& info);
720 
723  DGNPLATFORM_EXPORT bvector<WordHeadingInfoPtr> const& HeadingInfo () const;
724 
727  DGNPLATFORM_EXPORT bvector<WordHeadingInfoPtr>& HeadingInfoR ();
728 
731  DGNPLATFORM_EXPORT WString GetTitle () const;
732 
735  DGNPLATFORM_EXPORT WString GetTargetName () const;
736 
739  DGNPLATFORM_EXPORT WString GetStyle () const;
740 
743  DGNPLATFORM_EXPORT int GetMatch () const;
744 };
745 
746 /*=================================================================================**/
751 struct WordBookmarkLink : public DgnPlatform::DgnLinkComposition
752 {
753 private:
754  virtual void MakeClassAbstract() = 0;
755 public:
756 public:
759  DGNPLATFORM_EXPORT DgnFileLinkCP GetFileLinkCP () const;
762  DGNPLATFORM_EXPORT DgnFileLinkP GetFileLinkP ();
765  DGNPLATFORM_EXPORT WordRegionType GetTargetType () const;
770  DGNPLATFORM_EXPORT bool SetTarget (WordRegionType regionType, WCharCP name, int sequenceNumber);
773  DGNPLATFORM_EXPORT WString GetTitle () const;
776  DGNPLATFORM_EXPORT WString GetTargetName () const;
779  DGNPLATFORM_EXPORT WString GetStyle () const;
782  DGNPLATFORM_EXPORT int GetMatch () const;
783 };
784 
785 /*=================================================================================**/
790 struct ExcelSheetLink : public DgnPlatform::DgnLinkComposition
791 {
792 private:
793  virtual void MakeClassAbstract() = 0;
794 public:
795 public:
798  DGNPLATFORM_EXPORT DgnFileLinkCP GetFileLinkCP () const;
801  DGNPLATFORM_EXPORT DgnFileLinkP GetFileLinkP ();
804  DGNPLATFORM_EXPORT WString GetSheetName () const;
807  DGNPLATFORM_EXPORT void SetSheetName (WCharCP name);
808 };
809 
811 enum class PDFRegionType
812  {
813  Invalid = 0,
814  Bookmark = 1,
815  };
816 
817 /*=================================================================================**
818  * This class represents the information about PDF bookmark. It
819  * contains two fields: title, and the sequence number (denoting the duplicate
820  * bookmark).
821  * @remark Required library : DgnPlatform<ApiNumber>.lib i.e. DgnPlatform5.lib
822  * @bsiclass Bentley Systems
823 
824  +===============+===============+===============+===============+===============+======*/
825 struct PDFRegionInfo : RefCountedBase
826  {
827  };
828 
829 typedef RefCountedPtr<PDFRegionInfo> PDFRegionInfoPtr;
830 
831 /*=================================================================================**/
838 struct PDFRegionLink : public DgnPlatform::DgnLinkComposition
839 {
840 public:
843  DGNPLATFORM_EXPORT DgnFileLinkCP GetFileLinkCP () const;
846  DGNPLATFORM_EXPORT DgnFileLinkP GetFileLinkP ();
852  DGNPLATFORM_EXPORT void SetData (WCharCP title, int sequenceNumber, PDFRegionLinkP parentLink, DgnFileLinkP pdfFileLink);
855  DGNPLATFORM_EXPORT void SetBranch (DgnLinkTreeBranchP branch);
858  DGNPLATFORM_EXPORT DgnLinkTreePtr PeekBookmarkTree ();
863  DGNPLATFORM_EXPORT bool SetTarget (PDFRegionType regionType, WCharCP name, int sequenceNumber);
866  DGNPLATFORM_EXPORT bool SetHeadingInfo (bvector<PDFRegionInfoPtr>& info);
867 
870  DGNPLATFORM_EXPORT bvector<PDFRegionInfoPtr> HeadingInfo ();
871 
874  DGNPLATFORM_EXPORT bvector<PDFRegionInfoPtr>& HeadingInfoR ();
877  DGNPLATFORM_EXPORT WString GetTitle () const;
880  DGNPLATFORM_EXPORT WString GetTargetName () const;
883  DGNPLATFORM_EXPORT int GetMatch () const;
884 
885 }; // PDFRegionLink
886 #define DESIGNLINKS_USERDATA_APPID_String 22261
887 
888 /*=================================================================================**/
894 struct DgnLinkStringUserData : public DgnLinkUserData
895  {
896 
897 public:
900  DGNPLATFORM_EXPORT void SetString (WCharCP newValue);
903  DGNPLATFORM_EXPORT WString GetString () const;
904 
909  DGNPLATFORM_EXPORT static DgnLinkStringUserDataPtr Create (UInt32 subID, WCharCP value);
910  };
911 
912 END_BENTLEY_DGNPLATFORM_NAMESPACE
Bentley::DgnDocumentMonikerCR
struct DgnPlatform::DgnDocumentMoniker const & DgnDocumentMonikerCR
Definition: DgnPlatform.h:197
Bentley::DgnPlatform::DgnLinkStringUserData
This class can be used to represents the user string data.
Definition: DgnLinks.h:894
Bentley::DgnECInstanceCreateOptionsCR
struct DgnPlatform::DgnECInstanceCreateOptions const & DgnECInstanceCreateOptionsCR
Definition: DgnPlatform.h:539
Bentley::DgnPlatform::DgnLinkUserDataHandler
Definition: DgnLinkHandler.h:96
Bentley::DgnPlatform::DgnLinkSet
Class to define the link sets in DgnFile.
Definition: DgnLinks.h:236
END_BENTLEY_DGNPLATFORM_NAMESPACE
#define END_BENTLEY_DGNPLATFORM_NAMESPACE
Definition: DgnPlatformBaseType.r.h:69
Bentley::DgnFileLinkCP
struct DgnPlatform::DgnFileLink const * DgnFileLinkCP
Definition: DgnLinks.h:23
Bentley::DgnPlatform::PDFRegionInfoPtr
RefCountedPtr< PDFRegionInfo > PDFRegionInfoPtr
Definition: DgnLinks.h:829
Bentley::DgnPlatform::DgnFolderMoniker
A DgnFolderMoniker identifies a folder.
Definition: DgnDocumentManager.h:311
DGNPLATFORM_EXPORT
#define DGNPLATFORM_EXPORT
Definition: DgnPlatform/ExportMacros.h:58
Bentley::WCharCP
wchar_t const * WCharCP
Definition: Bentley.h:224
Bentley::DgnPlatform::DgnLinkFollowLog::~DgnLinkFollowLog
virtual ~DgnLinkFollowLog()
Destructor of class.
Definition: DgnLinks.h:146
Bentley::DgnPlatform::WordRegionType::Heading
If te word region contains a heading link.
Bentley::DgnPlatform::DgnLinkComposition
DgnLinkComposition is an abstract class, which represents composition of link types.
Definition: DgnLinks.h:397
UInt32
uint32_t UInt32
Definition: Bentley.r.h:128
Bentley::DgnLinkCR
struct DgnPlatform::DgnLink const & DgnLinkCR
Definition: DgnLinks.h:21
Bentley::DgnPlatform::HarvestingLogger::m_loggerStorage
bvector< WString > m_loggerStorage
Definition: DgnLinks.h:574
Bentley::DgnFolderMonikerCR
struct DgnPlatform::DgnFolderMoniker const & DgnFolderMonikerCR
Definition: DgnPlatform.h:210
Bentley::DgnPlatform::DgnLinkECInstanceAdapter
An interface thats used for creating an object from ECInstance.
Definition: DgnLinks.h:84
Bentley::DgnModelLinkCP
struct DgnPlatform::DgnModelLink const * DgnModelLinkCP
Definition: DgnLinks.h:25
Bentley::DgnPlatform::DgnModelType
DgnModelType
Identifies the type or purpose of a model.
Definition: DgnPlatform.r.h:367
Bentley::DgnPlatform::DgnDocumentMoniker
A DgnDocumentMoniker identifies a file.
Definition: DgnDocumentManager.h:181
Bentley::DgnPlatform::DgnLinkUserData
Class to define the links user data like AppId etc.
Definition: DgnLinks.h:262
DGNPLATFORM_TYPEDEFS
#define DGNPLATFORM_TYPEDEFS(_name_)
Definition: DgnPlatform.h:73
Bentley::RefCountedPtr
A shared pointer template for reference-counted objects.
Definition: RefCounted.h:119
Bentley::ECN::IECInstanceCR
IECInstance const & IECInstanceCR
Definition: ECObjects.h:67
Bentley::DgnPlatform::WordRegionType::Bookmark
If the word region is bookmarked.
Bentley::NonCopyableClass
Base class to make a class non-copyable.
Definition: NonCopyableClass.h:23
Bentley::DgnPlatform::HarvestingLogger
A class which defines the type of harvesting strategy and behaviour.
Definition: DgnLinks.h:570
Bentley::DgnPlatform::WordRegionType
WordRegionType
Options to specify the type of the Word Region.
Definition: DgnLinks.h:668
Bentley::DgnPlatform::DgnLinkTargetSpec
This class defines the target spec for links.
Definition: DgnLinks.h:105
BEGIN_BENTLEY_DGNPLATFORM_NAMESPACE
#define BEGIN_BENTLEY_DGNPLATFORM_NAMESPACE
Definition: DgnPlatformBaseType.r.h:68
Bentley::DgnLinkTargetSpecCR
struct DgnPlatform::DgnLinkTargetSpec const & DgnLinkTargetSpecCR
Definition: DgnLinks.h:22
Bentley::DgnPlatform::HarvestingLogger::m_logFile
Bentley::BeTextFilePtr m_logFile
Definition: DgnLinks.h:573
Bentley::DgnPlatform::TempObjectOwner
A smart pointer to an object of type T, where the pointee is an object which under ordinary circumsta...
Definition: DgnLinkTree.h:83
Bentley::StatusInt
int StatusInt
Definition: Bentley.h:222
Bentley::RefCountedBase
Concrete class that can be used to implement the reference-counting pattern.
Definition: RefCounted.h:109
Bentley::DgnPlatform::HarvestingLogger::HarvestingLoggerValues
HarvestingLoggerValues
Definition: DgnLinks.h:577
Bentley::DgnPlatform::HarvestingLogger::m_executeQueryStatus
bool m_executeQueryStatus
Definition: DgnLinks.h:572
Bentley::DgnPlatform::DgnLinkList
bvector< DgnLinkP > DgnLinkList
Definition: DgnLinks.h:59
Bentley::DgnPlatform::DgnLinkFollowLog
DgnLinkFollowLog can be used to create log data.
Definition: DgnLinks.h:140
Bentley::DgnPlatform::DgnLinkBookmarkProvider
A link bookmark provider class.
Definition: DgnLinks.h:286
BeTextFile.h
Provides Bentley specific text file read/write functions (Bentley/BeAssert.h).
Bentley::DgnPlatform::DgnLinkFollowLog::DgnLinkFollowLog
DgnLinkFollowLog()
Constructor of class.
Definition: DgnLinks.h:144
Bentley::DgnPlatform::DgnLinkTargetSpecList
bvector< DgnLinkTargetSpecPtr > DgnLinkTargetSpecList
Definition: DgnLinks.h:57
Bentley::DgnPlatform::DgnLinkTreeKey
DgnLinkTreeKey
The DgnLinkTreeKey defines the location at which a link tree can be stored.
Definition: DgnLinkTree.h:416
Bentley::DgnPlatform::BaseDetailingProp::Invalid
Bentley::DgnPlatform::DgnLinkTreeSpecList
bvector< DgnLinkTreeSpecPtr > DgnLinkTreeSpecList
Definition: DgnLinks.h:58
Bentley::DgnPlatform::WordHeadingInfo
Definition: DgnLinks.h:661
Bentley::WString
A string class that has many of the same capabilities as std::string, plus additional functions such ...
Definition: WString.h:51
Bentley::DgnPlatform::PDFRegionInfo
Definition: DgnLinks.h:825
Bentley::DgnPlatform::WordHeadingInfoPtr
RefCountedPtr< WordHeadingInfo > WordHeadingInfoPtr
Definition: DgnLinks.h:665
Bentley::DgnPlatform::PDFRegionType
PDFRegionType
Options to specify the type of the PDF Region.
Definition: DgnLinks.h:811
Copyright © 2017 Bentley Systems, Incorporated. All rights reserved.