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

BEGIN_BENTLEY_DGNPLATFORM_NAMESPACE

//=======================================================================================
//=======================================================================================
struct   ModelIndexItem
{
public:
    DGNPLATFORM_EXPORT ModelId              GetModelId () const;                
    DGNPLATFORM_EXPORT WCharCP              GetName () const;                   
    DGNPLATFORM_EXPORT WCharCP              GetDescription () const;            
    DGNPLATFORM_EXPORT bool                 Is3D () const;                      
    DGNPLATFORM_EXPORT bool                 IsDeleted () const;                 
    DGNPLATFORM_EXPORT bool                 IsCell () const;                    
    DGNPLATFORM_EXPORT bool                 IsAnnotationCell () const;          
    DGNPLATFORM_EXPORT CellLibraryType      GetCellType () const;               
    DGNPLATFORM_EXPORT bool                 IsHidden () const;                  
    DGNPLATFORM_EXPORT bool                 IsMarkup () const;                  
    DGNPLATFORM_EXPORT DgnModelType         GetModelType () const;              
    DGNPLATFORM_EXPORT double               GetLastSavedTime () const;          
};

typedef bvector<ModelIndexItem> ModelItemVector;

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

//=======================================================================================
//=======================================================================================
struct   ModelIndex
{
public:
    typedef VirtualCollectionIterator<ModelIndexIterator> const_iterator;

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

    DGNPLATFORM_EXPORT ModelIndexItemCP GetItemByName (WCharCP name) const;

    DGNPLATFORM_EXPORT ModelIndexItemCP GetItemByID (ModelId id, const bool getIfDeleted) const;

    DGNPLATFORM_EXPORT void CopyItems(ModelItemVector&, bool includeDeletedModels = false) const;
};

END_BENTLEY_DGNPLATFORM_NAMESPACE