IntegrationManager.h

Go to the documentation of this file.

/*--------------------------------------------------------------------------------------+
|
|   Supplied under applicable software license agreement.
|
|   Copyright (c) 2018 Bentley Systems, Incorporated. All rights reserved.
|
+---------------------------------------------------------------------------------------*/
#pragma once

#include <DgnPlatform/DgnDocumentManager.h>
#include <Bentley/bvector.h>

BEGIN_BENTLEY_DGNPLATFORM_NAMESPACE
/*=================================================================================**/
struct DgnPlatformIntegration;
struct DgnPlatformIntegrationList;
struct IntegrationManager;

enum OpenRepositoryStatus
    {
    OPENREPOSITORY_STATUS_Success                   = 0,
    OPENREPOSITORY_STATUS_UnknownError              = 1,
    OPENREPOSITORY_STATUS_InvalidArgument           = 2,
    OPENREPOSITORY_STATUS_UserCanceled              = 3,
    OPENREPOSITORY_STATUS_AccessDenied              = 4,
    };

enum LocateIntegrationStatus
    {
    LOCATEINTEGRATION_STATUS_Found                  = 0,
    LOCATEINTEGRATION_STATUS_NoneRegistered         = 1,
    };

enum LoadIntegrationStatus
    {
    LOADINTEGRATION_STATUS_Success                  = 0,
    LOADINTEGRATION_STATUS_MalformedRegistryKey     = 1,
    LOADINTEGRATION_STATUS_LibraryNotFound          = 2,
    LOADINTEGRATION_STATUS_FailedToInitialize       = 3,
    LOADINTEGRATION_STATUS_RequestedClassNotFound   = 4,
    };

enum IntegratedApplicationType
    {
    APPLICATION_TYPE_Default                        = 0,
    APPLICATION_TYPE_Plugin                         = 1,
    };

 /*=================================================================================**/
struct DgnPlatformIntegration : RefCountedBase
    {
private:
    virtual void MakeClassAbstract() = 0;
public:

public:
    DGNPLATFORM_EXPORT WString                         GetIntegrationKey() const;
    DGNPLATFORM_EXPORT WString                         GetProductName() const;
    DGNPLATFORM_EXPORT WString                         GetVersionString() const;
    DGNPLATFORM_EXPORT WString                         GetPath() const;
    DGNPLATFORM_EXPORT Bentley::DgnPlatform::DgnDocumentManager* GetDocumentManager() const;
    DGNPLATFORM_EXPORT OpenRepositoryStatus            OpenSession (WCharP repositoryName=NULL, long respositoryNameLength=0,
                                                                WCharCP userName=NULL, WCharCP password=NULL, bool useSingleSignOn=true,
                                                                bool allowDialogPrompt=true, unsigned long parentWindow=NULL);
    DGNPLATFORM_EXPORT void                            CloseSession (WCharCP repositoryName=NULL);

    DGNPLATFORM_EXPORT OpenRepositoryStatus            ConnectToExistingSession ();

    DGNPLATFORM_EXPORT LoadIntegrationStatus           Initialize(IntegratedApplicationType const appType);

    };

typedef bvector<DgnPlatformIntegrationPtr> T_DgnPlatformIntegrationPtrVec;

 /*=================================================================================**/
struct DgnPlatformIntegrationList : RefCountedBase
    {
    typedef T_DgnPlatformIntegrationPtrVec::const_iterator const_iterator;
    typedef T_DgnPlatformIntegrationPtrVec::iterator iterator;
    typedef T_DgnPlatformIntegrationPtrVec::size_type size_type;

private:
    virtual void MakeClassAbstract() = 0;
public:
public:
    DGNPLATFORM_EXPORT const_iterator begin () const; 
    DGNPLATFORM_EXPORT iterator begin ();

    DGNPLATFORM_EXPORT const_iterator end () const;
    DGNPLATFORM_EXPORT iterator end ();

    DGNPLATFORM_EXPORT size_type size () const;

    DGNPLATFORM_EXPORT void Add (DgnPlatformIntegrationR integration);
    DGNPLATFORM_EXPORT bool Remove (DgnPlatformIntegrationR integration);
    DGNPLATFORM_EXPORT void Clear ();
    DGNPLATFORM_EXPORT DgnPlatformIntegrationPtr At (size_type n);
    } ;

 /*=================================================================================**/
struct IntegrationManager
    {
public:
    DGNPLATFORM_EXPORT DgnPlatformIntegrationListPtr   LocateIntegrations (LocateIntegrationStatus& status);
    };
END_BENTLEY_DGNPLATFORM_NAMESPACE