DgnModel.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 "DgnModelRef.h"
#include "DgnFileIO/MSElementDescr.h"
#include "DgnFileIO/ElementRefBase.h"
#include "DgnFileIO/ModelInfo.h"

BEGIN_BENTLEY_DGNPLATFORM_NAMESPACE

struct PersistentElementRefList;
struct PersistentElementRefBlock;


//=======================================================================================
// @bsiclass                                                     Bentley Systems
//=======================================================================================
struct  PersistentElementRefVec : bvector<PersistentElementRefP>
{
    BentleyStatus DropEntry (PersistentElementRefP);
};

//=======================================================================================
//=======================================================================================
struct PersistentElementRef : public ElementRefBase
{
private:
    virtual void MakeClassAbstract() = 0;
public:
};

//=======================================================================================
//=======================================================================================
class PersistentElementRefListIterator : public std::iterator<std::forward_iterator_tag, PersistentElementRefP const>
{
private:
    PersistentElementRefBlock*  m_currBlock;
    UInt32                      m_currIndex;
    PersistentElementRefP       m_currElement;

public:
    PersistentElementRefListIterator () {m_currBlock = NULL; m_currElement=NULL;}

    PersistentElementRefP const& GetCurrentElementRef () const {return m_currElement;}

    DGNPLATFORM_EXPORT PersistentElementRefP SetCurrentElementRef (PersistentElementRefP toElm);

public:

    DGNPLATFORM_EXPORT PersistentElementRefListIterator& operator++();                      
    DGNPLATFORM_EXPORT bool operator!=(PersistentElementRefListIterator const& rhs) const;  
                   bool operator==(PersistentElementRefListIterator const& rhs) const {return !(*this != rhs);}

    PersistentElementRefP const& operator* () const {return m_currElement;}
};

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

    typedef PersistentElementRefListIterator  const_iterator;
    typedef const_iterator iterator;    

    DGNPLATFORM_EXPORT bool IsEmpty () const;           
    DGNPLATFORM_EXPORT const_iterator begin () const;   
    DGNPLATFORM_EXPORT const_iterator end () const;     
    DGNPLATFORM_EXPORT DgnModelP GetDgnModelP() const;  
};

//========================================================================================
//=======================================================================================
struct      DgnModelAppData
    {
    virtual ~DgnModelAppData() {}

    struct Key : AppDataKey {};

    virtual void _OnCleanup (DgnModelR host) = 0;

    virtual void _OnFilled (DgnModelR host) {}

    virtual bool _OnEmpty (DgnModelR host) {return true;}

    virtual bool _OnEmptied (DgnModelR host) {return false;}

    virtual void _OnModelDelete (DgnModelR host) {}

    virtual void _OnModelUnDelete (DgnModelR host) {}

    virtual void _OnElementAdded (DgnModelR host, PersistentElementRef& elem, bool isGraphicsList) {;}

    virtual void _OnSaveModelProperties (DgnModelR host, ModelInfoCR original) {;}

private:
    virtual bool _Dummy1(void*) {return false;}
    virtual bool _Dummy2(void*) {return false;}
    virtual bool _Dummy3(void*) {return false;}
    };

//=======================================================================================
//=======================================================================================
struct ReferencedByArray : bvector<DgnAttachmentP>
    {
    };

//=======================================================================================
//=======================================================================================
enum class GeoAttachmentHandling
    {
    Default              = 0,        // Attempt to reproject, mark attachment Not Found (with appropriate reason) if unable to do so.
    DoNotReproject        = 1,        // Don't attempt to reproject, mark attachment Not Found (with appropriate reason). This is the default for models opend using mdlModelRef_createWorking
    AcceptUnprojected    = 2,        // Don't attempt to reproject, do not mark attachment Not Found. Use with caution because reference elements are not correctly located.
    };

