DgnECProviders.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 "DgnECInstance.h"
#include "DgnECFinders.h"

#include <Bentley/bvector.h>

DGNPLATFORM_TYPEDEFS(IDgnECInstanceLocator);
DGNPLATFORM_TYPEDEFS(DgnECRelationshipInfo);
DGNPLATFORM_TYPEDEFS(IDgnECRelationshipProvider);
DGNPLATFORM_TYPEDEFS(SchemaUpdateOptions);

BEGIN_BENTLEY_DGNPLATFORM_NAMESPACE



static const UInt16 DgnECProviderId_ECXAttributes    = 0x56FF;

static const UInt16 DgnECProviderId_ECXData          = 0xECDA;

static const UInt16 DgnECProviderId_Element          = 0xECDB;

static const UInt16 DgnECProviderId_Model            = 0xEC01;

static const UInt16 DgnECProviderId_File             = 0xEC02;

static const UInt16 DgnECProviderId_FileExtrinsic   = 0xEC03;

static const UInt16 DgnECProviderId_ModelExtrinsic  = 0xEC0C;

static const UInt16 DgnECProviderId_Link            = 0xEC04;

static const UInt16 DgnECProviderId_View            = 0xEC05;

static const UInt16 DgnECProviderId_Attachment      = 0x5971;

static const UInt16 DgnECProviderId_Level           = 0x5972;
static const UInt16 DgnECProviderId_Invalid          = 0;
enum    ECSchemaPersistence ENUM_UNDERLYING_TYPE (byte)
    {
    ECSCHEMAPERSISTENCE_Unknown  = 0x00, 
    ECSCHEMAPERSISTENCE_Stored   = 0x01, 
    ECSCHEMAPERSISTENCE_External = 0x02, 
    ECSCHEMAPERSISTENCE_All      = 0xff, 
    };

struct SchemaInfoExt : RefCountedBase
{
private:
    virtual void MakeClassAbstract() = 0;
public:
};

typedef RefCountedPtr<SchemaInfoExt> SchemaInfoExtPtr; 

struct SchemaInfo
{
private:
    ECN::SchemaKey m_key;
    WString       m_providerName;
    DgnFileP      m_dgnFile;
    UInt32        m_elementcheckSum;
    bool          m_storedSchema;
    WString       m_location;
    SchemaInfoExtPtr m_extendedInfo;

public:
    
    DGNPLATFORM_EXPORT SchemaInfo (ECN::SchemaKeyCR schemaKey, DgnFileR file, WCharCP providerName=L"",  WCharCP location=L"", UInt32 checkSum=0, bool storedSchema=false);
    
    DGNPLATFORM_EXPORT bool operator==(SchemaInfoCR rhs) const;

    DGNPLATFORM_EXPORT bool operator < (SchemaInfoCR rhs) const;
    DGNPLATFORM_EXPORT void  SetSchemaName (WCharCP schemaName);
    
    DGNPLATFORM_EXPORT void  SetVersionMajor (UInt32 versionMajor);

    DGNPLATFORM_EXPORT void  SetVersionMinor (UInt32 versionMinor);

    DGNPLATFORM_EXPORT void  SetProviderName (WCharCP providerName);

    DGNPLATFORM_EXPORT void  SetLocation (WCharCP location);
    DGNPLATFORM_EXPORT void  SetElementCheckSum (UInt32 checkSum); 

    DGNPLATFORM_EXPORT void  SetStoredSchema (bool isStoredSchema); 

    void                     SetDgnFile (DgnFileR dgnFile);

    DGNPLATFORM_EXPORT WCharCP          GetSchemaName () const;
    DGNPLATFORM_EXPORT ECN::SchemaKeyCR  GetSchemaKey () const;
    DGNPLATFORM_EXPORT ECN::SchemaKeyR   GetSchemaKeyR ();
    DGNPLATFORM_EXPORT WCharCP          GetProviderName() const;
    DGNPLATFORM_EXPORT WCharCP          GetLocation() const;
    DGNPLATFORM_EXPORT UInt32           GetElementCheckSum() const; 
    DGNPLATFORM_EXPORT bool             IsStoredSchema() const; 
    DGNPLATFORM_EXPORT DgnFileR         GetDgnFile() const; 
};

