CustomItemType.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 <ECObjects/ECObjectsApi.h>
#include <DgnPlatform/DgnECManager.h>


BEGIN_BENTLEY_DGNPLATFORM_NAMESPACE

/*---------------------------------------------------------------------------------**/
template<typename T_Impl> struct ItemTypeLibraryComponent
    {
private:
    T_Impl*             m_impl;
    ItemTypeLibraryP    m_library;
    ::UInt32            m_guid;
    WString             m_storedName;

protected:
protected:
    ItemTypeLibraryComponent (ItemTypeLibraryComponent const& other)
        : m_impl(other.m_impl), m_library(other.m_library), m_guid(other.m_guid), m_storedName(other.m_storedName)
        {
        //
        }
public:
    ::UInt32            GetGuid() const { return m_guid; }
    ItemTypeLibraryCR   GetLibrary() const { return *m_library; }
    ItemTypeLibraryR    GetLibrary() { return *m_library; }
    };

/*---------------------------------------------------------------------------------**/
struct CustomProperty : ItemTypeLibraryComponent<ECN::ECProperty>
    {
private:
public:
    CustomProperty (CustomPropertyCR other);

    /*---------------------------------------------------------------------------------**/
    enum class Type
        {
        Boolean         = 0,    
        DateTime        = 1,    
        Double          = 2,    
        Integer         = 3,    
        Point           = 4,    
        String          = 5,    

        Custom          = 6     
        };

    DGNPLATFORM_EXPORT  WCharCP             GetInternalName() const;

    DGNPLATFORM_EXPORT  Type                        GetType() const;
    DGNPLATFORM_EXPORT  CustomPropertyTypeCP        GetCustomType() const;
    DGNPLATFORM_EXPORT  bool                        SupportsCustomType() const;

    DGNPLATFORM_EXPORT WCharCP                      GetName() const;
    DGNPLATFORM_EXPORT bool                         IsArray() const;

    DGNPLATFORM_EXPORT  bool                        SupportsUnits() const;
    DGNPLATFORM_EXPORT  DgnECUnit                   GetUnits() const;

                        CustomPropertyContainerCR   GetContainer() const { return const_cast<CustomPropertyP>(this)->GetContainer(); }
    DGNPLATFORM_EXPORT  CustomPropertyContainerR    GetContainer();
    DGNPLATFORM_EXPORT  UInt32                      GetContainerId() const;
    DGNPLATFORM_EXPORT  UInt32                      GetId() const;

    DGNPLATFORM_EXPORT  Int32                       GetPriority() const;
    DGNPLATFORM_EXPORT  bool                        IncrementPriority();
    DGNPLATFORM_EXPORT  bool                        DecrementPriority();

    DGNPLATFORM_EXPORT  bool                        SetName (WCharCP name);
    DGNPLATFORM_EXPORT  bool                        SetIsArray (bool isArray);

    DGNPLATFORM_EXPORT  bool                        SetType (Type type);
    DGNPLATFORM_EXPORT  bool                        SetType (CustomPropertyTypeCR customType);
    DGNPLATFORM_EXPORT  bool                        SetUnits (DgnECUnitCR unit);

    DGNPLATFORM_EXPORT  bool                        GetDefaultValue (ECN::ECValueR v) const;
    DGNPLATFORM_EXPORT  bool                        SetDefaultValue (ECN::ECValueCR v);

    DGNPLATFORM_EXPORT  bool                        CompareTo (CustomPropertyCR other) const;

    };

/*---------------------------------------------------------------------------------**/
struct CustomPropertyContainer : ItemTypeLibraryComponent<ECN::ECClass>
    {
protected:
public:
    DGNPLATFORM_EXPORT WCharCP              GetInternalName() const;
public:
    DGNPLATFORM_EXPORT WCharCP              GetName() const;
    DGNPLATFORM_EXPORT UInt32               GetId() const;

    typedef bvector<CustomProperty>::const_iterator const_iterator;
    typedef bvector<CustomProperty>::iterator iterator;

    DGNPLATFORM_EXPORT size_t               GetPropertyCount() const;
    DGNPLATFORM_EXPORT const_iterator       begin() const;
    DGNPLATFORM_EXPORT const_iterator       end() const;
    DGNPLATFORM_EXPORT iterator             begin();
    DGNPLATFORM_EXPORT iterator             end();

    CustomPropertyCP                        GetPropertyById (UInt32 id) const { return const_cast<CustomPropertyContainerP>(this)->GetPropertyById (id); }
    CustomPropertyCP                        GetPropertyByName (WCharCP name) const { return const_cast<CustomPropertyContainerP>(this)->GetPropertyByName (name); }
    DGNPLATFORM_EXPORT CustomPropertyP      GetPropertyById (UInt32 id);
    DGNPLATFORM_EXPORT CustomPropertyP      GetPropertyByName (WCharCP name);

    DGNPLATFORM_EXPORT bool                 SetName (WCharCP name);

    DGNPLATFORM_EXPORT CustomPropertyP      AddProperty (WCharCP name, bool forCopy = false);
    DGNPLATFORM_EXPORT bool                 RemoveProperty (UInt32 id);
    };