//=======================================================================================
//=======================================================================================
CLRPUBLIC struct DgnModel : DgnModelRef
    {
    DGNPLATFORM_EXPORT IDgnComponentDefinitionHandlerP GetDgnComponentDefinitionHandler();
private:
    virtual void MakeClassAbstract() = 0;
public:
public:
    DGNPLATFORM_EXPORT DgnModelStatus SetModelInfo (ModelInfoR modelInfo);



    DGNPLATFORM_EXPORT StatusInt FillSections (DgnModelSections sectionsToFill, DgnModelFillContextP fillContext=NULL);

    DGNPLATFORM_EXPORT void Empty (bool evenIfDirty=false, bool andFree=false);

    DGNPLATFORM_EXPORT DgnModelSections IsFilled (DgnModelSections sections) const;

    DGNPLATFORM_EXPORT UInt32 GetElementCount (DgnModelSections sections);


    DGNPLATFORM_EXPORT FileLevelCacheR GetFileLevelCacheR ();

    DGNPLATFORM_EXPORT FileLevelCacheCR GetFileLevelCache () const;

    DGNPLATFORM_EXPORT bool IsDictionaryModel () const;



    DGNPLATFORM_EXPORT PersistentElementRefList* GetControlElementsP();

    DGNPLATFORM_EXPORT PersistentElementRefList* GetGraphicElementsP();

    DGNPLATFORM_EXPORT int AddRef();

    DGNPLATFORM_EXPORT int Release();

    //=======================================================================================
    //=======================================================================================
    struct ElementRefIterator : std::iterator<std::forward_iterator_tag, PersistentElementRefP const>
    {
    private:
        enum IteratorState {ITERATING_DictionaryElements = 0, ITERATING_ControlElms = 1, ITERATING_GraphicElms = 2, ITERATING_HitEOF = 3};

    private:
        PersistentElementRefListIterator m_iter;
        DgnModelP                       m_model;
        DgnModelSections                m_firstSection;
        IteratorState                   m_state;
    public:
        DGNPLATFORM_EXPORT ElementRefIterator&      operator++();                                      
        DGNPLATFORM_EXPORT bool                     operator!=(ElementRefIterator const& rhs) const;   
                           bool                     operator==(ElementRefIterator const& rhs) const {return !(*this != rhs);}

        DGNPLATFORM_EXPORT PersistentElementRefP const& operator* () const;
    };

    //=======================================================================================
    //=======================================================================================
    struct      ElementsCollection
    {
    private:
        friend struct  DgnModel;
        DgnModel const& m_model;
        ElementsCollection (DgnModel const& c) : m_model(c) {}

    public:
        typedef ElementRefIterator const_iterator;
        typedef const_iterator iterator;    

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

    }; // ElementsCollection

    DGNPLATFORM_EXPORT ElementsCollection GetElementsCollection () const;

    DGNPLATFORM_EXPORT PersistentElementRefP FindElementByID (ElementId id) const;





    DGNPLATFORM_EXPORT ModelId GetModelId () const;

    DGNPLATFORM_EXPORT ModelInfoCR GetModelInfo () const;

    DGNPLATFORM_EXPORT StatusInt SaveModelSettings ();

    DGNPLATFORM_EXPORT WCharCP GetModelName () const;

    DGNPLATFORM_EXPORT bool IsReadOnly () const;

    DGNPLATFORM_EXPORT DgnFileP GetDgnFileP () const;

    DGNPLATFORM_EXPORT StatusInt GetRange (ScanRangeR range);
    DGNPLATFORM_EXPORT StatusInt GetRange (DRange3dR range);


    DGNPLATFORM_EXPORT StatusInt AddAppData (DgnModelAppData::Key const& key, DgnModelAppData* appData);

    DGNPLATFORM_EXPORT StatusInt DropAppData (DgnModelAppData::Key const& key);

    DGNPLATFORM_EXPORT DgnModelAppData* FindAppData (DgnModelAppData::Key const& key) const;


    DGNPLATFORM_EXPORT ReferencedByArrayCR GetReferencedBy ();

    DGNPLATFORM_EXPORT UInt32 GetControlElmStart ();

    DGNPLATFORM_EXPORT UInt32 GetGraphicElmStart ();

    DGNPLATFORM_EXPORT UpdateSequenceListP      GetUpdateSequence ();

    DGNPLATFORM_EXPORT void                     SetUpdateSequence (UpdateSequenceListP list);

}; // DgnModel

END_BENTLEY_DGNPLATFORM_NAMESPACE

BEGIN_BENTLEY_NAMESPACE

END_BENTLEY_NAMESPACE