DgnModelRefCollections.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/DgnPlatform.h>
#include <DgnPlatform/ElementHandle.h>
#include "BentleyDgn.h"

BEGIN_BENTLEY_DGNPLATFORM_NAMESPACE


//=======================================================================================
//===============+===============+===============+===============+===============+=======
struct      ReachableModelRefOptions : RefCountedBase
{
public:
    DGNPLATFORM_EXPORT static ReachableModelRefOptionsPtr CreateOptions();

    DGNPLATFORM_EXPORT static ReachableModelRefOptionsPtr Duplicate(ReachableModelRefOptionsCR seedOptions);

    DGNPLATFORM_EXPORT void     ExcludeRootModelRef();

    DGNPLATFORM_EXPORT void     ExcludeInterFileRefs();

    DGNPLATFORM_EXPORT void     ExcludeIntraFileRefs();

    DGNPLATFORM_EXPORT void     ExcludeEmbeddedFileRefs();

    DGNPLATFORM_EXPORT void     ExcludeNonEmbeddedFileRefs();

    DGNPLATFORM_EXPORT void     ExcludeNestedAttachments();

    DGNPLATFORM_EXPORT void     ExcludeRedundantAttachments();

    DGNPLATFORM_EXPORT void     ExcludeUndisplayedAttachments();
};

//=======================================================================================
//===============+===============+===============+===============+===============+=======
struct      ReachableModelRefIterator : RefCountedBase, std::iterator<std::forward_iterator_tag, DgnModelRefP const>
{
private:
    virtual void MakeClassAbstract() = 0;
public:
public:
    DGNPLATFORM_EXPORT bool             IsDifferent(ReachableModelRefIterator const& rhs) const;
    DGNPLATFORM_EXPORT void             MoveToNext ();
    DGNPLATFORM_EXPORT DgnModelRefP const& GetCurrent () const;
};

//=======================================================================================
//===============+===============+===============+===============+===============+=======
struct      ReachableModelRefCollection
{
private:
    friend struct  DgnModelRef;
    friend struct  ReachableModelRefIterator;
    DgnModelRefR                m_modelRef;
    ReachableModelRefOptionsPtr m_options;
    bvector<DgnModelRefP>       m_modelRefArray;

    bool IsModelRefExcluded (bool& excludeChildren, DgnModelRefR modelRef, bool isRoot);
    void BuildDgnModelRefArray (DgnModelRefR modelRef, bool isRoot);

public:
    ReachableModelRefCollection (DgnModelRefR modelRef, ReachableModelRefOptionsR options);

public:
    typedef VirtualCollectionIterator<ReachableModelRefIterator> const_iterator;
    typedef const_iterator iterator;    

public:
    DGNPLATFORM_EXPORT bool           empty() const;            
    DGNPLATFORM_EXPORT const_iterator begin () const;           
    DGNPLATFORM_EXPORT const_iterator end ()   const;           
};

//=======================================================================================
//===============+===============+===============+===============+===============+=======
struct      ReachableElementOptions : RefCountedBase
{
public:
    DGNPLATFORM_EXPORT static ReachableElementOptionsPtr CreateOptions();
    DGNPLATFORM_EXPORT static ReachableElementOptionsPtr Duplicate(ReachableElementOptionsCR seedOptions);

    DGNPLATFORM_EXPORT void                         ExcludeControlSection();

    DGNPLATFORM_EXPORT void                         ExcludeGraphicsSection();

    DGNPLATFORM_EXPORT ReachableModelRefOptionsR    GetModelRefOptions();
};

//=======================================================================================
//===============+===============+===============+===============+===============+=======
struct      ReachableElementIterator : RefCountedBase, std::iterator<std::forward_iterator_tag, ElementHandle const>
{
private:
    virtual void MakeClassAbstract() = 0;
public:
public:
    DGNPLATFORM_EXPORT bool             IsDifferent(ReachableElementIterator const& rhs) const;
    DGNPLATFORM_EXPORT void             MoveToNext ();
    DGNPLATFORM_EXPORT ElementHandleCR  GetCurrent () const;
    DGNPLATFORM_EXPORT bool             IsAtEnd () const;
};

//=======================================================================================
//===============+===============+===============+===============+===============+=======
struct      ReachableElementCollection
{
private:
    friend struct  DgnModelRef;

    ReachableModelRefCollection m_modelRefs;
    ReachableElementOptionsPtr  m_options;

    ReachableElementCollection (DgnModelRefR modelRef, ReachableElementOptionsR options);

public:
    typedef VirtualCollectionIterator<ReachableElementIterator> const_iterator;
    typedef const_iterator iterator;    

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

};

END_BENTLEY_DGNPLATFORM_NAMESPACE