DgnECInstance.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

#pragma managed(push, off)

#include "DgnPlatform.h"
#include <DgnPlatform/LevelCache.h>
#include <ECObjects/ECObjectsAPI.h>
#include <DgnPlatform/DgnModelRef.h>
#include <DgnPlatform/DgnCore.h>
#include <DgnPlatform/ElementHandle.h>
#include <DgnPlatform/DgnLinkTree.h>

BEGIN_BENTLEY_DGNPLATFORM_NAMESPACE

#if 1 // defined (NOT_VS2012_COMPATIBLE_FOR_DOTNET_INTEROP)
typedef RefCountedPtr<DgnPlatform::FindInstancesScope>                  FindInstancesScopePtr;
#else
struct FindInstancesScopePtr : public RefCountedPtr <DgnPlatform::FindInstancesScope>    
    {
    FindInstancesScopePtr() : RefCountedPtr<DgnPlatform::FindInstancesScope>() {}
    FindInstancesScopePtr(DgnPlatform::FindInstancesScope*p, bool add_ref=true) : RefCountedPtr<DgnPlatform::FindInstancesScope>(p, add_ref) {}
    };
#endif

typedef ECN::IInstanceCollectionAdapter<DgnECInstanceP const>                       IDgnECInstanceCollectionAdapter;
typedef RefCountedPtr<IDgnECInstanceCollectionAdapter>                              IDgnECInstanceCollectionAdapterPtr;
typedef ECN::IInstanceCollectionIteratorAdapter<DgnECInstanceP const>               IDgnECInstanceCollectionIteratorAdapter;
typedef ECN::IInstanceCollectionAdapter<IDgnECRelationshipInstanceP const>          IDgnECRelationshipCollectionAdapter;
typedef RefCountedPtr<IDgnECRelationshipCollectionAdapter>                          IDgnECRelationshipCollectionAdapterPtr;
typedef ECN::IInstanceCollectionIteratorAdapter<IDgnECRelationshipInstanceP const>  IDgnECRelationshipCollectionIteratorAdapter;

struct DgnElementECInstance;



enum DgnECInstanceStatus
    {
    DGNECINSTANCESTATUS_Success                              = SUCCESS, 
    DGNECINSTANCESTATUS_InstanceIsStale                      = 1,       
    DGNECINSTANCESTATUS_InstanceIsDeletedOrUndone            = 2,       
    DGNECINSTANCESTATUS_InvalidElementRef                    = 3,       
    DGNECINSTANCESTATUS_InstanceIsAlreadyAsleep              = 4,       
    DGNECINSTANCESTATUS_IncompatibleWipInstance              = 5,       
    DGNECINSTANCESTATUS_UnableToAddInstance                  = 6,       
    DGNECINSTANCESTATUS_NoInstanceFound                      = 7,       
    DGNECINSTANCESTATUS_InvalidInstance                      = 8,       
    DGNECINSTANCESTATUS_UnableToUpdateInstance               = 9,       
    DGNECINSTANCESTATUS_XAttributeHasBeenRemoved             = 10,      
    DGNECINSTANCESTATUS_ClassLayoutNotStored                 = 11,      
    DGNECINSTANCESTATUS_RelationshipInstanceNotCreated       = 12,      
    DGNECINSTANCESTATUS_EnablerNotValidForFile               = 13,      
    DGNECINSTANCESTATUS_DuplicateRelationshipFound           = 14,      
    DGNECINSTANCESTATUS_RequiresSingleEndedRelationshipClass = 15,      
    DGNECINSTANCESTATUS_PropertyNotFound                     = 16,      
    DGNECINSTANCESTATUS_Error                                = ERROR,   
    };                                                 

typedef RefCountedPtr<DgnECInstanceEnabler>             DgnECInstanceEnablerPtr;
typedef RefCountedPtr<DgnElementECInstance>             DgnElementECInstancePtr;
typedef RefCountedPtr<IDgnECRelationshipInstance>       IDgnECRelationshipInstancePtr;
typedef bvector<DgnElementECInstancePtr>                DgnElementECInstanceVector;
typedef bvector<DgnECInstancePtr>                       DgnECInstanceVector;
typedef bvector<IDgnECRelationshipInstancePtr>          IDgnECRelationshipInstanceVector;
typedef bvector<WString>                                T_PropertyNameVector;