/*---------------------------------------------------------------------------------**/
struct CustomPropertyType : CustomPropertyContainer
    {
private:
public:
    CustomPropertyType (CustomPropertyTypeCR other);

    DGNPLATFORM_EXPORT bool         IsReferenced() const;
    DGNPLATFORM_EXPORT bool         CompareTo (CustomPropertyTypeCR other) const;
    };


/*---------------------------------------------------------------------------------**/
struct ItemType : CustomPropertyContainer
    {
private:
public:
    ItemType (ItemTypeCR other);

    DGNPLATFORM_EXPORT bool                 CompareTo (ItemTypeCR other) const;

    DGNPLATFORM_EXPORT bool                 IsIdentifyingItem() const;
    DGNPLATFORM_EXPORT bool                 SetIsIdentifyingItem (bool isIdentifyingItem);
    DGNPLATFORM_EXPORT CustomPropertyCP     GetLabelProperty() const;
    DGNPLATFORM_EXPORT bool                 SetLabelProperty (CustomPropertyCP prop);
    };

/*---------------------------------------------------------------------------------**/
struct ItemTypeLibrary : RefCountedBase
    {
private:
public:
    DGNPLATFORM_EXPORT WCharCP              GetName() const;
    DGNPLATFORM_EXPORT WCharCP              GetInternalName() const;
    DGNPLATFORM_EXPORT bool                 SetName (WCharCP name);
    DGNPLATFORM_EXPORT ElementId            GetId() const;

    DGNPLATFORM_EXPORT bool                 IsPersistent() const;
    DGNPLATFORM_EXPORT DgnFileR             GetDgnFile() const;

    DGNPLATFORM_EXPORT  ItemTypeP           AddItemType (WCharCP name, bool forCopy = false);
    DGNPLATFORM_EXPORT  CustomPropertyTypeP AddCustomType (WCharCP name, bool forCopy = false);
    DGNPLATFORM_EXPORT  bool                RemoveItemType (UInt32 id);
    DGNPLATFORM_EXPORT  bool                RemoveCustomType (UInt32 id);

    DGNPLATFORM_EXPORT  bool                Revert();
    DGNPLATFORM_EXPORT  bool                Write();
    DGNPLATFORM_EXPORT  SchemaDeleteStatus  Delete();

    DGNPLATFORM_EXPORT  bool                CompareTo (ItemTypeLibraryCR other) const;

    typedef bvector<ItemType>::const_iterator const_iterator;
    typedef bvector<ItemType>::iterator iterator;

    DGNPLATFORM_EXPORT size_t                           GetItemTypeCount() const;
    DGNPLATFORM_EXPORT const_iterator                   begin() const;
    DGNPLATFORM_EXPORT const_iterator                   end() const;
    DGNPLATFORM_EXPORT iterator                         begin();
    DGNPLATFORM_EXPORT iterator                         end();

    ItemTypeCP                                          GetItemTypeByName (WCharCP name) const { return const_cast<ItemTypeLibraryP>(this)->GetItemTypeByName (name); }
    ItemTypeCP                                          GetItemTypeById (UInt32 id) const { return const_cast<ItemTypeLibraryP>(this)->GetItemTypeById (id); }
    DGNPLATFORM_EXPORT ItemTypeP                        GetItemTypeByName (WCharCP name);
    DGNPLATFORM_EXPORT ItemTypeP                        GetItemTypeById (UInt32 id);

    typedef bvector<CustomPropertyType>::const_iterator CustomTypeConstIterator;
    typedef bvector<CustomPropertyType>::iterator       CustomTypeIterator;

    DGNPLATFORM_EXPORT size_t                           GetCustomTypeCount() const;
    DGNPLATFORM_EXPORT CustomTypeConstIterator          CustomTypesBegin() const;
    DGNPLATFORM_EXPORT CustomTypeConstIterator          CustomTypesEnd() const;
    DGNPLATFORM_EXPORT CustomTypeIterator               CustomTypesBegin();
    DGNPLATFORM_EXPORT CustomTypeIterator               CustomTypesEnd();

    DGNPLATFORM_EXPORT CustomPropertyTypeCP             GetCustomTypeByName (WCharCP name) const;
    DGNPLATFORM_EXPORT CustomPropertyTypeCP             GetCustomTypeById (UInt32 id) const { return const_cast<ItemTypeLibraryP>(this)->GetCustomTypeById (id); }
    DGNPLATFORM_EXPORT CustomPropertyTypeP              GetCustomTypeByName (WCharCP name);
    DGNPLATFORM_EXPORT CustomPropertyTypeP              GetCustomTypeById (UInt32 id);

    CustomPropertyContainerCP                           GetPropertyContainerByName (WCharCP name) const { return const_cast<ItemTypeLibraryP>(this)->GetPropertyContainerByName (name); }
    CustomPropertyContainerCP                           GetPropertyContainerById (UInt32 id) const { return const_cast<ItemTypeLibraryP>(this)->GetPropertyContainerById (id); }
    DGNPLATFORM_EXPORT CustomPropertyContainerP         GetPropertyContainerByName (WCharCP name);
    DGNPLATFORM_EXPORT CustomPropertyContainerP         GetPropertyContainerById (UInt32 id);

    DGNPLATFORM_EXPORT CustomPropertyP              GetPropertyByGuid (UInt32 guid);
                       CustomPropertyCP             GetPropertyByGuid (UInt32 guid) const { return const_cast<ItemTypeLibraryP>(this)->GetPropertyByGuid (guid); }

    DGNPLATFORM_EXPORT static ItemTypeLibraryPtr    FindByName (WCharCP name, DgnFileR dgnfile);
    DGNPLATFORM_EXPORT static ItemTypeLibraryPtr    FindBySchemaName (WCharCP schemaName, DgnFileR dgnfile);
    DGNPLATFORM_EXPORT static ItemTypeLibraryPtr    Create (WCharCP name, DgnFileR dgnfile, bool forCopy = false);

    DGNPLATFORM_EXPORT ItemTypeLibraryPtr           CloneForFile (DgnFileR destFile, bool forReplacement = false) const;

    DGNPLATFORM_EXPORT static bool      IsItemTypeSchema (WStringCR schemaName);
    DGNPLATFORM_EXPORT static bool      IsItemTypeSchema (ECN::ECSchemaCR schema);
    };


