DgnHost.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.h"

BEGIN_BENTLEY_DGNPLATFORM_NAMESPACE

//=======================================================================================
// A DgnHost is an object that uniquely identifies a usage of the DgnPlatform libraries for a single purpose. 
// For a given process, there can be more than one DgnHost, but each DgnHost must be on a different thread.
// DgnHost holds a collection of key/pointer pairs that are used to store and retrieve host-based data.
// @bsiclass                                                     Bentley Systems
//=======================================================================================
CLRPUBLIC struct DgnHost : NonCopyableClass
    {
public:
    struct Key
        {
        friend struct DgnHost;
        private:
            size_t m_key;
        public:
            Key() {m_key=0;}
        };

    struct IHostObject : NonCopyableClass
        {
    protected:
        virtual ~IHostObject(){}
        virtual void _OnHostTermination (bool isProgramExit) = 0;
    public:
        void OnHostTermination (bool isProgramExit) {_OnHostTermination(isProgramExit);}
        };

    struct HostObjectBase : IHostObject {virtual void _OnHostTermination (bool) override {delete this;}};

    template<typename T>
    struct HostValue : HostObjectBase
        {
        private:
        T   m_value;
        public:
        HostValue (T const& v) : m_value (v) {;}
        T const& GetValue () const {return m_value;}
        T&       GetValue () {return m_value;}
        void     SetValue (T const& v) {m_value = v;}
        };

public:

    DGNPLATFORM_EXPORT void* GetHostVariable (Key& key);

    DGNPLATFORM_EXPORT void  SetHostVariable (Key& key, void* val);

    template <typename INT_TYPE>
    INT_TYPE  GetHostIntVariable (Key& key) {return (INT_TYPE)(intptr_t)GetHostVariable (key);}

    template <typename INT_TYPE>
    void SetHostIntVariable (Key& key, INT_TYPE val) {SetHostVariable (key, (void*)(intptr_t)val);}

    bool  GetHostBoolVariable (Key& key) {return 0 != (intptr_t)GetHostVariable (key);}

    void SetHostBoolVariable (Key& key, bool val) {SetHostVariable (key, (void*)(intptr_t)val);}

    DGNPLATFORM_EXPORT IHostObject* GetHostObject (Key& key);

    DGNPLATFORM_EXPORT void  SetHostObject (Key& key, IHostObject* val);
    };

/*=================================================================================**/
struct          DgnHostWString : DgnHost::IHostObject
{
private:
    WString m_string;
    virtual void _OnHostTermination (bool isProgramExit) override {delete this;}

public:
    DgnHostWString (wchar_t const* s) : m_string(s) {;}
    DgnHostWString (WString const& ws) : m_string(ws) {;}
    
    WString&        GetWString ()       {return m_string;}
    WString const&  GetWString () const {return m_string;}
};


END_BENTLEY_DGNPLATFORM_NAMESPACE