enum SchemaImportStatus
    {
    SCHEMAIMPORT_Success                      = SUCCESS,
    SCHEMAIMPORT_SchemaAlreadyStoredInFile    = 1,
    SCHEMAIMPORT_NotValidECSchemaXml          = 2,
    SCHEMAIMPORT_FailedToWriteElement         = 3,
    SCHEMAIMPORT_FailedToSerializeAsXml       = 4,
    SCHEMAIMPORT_ProviderDoesNotSupportImport = 5,
    SCHEMAIMPORT_ProviderNotFound             = 6,
    SCHEMAIMPORT_FailedToDeserializeXmlFile   = 7,
    SCHEMAIMPORT_InvalidUserDefinedSchema     = 8,
    };

enum SchemaUpdateStatus
    {
    SCHEMAUPDATE_Success                                = SUCCESS,
    SCHEMAUPDATE_SchemaNotFound                         = 1,
    SCHEMAUPDATE_NotValidECSchemaXml                    = 2,
    SCHEMAUPDATE_FailedToWriteElement                   = 3,
    SCHEMAUPDATE_FailedToSerializeAsXml                 = 4,
    SCHEMAUPDATE_ProviderDoesNotSupportUpdate           = 5,
    SCHEMAUPDATE_ProviderNotFound                       = 6,
    SCHEMAUPDATE_FailedToDeserializeXmlFile             = 7,
    SCHEMAUPDATE_SchemaVersionMismatch                  = 8,

    // When updating instances referencing the updated schema
    SCHEMAUPDATE_ProviderDoesNotSupportInstanceUpdate   = 9,
    SCHEMAUPDATE_FailedToUpdateInstances                = 10,

    SCHEMAUPDATE_FailedToUpdateReferencingSchemas       = 11,
    };

enum SchemaDeleteStatus
    {
    SCHEMADELETE_Success                                = SUCCESS,
    SCHEMADELETE_SchemaNotFound                         = 1,
    SCHEMADELETE_ProviderNotFound                       = 2,
    SCHEMADELETE_ProviderDoesNotSupportDelete           = 3,
    SCHEMADELETE_SchemaHasStoredInstances               = 4,
    SCHEMADELETE_SchemaIsReferenced                     = 5,
    SCHEMADELETE_FailedToDeleteSchemaElement            = 6
    };

enum DeleteDgnECInstanceStatus
    {
    DELETEDGNECINSTANCE_Success                                = SUCCESS,
    DELETEDGNECINSTANCE_FileReadOnly                           = 1,
    DELETEDGNECINSTANCE_ProviderDoesNotSupportDelete           = 2,
    DELETEDGNECINSTANCE_UnableToParseInstanceId                = 3,
    DELETEDGNECINSTANCE_InvalidProviderId                      = 4,
    DELETEDGNECINSTANCE_InvalidOrDeletedElement                = 5,
    DELETEDGNECINSTANCE_UnableToLocateInstance                 = 6,
    DELETEDGNECINSTANCE_SchedulingDeleteNotSupportedByProvider = 7,
    DELETEDGNECINSTANCE_Error                                  = ERROR,
    };

typedef bmap<ECN::SchemaNameClassNamePair, bool>        ElementECClassInfo;


//---------------------------------------------------------------------------------------
// @bsimethod                                                    Bentley Systems
//---------------+---------------+---------------+---------------+---------------+-------
struct RelationshipEntry
    {
    //    private:
    WString                             RelationshipClassName;
    WString                             RelationshipSchemaName;
    ECN::ECRelatedInstanceDirection     RelatedInstanceDirection;
    ECN::StrengthType                   RelatedInstanceStrength;
    WString                             SourceClassName;
    WString                             SourceSchemaName;
    WString                             TargetClassName;
    WString                             TargetSchemaName;
    WString                             SourceInstanceId;
    WString                             TargetInstanceId;
    };
typedef bvector<RelationshipEntry>                      RelationshipEntryVector;

/*---------------------------------------------------------------------------------**/
struct IDgnECRelationshipProvider
    {
    };

struct IDgnECProvider : public ECN::IECProvider
    {

    DGNPLATFORM_EXPORT void FindECClassesOnElement(ElementRefP rootElement, ElementECClassInfo& classes) const;
    };

struct IDgnElementECProvider
    {
    };

typedef bmap<ECN::SchemaNameClassNamePair, DgnECInstanceEnablerP> InstanceEnablersByName;
typedef bmap<ECN::ECClassCP, DgnECInstanceEnablerP>           InstanceEnablersByClass;


/*---------------------------------------------------------------------------------**/
struct DgnECIntrinsicRelationshipProvider : IDgnECRelationshipProvider
    {
    };
END_BENTLEY_DGNPLATFORM_NAMESPACE

#pragma managed(pop)