/*---------------------------------------------------------------------------------**/
struct ItemTypeLibraries : RefCountedBase
    {
public:
    struct Entry
        {
    private:

        ECN::ECSchemaPtr            m_schema;
        ItemTypeLibrariesCP         m_collection;
        mutable ItemTypeLibraryPtr  m_library;
        ElementId                   m_elementId;

        Entry (ECN::ECSchemaR schema, ItemTypeLibrariesCR collection, ElementId elemId) : m_schema (&schema), m_collection (&collection), m_elementId (elemId) { }
    public:
        Entry (Entry const& other) : m_schema(other.m_schema), m_collection(other.m_collection), m_library(other.m_library), m_elementId (other.m_elementId) { }

        WCharCP             GetName() const { return m_schema->GetDisplayLabel().c_str(); }
        WCharCP             GetInternalName() const { return m_schema->GetName().c_str(); }
        ECN::ECSchemaCR     GetSchema() const { return *m_schema; }
        ElementId           GetId() const { return m_elementId; }

    DGNPLATFORM_EXPORT ItemTypeLibraryPtr   ObtainLibrary() const;
        };
private:
public:
    typedef bvector<Entry>::const_iterator const_iterator;
    typedef const_iterator iterator;

    DGNPLATFORM_EXPORT DgnFileR             GetDgnFile() const;

    DGNPLATFORM_EXPORT const_iterator       begin() const;
    DGNPLATFORM_EXPORT const_iterator       end() const;
    DGNPLATFORM_EXPORT size_t               size() const;

    DGNPLATFORM_EXPORT static ItemTypeLibrariesPtr  Create (DgnFileR dgnfile);
    };


/*---------------------------------------------------------------------------------**/
struct CustomItemHost
    {
private:
    struct ViewData
        {
        ViewGroupP      m_viewGroup;
        UInt32          m_viewIndex;
        };

    DgnECHostType       m_hostType;
    bool                m_readOnly;
    bool                m_scheduleItemsOnElement;
    union
        {
        ElementHandleCP     m_eh;
        EditElementHandleP  m_eeh;
        DgnModelP           m_model;
        DgnFileP            m_file;
        ViewData            m_view;
        };

public:
    DGNPLATFORM_EXPORT DgnFileR         GetDgnFile() const;

    DGNPLATFORM_EXPORT CustomItemHost (ElementHandleCR eh);
    DGNPLATFORM_EXPORT CustomItemHost (EditElementHandleR eeh, bool scheduleItems = true);
    DGNPLATFORM_EXPORT CustomItemHost (DgnModelR model);
    DGNPLATFORM_EXPORT CustomItemHost (DgnFileR dgnfile);
    DGNPLATFORM_EXPORT CustomItemHost (ViewGroupR viewGroup, UInt32 viewIndex);

    virtual DGNPLATFORM_EXPORT ~CustomItemHost();

    DGNPLATFORM_EXPORT size_t           GetCustomItems (DgnECInstanceVector& items) const;
    DGNPLATFORM_EXPORT size_t           GetCustomItemsCount() const;
    DGNPLATFORM_EXPORT DgnECInstancePtr GetCustomItem (WCharCP libraryName, WCharCP itemTypeName) const;
    DGNPLATFORM_EXPORT DgnECInstancePtr ApplyCustomItem (ItemTypeCR itemType) const;
    DGNPLATFORM_EXPORT DgnECInstancePtr ApplyCustomItem (ItemTypeCR itemType, bool importLibrariesIfRequired) const;
    DGNPLATFORM_EXPORT bool             CopyCustomItems (CustomItemHostCR src, bool importLibrariesIfRequired = false) const;
    };

END_BENTLEY_DGNPLATFORM_NAMESPACE

#pragma managed(pop)