enum class DgnECHostType : uint32_t
    {
    Unknown                     = 0,            
    Element                     = 1 << 0,       
    Model                       = 1 << 2,       
    File                        = 1 << 3,       
    DesignLink                  = 1 << 4,       
    View                        = 1 << 5,       
    Attachment                  = 1 << 6,       
    Level                       = 1 << 7,       

    All                         = 0xffffffff,   
    };

ENUM_IS_FLAGS(DgnECHostType);

/*---------------------------------------------------------------------------------**/
struct DgnECInstanceHost
    {
private:
    struct ViewData
        {
        ViewGroupP              m_group;
        UInt32                  m_index;
        };

    struct ElementData
        {
        ElementHandleCP         m_eh;
        EditElementHandleP      m_eeh;
        };

    struct ModelData
        {
        DgnFileP                m_indexFile;
        union
            {
            DgnModelP               m_model;
            ModelId                 m_modelId;
            };
        };

    struct LevelData
        {
        DgnModelRefP        m_cacheModelRef;
        LevelId             m_id;
        };

    DgnECHostType           m_hostType;
    union
        {
        ElementData         m_element;
        ModelData           m_model;
        DgnFileP            m_dgnfile;
        DgnLinkTreeNodeP    m_linkNode;
        ViewData            m_view;
        DgnAttachmentP      m_attachment;
        LevelData           m_level;
        };

    void                    SetElement (ElementHandleCR eh, EditElementHandleP eeh) { m_hostType = DgnECHostType::Element; m_element.m_eh = &eh; m_element.m_eeh = eeh; }
    void                    SetView (ViewGroupR vg, UInt32 index) { m_hostType = DgnECHostType::View; m_view.m_group = &vg; m_view.m_index = index; }
    void                    SetModel (DgnModelR model) { m_hostType = DgnECHostType::Model; m_model.m_indexFile = nullptr; m_model.m_model = &model; }
    void                    SetModelItem (DgnFileR dgnfile, ModelId modelId) { m_hostType = DgnECHostType::Model; m_model.m_indexFile = &dgnfile; m_model.m_modelId = modelId; }
public:
    DgnECInstanceHost() : m_hostType (DgnECHostType::Unknown) { }
    DgnECInstanceHost (ElementHandleCR eh) { SetElement (eh, nullptr); }
    DgnECInstanceHost (EditElementHandleR eeh) { SetElement (eeh, &eeh); }
    DgnECInstanceHost (DgnModelR model) { SetModel (model); }
    DgnECInstanceHost (DgnFileR dgnFile, ModelId modelId) { SetModelItem (dgnFile, modelId); }
    DgnECInstanceHost (DgnFileR dgnfile) : m_hostType (DgnECHostType::File), m_dgnfile (&dgnfile) { }
    DgnECInstanceHost (DgnAttachmentR attachment) : m_hostType (DgnECHostType::Attachment), m_attachment (&attachment) { }
    DgnECInstanceHost (DgnModelRefR modelRef, LevelId levelId) : m_hostType (DgnECHostType::Level) { m_level.m_cacheModelRef = &modelRef; m_level.m_id = levelId; }
    DgnECInstanceHost (ViewGroupR viewGroup, UInt32 viewIndex) { SetView (viewGroup, viewIndex); }
    DgnECInstanceHost (DgnLinkTreeNodeR linkNode) : m_hostType (DgnECHostType::DesignLink), m_linkNode (&linkNode) { }

    ElementHandleCP                 GetElementHandle() const            { return IsElement() ? m_element.m_eh : nullptr; }
    EditElementHandleP              GetEditElementHandle() const        { return IsElement() ? m_element.m_eeh : nullptr; }
    DgnModelP                       GetModel() const                    { return IsModel() && nullptr == m_model.m_indexFile ? m_model.m_model : nullptr; }
    ModelIndexItem const*           GetModelItem() const                { return IsModel() && nullptr != m_model.m_indexFile ? m_model.m_indexFile->GetModelIndex().GetItemByID (m_model.m_modelId, false) : nullptr; }
    DgnFileP                        GetDgnFile() const                  { return IsDgnFile() ? m_dgnfile : nullptr; }
    DgnAttachmentP                  GetAttachment() const               { return IsAttachment() ? m_attachment : nullptr; }
    LevelHandle                     GetLevel() const                    { return IsLevel() ? m_level.m_cacheModelRef->GetLevelCacheR().GetLevel (m_level.m_id) : LevelHandle(); }
    ViewGroupP                      GetView (UInt32& viewIndex) const   { viewIndex = IsView() ? m_view.m_index : viewIndex; return IsView() ? m_view.m_group : nullptr; }
    DgnLinkTreeNodeP                GetLinkNode() const                 { return IsDesignLink() ? m_linkNode : nullptr; }

    bool                            IsElement() const       { return DgnECHostType::Element == m_hostType; }
    bool                            IsModel() const         { return DgnECHostType::Model == m_hostType; }
    bool                            IsDgnFile() const       { return DgnECHostType::File == m_hostType; }
    bool                            IsAttachment() const    { return DgnECHostType::Attachment == m_hostType; }
    bool                            IsView() const          { return DgnECHostType::View == m_hostType; }
    bool                            IsLevel() const         { return DgnECHostType::Level == m_hostType; }
    bool                            IsDesignLink() const    { return DgnECHostType::DesignLink == GetType(); }
    DgnECHostType                   GetType() const         { return m_hostType; }
    };

