DgnECFinders.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 "DgnModelRef.h"
#include "DgnFile.h"
#include "ElementHandle.h"
#include "ElementAgenda.h"
#include "DgnECInstance.h"
#include "DgnFileIO/DgnModelRefCollections.h"
#include <Bentley/bvector.h>
#include <string>
#include <string.h>
#include "ECQuery.h"

DGNPLATFORM_TYPEDEFS (FindInstancesScopeOption);
BEGIN_BENTLEY_DGNPLATFORM_NAMESPACE
struct DgnECInstanceIterable;
typedef bpair<const ECN::SchemaNameClassNamePair, int>    InstanceCountEntry;



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

CLRPUBLIC struct FindInstancesScopeOption
    {
private:
    ReachableModelRefOptionsPtr m_modelReachableOptions;
    DgnECHostType               m_hostType;
    UInt8                       m_nonModelIdOption;
    bool                        m_includeAttachments;
    bool                        m_includePublicChildren;
    bool                        m_allowExternalizedInstances;
    DgnECInstanceCreateOptions  m_createOptions;

public:
    DGNPLATFORM_EXPORT FindInstancesScopeOption();
    
    DGNPLATFORM_EXPORT FindInstancesScopeOption (DgnECHostType hostType);

    DGNPLATFORM_EXPORT FindInstancesScopeOption (DgnECHostType hostType, bool includeAttachments);
    
    DgnECHostType   GetHostType() const {return m_hostType;}
    
    void    SetHostType(DgnECHostType hostType) {m_hostType = hostType;}
    
    void    SetSearchModelInstances () {m_hostType = DgnECHostType(m_hostType | DgnECHostType::Model);}
    
    void    SetSearchFileInstances () {m_hostType = DgnECHostType(m_hostType | DgnECHostType::File);}
    
    bool    GetSearchAttachments () const {return m_includeAttachments;}

    void    SetSearchAttachments (bool includeAttachments) {m_includeAttachments = includeAttachments;}

    ReachableModelRefOptionsP   GetReachableModelOptions() const {return m_modelReachableOptions.get();}
    
    DGNPLATFORM_EXPORT void     SetReachableModelOptions (ReachableModelRefOptionsP options);
    
    bool    GetSearchPublicChildren () const {return m_includePublicChildren;}

    void    SetSearchPublicChildren(bool searchChildren) {m_includePublicChildren = searchChildren;}

    };

/*---------------------------------------------------------------------------------**/
CLRPUBLIC struct FindInstancesScope : RefCountedBase
{
private:
    virtual void MakeClassAbstract() = 0;
public:
public:
    
    DGNPLATFORM_EXPORT  static FindInstancesScopePtr    CreateScope (DgnFileR file, FindInstancesScopeOptionCR options);
    
    DGNPLATFORM_EXPORT  static FindInstancesScopePtr    CreateScope (bvector<DgnModelRefP> const& models, FindInstancesScopeOptionCR option, DgnFileR file);

    DGNPLATFORM_EXPORT  static FindInstancesScopePtr    CreateScope (DgnModelRefR modelRef, FindInstancesScopeOptionCR options);

    DGNPLATFORM_EXPORT  static FindInstancesScopePtr    CreateScope (ViewportR viewport, FindInstancesScopeOptionCR option);

    DGNPLATFORM_EXPORT  static FindInstancesScopePtr    CreateScope (DgnModelRefR modelRef, ElementAgendaCR agenda, FindInstancesScopeOptionCR option);

    DGNPLATFORM_EXPORT  static FindInstancesScopePtr    CreateScope (ElementHandleCR elemHandle, FindInstancesScopeOptionCR option);

    DGNPLATFORM_EXPORT  static FindInstancesScopePtr    CreateScope (DgnLinkTreeNodeCR linkNode);
    DGNPLATFORM_EXPORT  static FindInstancesScopePtr    CreateScope (DgnLinkTreeNodeCR linkNode, DgnECInstanceCreateOptionsCR option);

    DGNPLATFORM_EXPORT  DgnECHostType                   GetHostType() const;

    DGNPLATFORM_EXPORT  DgnFileP                        GetFile () const;

    DGNPLATFORM_EXPORT  bool                            Empty() const;

};
//=======================================================================================
//+=============+===============+===============+===============+===============+======
struct InstanceCountIterable
{
private:
    FindInstancesScopePtr       m_scope;
    SearchClassList             m_requestedClasses;
    ECQueryProcessFlags         m_searchFlags;
    
    InstanceCountIterable (FindInstancesScopeR scope, const SearchClassList & requestedClasses, ECQueryProcessFlags searchFlags);

public:
    struct const_iterator;
    //======================================================================================
    //+=============+===============+===============+===============+===============+======
    struct IteratorState : RefCountedBase
        {
private:
    virtual void MakeClassAbstract() = 0;
public:
        };

    //======================================================================================
    //+=============+===============+===============+===============+===============+======
    struct const_iterator : std::iterator<std::forward_iterator_tag, InstanceCountEntry const>
        {
        private:
            friend struct InstanceCountIterable;
            RefCountedPtr<IteratorState> m_state;
            bool m_isEnd;

            const_iterator ();
                       
        public:
            DGNPLATFORM_EXPORT const_iterator&      operator++();
            
            DGNPLATFORM_EXPORT bool                 operator!=(const_iterator const& rhs) const;
            
                               bool                 operator==(const_iterator const& rhs) const {return !(*this != rhs);}
            
            DGNPLATFORM_EXPORT InstanceCountEntry const& operator* () const;
        };  // end const_iterator

    typedef const_iterator iterator;    

public:
    DGNPLATFORM_EXPORT const_iterator begin() const;
    DGNPLATFORM_EXPORT const_iterator end() const;
};  // end InstanceCountIterable

END_BENTLEY_DGNPLATFORM_NAMESPACE


#pragma managed(pop)