DgnPlatform/XMLFragment.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


BEGIN_BENTLEY_DGNPLATFORM_NAMESPACE

struct XmlFragment;

typedef RefCountedPtr<XmlFragment>             XmlFragmentPtr;

/*=================================================================================**/
/*=================================================================================**/
struct XmlFragment : public RefCountedBase
{
public:
    DGNPLATFORM_EXPORT static  XmlFragmentPtr Construct (UShort appID, UShort appType);

    DGNPLATFORM_EXPORT static  XmlFragmentPtr Construct (UShort appID, UShort appType, bool isCompressed, WCharCP pSchemaURN, WCharCP pText);

    DGNPLATFORM_EXPORT static  XmlFragmentPtr Construct (UShort appID, UShort appType, WCharCP pText);

    DGNPLATFORM_EXPORT static bool IsFragmentElement (ElementHandleCR eh, UInt16* pAppID=NULL, UInt16* pAppType=NULL);

    // UInt32     compression flag, 1=uncompressed, 2=compressed
    // UInt32     uncompressed XML Fragment data size + the size in bytes of these first two values (8 bytes)
    // --- start of compressable data ----------------------------------
    // UInt32     total size, in bytes, of uncompressed XML Fragment data
    // UInt32     # of bytes to hold schema including trailing 0
    // byte*      Schema URN text
    // UInt32     # of bytes to hold XML fragment text including trailing 0
    // byte*      XML fragment text
    // --- end of compressable data -------------------------------------
    DGNPLATFORM_EXPORT static XmlFragmentPtr ConstructFromBuffer (byte* pBuffer, UInt32 ulBufferSize, UInt16 appId, UInt16 appType);

    DGNPLATFORM_EXPORT static XmlFragmentPtr ConstructFromXmlFragmentElement (ElementHandleCR eh);

    DGNPLATFORM_EXPORT static StatusInt StripFromElementByAppIDAndType (EditElementHandleR eeh, UShort* pAppID, UShort* pAppType);

    DGNPLATFORM_EXPORT static StatusInt StripAllFromElement (EditElementHandleR eeh);

    DGNPLATFORM_EXPORT static bool ElementHasXmlFragmentLinkage (ElementHandleCR  eh, const UShort* pAppID, const UShort* pAppType);

    DGNPLATFORM_EXPORT UShort GetAppID ();

    DGNPLATFORM_EXPORT void SetAppID  (UShort appID);

    DGNPLATFORM_EXPORT UShort GetAppType ();

    DGNPLATFORM_EXPORT void SetAppType (UShort appType);

    DGNPLATFORM_EXPORT WCharCP GetSchemaURN ();

    DGNPLATFORM_EXPORT void SetSchemaURN (WCharCP pSchemaURN);

    DGNPLATFORM_EXPORT WCharCP GetText ();

    DGNPLATFORM_EXPORT void SetText (WCharCP pText);

    DGNPLATFORM_EXPORT bool IsCompressed ();

    DGNPLATFORM_EXPORT void SetIsCompressed (bool isCompressed);

    DGNPLATFORM_EXPORT StatusInt GetStreamData (byte** ppBuffer, UInt32* pulBufferSize);
    
    DGNPLATFORM_EXPORT void FreeStreamData ();

    DGNPLATFORM_EXPORT StatusInt AttachToElement (EditElementHandleR eeh);

    DGNPLATFORM_EXPORT StatusInt CreateXmlElement (EditElementHandleR eeh, DgnModelRefP model, bool setNonModelFlag);
};



struct XmlFragmentList;

typedef RefCountedPtr<XmlFragmentList>         XmlFragmentListPtr;

/*=================================================================================**/
/*=================================================================================**/
struct XmlFragmentList : public RefCountedBase
{
   
    typedef bvector<XmlFragmentPtr>::const_iterator const_iterator;
    typedef const_iterator iterator;    

    DGNPLATFORM_EXPORT bvector<XmlFragmentPtr>::iterator begin ();

    DGNPLATFORM_EXPORT bvector<XmlFragmentPtr>::iterator end ();

    DGNPLATFORM_EXPORT static XmlFragmentListPtr ConstructFromFragment (XmlFragment const* xmlFragment);

    DGNPLATFORM_EXPORT static XmlFragmentListPtr  Construct (WChar* pText, WChar* pSchemaURN, UShort appID, UShort appType);

    DGNPLATFORM_EXPORT static XmlFragmentListPtr ConstructFromBuffer (byte* pBuffer, UInt32 ulBufferSize, UShort appId=0, UShort appType=0);

    DGNPLATFORM_EXPORT StatusInt Append  (XmlFragment const* xmlFragment);

    DGNPLATFORM_EXPORT StatusInt Prepend (XmlFragment const* xmlFragment);

    DGNPLATFORM_EXPORT StatusInt Remove (size_t index);

    DGNPLATFORM_EXPORT size_t GetCount();

    DGNPLATFORM_EXPORT XmlFragmentPtr GetFragmentAtIndex (size_t index);   

    DGNPLATFORM_EXPORT static XmlFragmentListPtr ExtractFromElement (ElementHandleCR eh, const UShort* pAppID=NULL, const UShort* pAppType=NULL);

    DGNPLATFORM_EXPORT StatusInt AttachToElement (EditElementHandleR eeh);
};


END_BENTLEY_DGNPLATFORM_NAMESPACE