struct      SelectedProperties : RefCounted<IRefCounted>
    {
private:
    virtual void MakeClassAbstract() = 0;
public:
public:
    DGNPLATFORM_EXPORT void                             AddPropertyNameToSelect (WCharCP accessString);

    DGNPLATFORM_EXPORT static RefCountedPtr<SelectedProperties> Create (bool selectAllProperties=false);

    DGNPLATFORM_EXPORT RefCountedPtr<SelectedProperties> Duplicate() const;
    };

 typedef RefCountedPtr<SelectedProperties> SelectedPropertiesPtr;

 struct DgnECInstanceCreateOptions
    {
private:
    bool            m_pathBasedId;
    bool            m_qualifiedPepBasedId;
    bool            m_exposeHidden;
    bool            m_exposeHistorical;
public:
    DGNPLATFORM_EXPORT explicit DgnECInstanceCreateOptions (bool pathBasedId = false, bool qualifiedPepBasedId = false);

    bool            HasPathBasedId() const          { return m_pathBasedId; }
    bool            HasQualifiedPepBasedId() const  { return m_qualifiedPepBasedId; }
    bool            ExposesHidden() const           { return m_exposeHidden; }
    bool            ExposesHistorical() const       { return m_exposeHistorical; }

    void            SetPathBasedId (bool pathBased)         { m_pathBasedId = pathBased; }
    void            SetQualifiedPepBasedId (bool qualified) { m_qualifiedPepBasedId = qualified; }
    void            SetExposesHidden (bool exposes)         { m_exposeHidden = exposes; }
    void            SetExposesHistorical (bool exposes)     { m_exposeHistorical = exposes; }
    };

 struct DgnECInstanceCreateContext : DgnECInstanceCreateOptions
    {
private:
    SelectedPropertiesPtr       m_selectedProperties;
public:
    explicit DgnECInstanceCreateContext (SelectedPropertiesP selectedProperties = nullptr, DgnECInstanceCreateOptionsCR options = DgnECInstanceCreateOptions())
        : DgnECInstanceCreateOptions (options), m_selectedProperties (selectedProperties) { }
    explicit DgnECInstanceCreateContext (DgnECInstanceCreateOptionsCR options)
        : DgnECInstanceCreateOptions (options), m_selectedProperties (nullptr) { }

    SelectedPropertiesP     GetSelectedProperties()         { return m_selectedProperties.get(); }
    SelectedPropertiesCP    GetSelectedProperties () const  { return m_selectedProperties.get(); }
    void                    SetSelectedProperties (SelectedPropertiesP selectedProperties) { m_selectedProperties = selectedProperties; }
    };

 struct DgnECInstanceEnabler : ECN::ECEnabler
    {
public:
    DGNPLATFORM_EXPORT ECN::StandaloneECInstanceR GetSharedWipInstance() const;
    
    DGNPLATFORM_EXPORT ECN::StandaloneECInstancePtr  GetPrivateWipInstance() const; 
    
    DGNPLATFORM_EXPORT bool                     SupportsCreateInstanceOnHost (DgnECHostType hostType) const;

    DGNPLATFORM_EXPORT bool                     SupportsCreateInstanceOnElement () const;

    DGNPLATFORM_EXPORT bool                     SupportsCreateInstanceAsElement () const;

    DGNPLATFORM_EXPORT DgnECInstanceStatus      CreateInstanceOnFile (DgnECInstancePtr* dgnecInstance, ECN::IECInstanceCR wipInstance, DgnFileR dgnfile) const;

    DGNPLATFORM_EXPORT DgnECInstanceStatus      CreateInstanceOnModel (DgnECInstancePtr* dgnecInstance, ECN::IECInstanceCR wipInstance, DgnModelR model) const;
    
    DGNPLATFORM_EXPORT DgnECInstanceStatus      CreateInstanceOnLinkNode (DgnECInstancePtr* dgnecInstance, ECN::IECInstanceCR wipInstance, DgnLinkTreeNodeR linknode) const;

    DGNPLATFORM_EXPORT DgnECInstanceStatus      CreateInstanceOnHost (DgnECInstancePtr* dgnecInstance, ECN::IECInstanceCR wipInstance, DgnECInstanceHostCR host, UInt32 intendedLocalId, DgnECInstanceCreateContextCR createContext = DgnECInstanceCreateContext(), bool instanceOwnsHost = false) const;

    DGNPLATFORM_EXPORT DgnECInstanceStatus      CreateInstanceOnHost(DgnECInstancePtr* dgnecInstance, ECN::IECInstanceCR wipInstance, DgnECInstanceHostCR host, DgnECInstanceCreateContextCR createContext = DgnECInstanceCreateContext(), bool instanceOwnsHost = false) const;

public:
    DGNPLATFORM_EXPORT ECN::StandaloneECEnablerR GetStandaloneECInstanceEnabler() const; 

    DGNPLATFORM_EXPORT DgnECInstanceStatus ScheduleInstanceOnElement (DgnElementECInstancePtr* dgnecInstance, ECN::IECInstanceCR wipInstance, EditElementHandleR eh,  bool instanceOwnsElement=false) const;

    DGNPLATFORM_EXPORT DgnECInstanceStatus   ScheduleReplaceInstanceOnElement (DgnElementECInstancePtr* dgnecInstance, ECN::IECInstanceCR wipInstance, DgnModelRefR modelRef, EditElementHandleR eh, UInt32 localId) const;

    DGNPLATFORM_EXPORT DgnECInstanceStatus CreateInstanceOnElement(DgnElementECInstancePtr* dgnecInstance, ECN::IECInstanceCR wipInstance, ElementHandleCR eh, bool instanceOwnsElement = false) const; 

    DGNPLATFORM_EXPORT DgnECInstanceStatus CreateInstanceOnElement(DgnElementECInstancePtr* dgnecInstance, ECN::IECInstanceCR wipInstance, ElementHandleCR eh, UInt32 intendedLocalId, bool instanceOwnsElement = false) const;

    DGNPLATFORM_EXPORT DgnECInstanceStatus CreateInstanceAsElement (DgnElementECInstancePtr* dgnecInstance, ECN::IECInstanceCR wipInstance, DgnModelRefR modelRef, bool instanceOwnsElement=false) const;

    DGNPLATFORM_EXPORT bool IsEnablerValidForDgnFile (DgnFileR dgnFile) const;
    };
    

