DgnLinkHandler.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  "DgnLinks.h"

DGNPLATFORM_TYPEDEFS(DgnLinkUserDataHandler)

BEGIN_BENTLEY_DGNPLATFORM_NAMESPACE

typedef bvector<DgnLinkUserDataHandlerP> DgnLinkUserDataHandlerList;

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

public:
    DGNPLATFORM_EXPORT ECN::ECSchemaP                  GetSchema (DgnFileP dgnFile = NULL);
    DGNPLATFORM_EXPORT ECN::StandaloneECInstancePtr    CreateECInstance (WCharCP ecClassName);
    };

/*=================================================================================**/
struct DgnLinkHandler : public DgnLinkSchemaProvider
    {
public:
    DGNPLATFORM_EXPORT bool                CanHandleKey (WCharCP key) const;

    DGNPLATFORM_EXPORT WCharCP             GetKey (DgnLinkTreeLeafCP leaf) const;

    DGNPLATFORM_EXPORT TempDgnLinkOwner    CreateLink (DgnLinkTreeLeafP leaf, WCharCP key = NULL);
    };

/*=================================================================================**/
struct  DgnLinkSetHandler : public DgnLinkSchemaProvider
    {

public:
    DGNPLATFORM_EXPORT bool           CanHandleKey (WCharCP key) const;

    DGNPLATFORM_EXPORT WString        GetKey (DgnLinkTreeBranchCP branch) const;

    DGNPLATFORM_EXPORT DgnLinkSetPtr  CreateLinkSet (DgnLinkTreeBranchP branch) const;
    };

/*=================================================================================**/
struct DgnLinkUserDataHandler : public DgnLinkSchemaProvider
    {

public:
    bool                CanHandle (UInt32 appID, UInt32 subID);

    DgnLinkUserDataPtr  CreateUserData (UInt32 appID, UInt32 subID);
    };


END_BENTLEY_DGNPLATFORM_NAMESPACE