DgnStoreHandlers.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/Handler.h>


BEGIN_BENTLEY_DGNPLATFORM_NAMESPACE


/*=================================================================================**/
struct          DgnStoreHdrHandler : Handler
{
    DEFINE_T_SUPER(Handler)    
    ELEMENTHANDLER_DECLARE_MEMBERS (DgnStoreHdrHandler, DGNPLATFORM_EXPORT)
private:
    virtual void MakeClassAbstract() = 0;
public:
public:

DGNPLATFORM_EXPORT static bool           IsDgnStoreElement (ElementHandleCR in, UInt32 dgnStoreId = 0, UInt32 applicationId = 0);
DGNPLATFORM_EXPORT static BentleyStatus  GetDgnStoreIds (UInt32* dgnStoreId, UInt32* applicationId, ElementHandleCR in);
DGNPLATFORM_EXPORT static BentleyStatus  Extract (void** dataPP, UInt32* dataSizeP, UInt32 dgnStoreId, UInt32 applicationId, ElementHandleCR eh);
DGNPLATFORM_EXPORT static BentleyStatus  ExtractFromCell (void** dataPP, UInt32* dataSizeP, UInt32 dgnStoreId, UInt32 applicationId, ElementHandleCR eh);
DGNPLATFORM_EXPORT static void           FreeExtractedData (void* dataP);

DGNPLATFORM_EXPORT static BentleyStatus  Create (EditElementHandleR eeh, void* dataP, UInt32 dataSize, UInt32 dgnStoreId, UInt32 applicationId, DgnModelRefP);
DGNPLATFORM_EXPORT static BentleyStatus  AppendToCell (EditElementHandleR cellEeh, void* dataP, UInt32 dataSize, UInt32 dgnStoreId, UInt32 applicationId);
DGNPLATFORM_EXPORT static BentleyStatus  RemoveFromCell (EditElementHandleR cellEeh, UInt32 dgnStoreId, UInt32 applicationId);

}; // DgnStoreHdrHandler

/*=================================================================================**/
struct          TagSetHandler : DgnStoreHdrHandler
{
    DEFINE_T_SUPER(DgnStoreHdrHandler)    
    ELEMENTHANDLER_DECLARE_MEMBERS (TagSetHandler,DGNPLATFORM_EXPORT)
private:
    virtual void MakeClassAbstract() = 0;
public:
public:

DGNPLATFORM_EXPORT static BentleyStatus  GetByID (EditElementHandleR eeh, ElementId uniqueId, DgnFileR dgnFile);

DGNPLATFORM_EXPORT static BentleyStatus  GetByName (EditElementHandleR eeh, WCharCP setName, DgnFileR dgnFile);

DGNPLATFORM_EXPORT static BentleyStatus  GetSetName (WCharP name, int bufferSize, ElementHandleCR elm);

DGNPLATFORM_EXPORT static BentleyStatus  GetReportName (WCharP name, int bufferSize, ElementHandleCR elm);

DGNPLATFORM_EXPORT static BentleyStatus  SetSetName (EditElementHandleR eeh, WCharCP name);

DGNPLATFORM_EXPORT static BentleyStatus  SetReportName (EditElementHandleR eeh, WCharCP name);

DGNPLATFORM_EXPORT static BentleyStatus  ExtractTagDefByID (ElementHandleCR eh, DgnTagDefinition& tagDef, UShort tagDefID);

DGNPLATFORM_EXPORT static BentleyStatus  ExtractTagDefByName (ElementHandleCR eh, DgnTagDefinition& tagDef, WCharCP name);

DGNPLATFORM_EXPORT static BentleyStatus  ExtractTagDefs (ElementHandleCR eh, bvector<DgnTagDefinition>& tagDefs);

DGNPLATFORM_EXPORT static BentleyStatus  Create (EditElementHandleR eeh, DgnTagDefinition* tagDefs, UInt32 numTagDefs, WCharCP setName, WCharCP reportName, bool assignNewIds, DgnFileR file, int ownerID=0);

}; // TagSetHandler


struct TagSetCollection;

/*=================================================================================**/
struct TagSetIterator : std::iterator<std::forward_iterator_tag, ElementRefP const>
{
private:

PersistentElementRefListIterator  m_it;
ElementRefP          m_elmRef;

DGNPLATFORM_EXPORT void ToTagSet ();
TagSetIterator (PersistentElementRefList* l) {m_elmRef = NULL; m_it = l->begin(); ToTagSet();}
TagSetIterator () {m_elmRef = NULL;}

friend struct TagSetCollection;

public:

TagSetIterator& operator++() {++m_it; ToTagSet(); return *this;}
bool            operator==(TagSetIterator const& rhs) const {return m_elmRef == rhs.m_elmRef;}
bool            operator!=(TagSetIterator const& rhs) const {return !(*this == rhs);}

ElementRefP const& operator* () const {return m_elmRef;}

}; // TagSetIterator

/*=================================================================================**/
struct TagSetCollection
{
private:

DgnFileR        m_file;

public:

typedef TagSetIterator  const_iterator;
typedef const_iterator iterator;    

TagSetCollection (DgnFileR dgnFile) : m_file (dgnFile) {;}

TagSetIterator begin () const {return TagSetIterator (m_file.GetDictionaryModel().GetControlElementsP());}
TagSetIterator end   () const {return TagSetIterator ();}

}; // TagSetCollection

struct  TagDefCollection;
typedef RefCountedPtr<TagDefCollection> TagDefCollectionPtr;
/*=================================================================================**/
struct  TagDefCollection : public RefCountedBase
    {
private:
    virtual void MakeClassAbstract() = 0;
public:
    public:
    struct const_iterator : std::iterator<std::forward_iterator_tag, DgnTagDefinition const> 
        {
        private:
        byte*   m_currentPos; 
        byte*   m_endPos;
        mutable DgnTagDefinition m_tmpTagDef;
        
        friend struct TagDefCollection;
        
        const_iterator (byte* pos, byte* endpos);
        public:
        
        DGNPLATFORM_EXPORT const_iterator ();
        
        DGNPLATFORM_EXPORT const_iterator (const_iterator const&);
        
        DGNPLATFORM_EXPORT DgnTagDefinition const& operator *() const;
        
        DGNPLATFORM_EXPORT const_iterator& operator ++ ();
        
        DGNPLATFORM_EXPORT bool operator != (const_iterator const &) const;
        
        DGNPLATFORM_EXPORT bool operator == (const_iterator const &) const;
        };

    typedef const_iterator iterator;    

    DGNPLATFORM_EXPORT static TagDefCollectionPtr Create (ElementHandleCR element);
    
    DGNPLATFORM_EXPORT ~TagDefCollection ();
    
    DGNPLATFORM_EXPORT const_iterator begin () const;
    
    DGNPLATFORM_EXPORT const_iterator end () const;
    };


END_BENTLEY_DGNPLATFORM_NAMESPACE