CLRPUBLIC struct DgnECInstance : virtual ECN::IECInstance
    {
private:
    virtual void MakeClassAbstract() = 0;
public:
public:
    DGNPLATFORM_EXPORT DgnECHostType                GetHostType () const;

    DGNPLATFORM_EXPORT DgnECInstanceHost            GetInstanceHost() const;
    DGNPLATFORM_EXPORT DgnModelRefP                 GetDgnModelRefP () const;
    
    DGNPLATFORM_EXPORT DgnFileP                     GetDgnFileP () const;

    DGNPLATFORM_EXPORT StatusInt                    WriteChanges ();

    DGNPLATFORM_EXPORT StatusInt                    ScheduleWriteChanges (EditElementHandleR eeh);

    DGNPLATFORM_EXPORT DgnECInstanceStatus          Delete ();

    DGNPLATFORM_EXPORT DgnECInstanceStatus          DeleteAndIgnoreOwnership();

    DGNPLATFORM_EXPORT DgnECInstanceStatus         ScheduleDelete (EditElementHandleR element);

    DGNPLATFORM_EXPORT  DgnECInstanceEnablerCR      GetDgnECInstanceEnabler () const;

    DGNPLATFORM_EXPORT ECN::ECObjectsStatus          GetValueAsString (WStringR strVal, WCharCP accessString, bool useArrayIndex, UInt32 arrayIndex) const;

    DGNPLATFORM_EXPORT ECN::ECObjectsStatus          GetValueAsString (WStringR strVal, UInt32 propertyIndex, bool useArrayIndex, UInt32 arrayIndex) const;

    DGNPLATFORM_EXPORT ECN::ECObjectsStatus          SetValueAsString (WCharCP accessString, WCharCP strVal, bool useArrayIndex, UInt32 arrayIndex);

    DGNPLATFORM_EXPORT ECN::ECObjectsStatus          SetValueAsString (UInt32 propertyIndex, WCharCP strVal, bool useArrayIndex, UInt32 arrayIndex);

    DGNPLATFORM_EXPORT  DgnElementECInstanceCP      GetAsElementInstance() const;
    DGNPLATFORM_EXPORT  DgnElementECInstanceP       GetAsElementInstance();

    DGNPLATFORM_EXPORT void                             SetReadOnly (bool isReadOnly);

    };
            
CLRPUBLIC struct DgnElementECInstance : public DgnECInstance
{
public:
    DGNPLATFORM_EXPORT ElementHandleCR     GetElementHandle() const;

    DGNPLATFORM_EXPORT DgnModelRefR                     GetModelRef () const;
    
    DGNPLATFORM_EXPORT ElementRefP                      GetElementRef () const;

    DGNPLATFORM_EXPORT UInt32                           GetLocalId () const;
};

struct DgnECRelationshipEnabler : public ECN::IECRelationshipEnabler
{
public:
    DGNPLATFORM_EXPORT BentleyStatus                CreateRelationship (IDgnECRelationshipInstancePtr *createdRelationship, ECN::StandaloneECRelationshipInstanceR wipRelationship,
                                                                        DgnElementECInstanceCR instanceA, DgnElementECInstanceCR instanceB, DgnModelRefP hostModelRef=NULL, ElementRefP hostElementRef=NULL) const;

    DGNPLATFORM_EXPORT BentleyStatus                CreateRelationship (IDgnECRelationshipInstancePtr *createdRelationship, 
                                                                        DgnElementECInstanceCR instanceA, DgnElementECInstanceCR instanceB, DgnModelRefP hostModelRef=NULL, ElementRefP hostElementRef=NULL) const;

    DGNPLATFORM_EXPORT ECN::StandaloneECRelationshipInstanceR   GetSharedStandaloneWipInstance() const;

    DGNPLATFORM_EXPORT bool                         SupportsRelationshipProperties () const;
};

CLRPUBLIC struct IDgnECRelationshipInstance : ECN::IECRelationshipInstance
    {
public:
    DGNPLATFORM_EXPORT DgnECInstanceStatus Delete ();
    DGNPLATFORM_EXPORT ECN::ECObjectsStatus GetSourceOrderId (Int64& sourceOrderId) const;
    DGNPLATFORM_EXPORT ECN::ECObjectsStatus GetTargetOrderId (Int64& targetOrderId) const;
    DGNPLATFORM_EXPORT ECN::ECObjectsStatus GetSourceAssociatedString (WCharCP& propertyString) const;
    DGNPLATFORM_EXPORT ECN::ECObjectsStatus GetTargetAssociatedString (WCharCP& propertyString) const;
    DGNPLATFORM_EXPORT  DgnElementECInstancePtr GetRelatedInstance (ECN::ECRelationshipEnd end, DgnECInstanceCreateContextCR createContext) const;
    };


/*---------------------------------------------------------------------------------**/

struct DgnECInstanceIterable
    {
private:
    IDgnECInstanceCollectionAdapterPtr  m_collectionPtr;
    
public:
    DgnECInstanceIterable ()
        {
        //
        }


    struct const_iterator : std::iterator<std::forward_iterator_tag, DgnECInstanceP>
        {
    private:
        typedef IDgnECInstanceCollectionAdapter::const_iterator iterator_impl;

        iterator_impl                   m_impl;
    public:
        typedef iterator_impl::reference reference;

    DGNPLATFORM_EXPORT const_iterator (iterator_impl impl);

    DGNPLATFORM_EXPORT reference    operator*() const;
        bool                            operator==(const_iterator const& rhs) const { return this->m_impl == rhs.m_impl; }
        bool                            operator!=(const_iterator const& rhs) const { return this->m_impl != rhs.m_impl; }
        const_iterator&                 operator++() { ++m_impl; return *this; }
        };

    DGNPLATFORM_EXPORT const_iterator begin () const;
    DGNPLATFORM_EXPORT const_iterator end   () const;
    DGNPLATFORM_EXPORT bool empty() const;
    DGNPLATFORM_EXPORT bool IsNull () const;
    };//DgnECInstanceIterable

END_BENTLEY_DGNPLATFORM_NAMESPACE

#pragma managed(pop)