DgnECManager.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 "DgnECProviders.h"
#include <DgnPlatform/ITxnManager.h>
BEGIN_BENTLEY_DGNPLATFORM_NAMESPACE


enum    ReferencedModelScopeOption ENUM_UNDERLYING_TYPE (byte)
    {
    REFERENCED_MODEL_SCOPE_All          = 0,    
    REFERENCED_MODEL_SCOPE_DirectOnly   = 1,    
    REFERENCED_MODEL_SCOPE_None         = 2     
    };



struct DgnECManager :public DgnHost::IHostObject
{
private:
    virtual void MakeClassAbstract() = 0;
public:
public:
    DGNPLATFORM_EXPORT static DgnECManagerR GetManager();


    DGNPLATFORM_EXPORT UInt32           AppendECInstancesToModel (bvector<ECN::StandaloneECInstancePtr> const& ecInstances, DgnModelR dgnModel);

    DGNPLATFORM_EXPORT BentleyStatus    ReadECInstancesFromModel (bvector<ECN::IECInstancePtr>& ecInstances, DgnModelR dgnModel);

    DGNPLATFORM_EXPORT UInt32           RemoveECInstancesFromModel (DgnModelR model, WCharCP schemaName, WCharCP className, Int32 firstIndex, Int32 count);

    DGNPLATFORM_EXPORT UInt32           RemoveECInstancesFromModel (DgnModelR model, bvector<ECN::IECInstancePtr>& instancesToRemove);

    
    DGNPLATFORM_EXPORT ECN::ECObjectsStatus   CreateSchema (ECN::ECSchemaPtr& schemaHolder, WCharCP schemaName, UInt32 majorVersion, UInt32 minorVersion, DgnFileP file);

    DGNPLATFORM_EXPORT ECN::SchemaReadStatus  ReadSchemaFromXmlString (ECN::ECSchemaPtr& schema, WCharCP schemaAsXml, DgnFileP dgnFile, bvector<WString>* searchPaths = NULL);

    DGNPLATFORM_EXPORT ECN::SchemaReadStatus ReadSchemaFromXmlFile (ECN::ECSchemaPtr& schemaHolder, WCharCP ecSchemaXmlFilename, DgnFileP dgnFile, bvector<WString>* searchPaths = NULL);

    DGNPLATFORM_EXPORT ECN::ECInstanceReadContextPtr CreateECInstanceReadContext (ECN::ECSchemaR schema, DgnFileR dgnFile);
 
    DGNPLATFORM_EXPORT IDgnECProviderP      GetProviderById (UInt16 providerId) const;

    DGNPLATFORM_EXPORT DgnECInstanceEnablerP ObtainInstanceEnablerByName (WCharCP schemaName, WCharCP className, DgnFileR dgnFile);

    DGNPLATFORM_EXPORT DgnECInstanceEnablerP ObtainInstanceEnabler (ECN::ECClassCR ecClass, DgnFileR file);

    DGNPLATFORM_EXPORT DgnECInstanceIterable FindInstances (FindInstancesScopeR scope, ECQueryCR query, UInt32* count = NULL);
 
    DGNPLATFORM_EXPORT static InstanceCountIterable GetInstanceCounts(FindInstancesScopeR scope, const SearchClassList & requestedClasses, ECQueryProcessFlags searchFlags = ECQUERY_PROCESS_SearchAllClasses);

    DGNPLATFORM_EXPORT DgnElementECInstancePtr  FindInstanceOnElement (ElementHandleCR el, ECN::ECClassCR ecClass, bool polymorphic=false) const;

    DGNPLATFORM_EXPORT DgnECInstanceIterable FindRelatedInstances (DgnECInstanceCR sourceInstance, QueryRelatedClassSpecifierCR relationshipClassSpecifier, DgnECInstanceCreateContextCR createContext) const;

    DGNPLATFORM_EXPORT void FindRelationshipEntriesOnElement(ElementRefP rootElement, RelationshipEntryVector& entries) const;

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

    DGNPLATFORM_EXPORT void             DiscoverSchemas (bvector<SchemaInfo>& infos, DgnFileR dgnFile, ECSchemaPersistence persistence = ECSCHEMAPERSISTENCE_Stored, DgnECHostType hostType = DgnECHostType::All);

    DGNPLATFORM_EXPORT void             DiscoverSchemasForModel (bvector<SchemaInfo>& schemaInfoVector, DgnModelR dgnModel, ECSchemaPersistence persistence=ECSCHEMAPERSISTENCE_Stored, ReferencedModelScopeOption scopeOption = REFERENCED_MODEL_SCOPE_None);

    DGNPLATFORM_EXPORT bool             IsSchemaContainedWithinFile(SchemaInfoR schemaInfo, ECN::SchemaMatchType matchType);

    DGNPLATFORM_EXPORT ECN::ECSchemaPtr  LocateSchemaInDgnFile (SchemaInfoR schemaInfo, ECN::SchemaMatchType matchType, bool includeDeliveredSchemas = true);

    DGNPLATFORM_EXPORT DeleteDgnECInstanceStatus  DeleteDgnECInstance (WCharCP instanceIdStringP, DgnModelRefP dependentModel, bool ignoreElementOwnership) const;

    DGNPLATFORM_EXPORT DeleteDgnECInstanceStatus  DeleteDgnECInstance (ElementRefP elementRef, UInt32 localId, bool ignoreElementOwnership, UInt16 providerId=DgnECProviderId_ECXAttributes) const;

    DGNPLATFORM_EXPORT DeleteDgnECInstanceStatus  ScheduleDeleteDgnECInstance (EditElementHandleR element, UInt32 localId, bool ignoreElementOwnership=false, UInt16 providerId=DgnECProviderId_ECXAttributes) const;


    
    DGNPLATFORM_EXPORT SchemaImportStatus   ImportSchema (ECN::ECSchemaR schema, DgnFileR dgnFile, bool isExternalSchema=false, bool importReferencedSchemas=true);

    DGNPLATFORM_EXPORT SchemaUpdateStatus   UpdateSchema (ECN::ECSchemaR schema, DgnFileR dgnFile, bool isExternalSchema=false);

    DGNPLATFORM_EXPORT ECN::StandaloneECRelationshipInstancePtr CreateWipRelationshipByName (WCharCP schemaName, WCharCP className, DgnFileR dgnFile);

    DGNPLATFORM_EXPORT DgnECRelationshipEnablerP ObtainDgnECRelationshipEnabler (WCharCP schemaName, WCharCP className, DgnFileR dgnFile);

    DGNPLATFORM_EXPORT BentleyStatus CreateRelationship (IDgnECRelationshipInstancePtr *createdRelationship, DgnECRelationshipEnablerCR relationshipEnabler, 
                                                         ECN::StandaloneECRelationshipInstanceR wipRelationship,
                                                         DgnElementECInstanceCR instanceA, DgnElementECInstanceCR instanceB, DgnModelRefP hostModelRef=NULL, ElementRefP  hostElementRef=NULL) const;

    DGNPLATFORM_EXPORT BentleyStatus CreateRelationship (IDgnECRelationshipInstancePtr *createdRelationship, DgnECRelationshipEnablerCR relationshipEnabler, 
                                                         DgnElementECInstanceCR instanceA, DgnElementECInstanceCR instanceB, DgnModelRefP hostModelRef=NULL, ElementRefP  hostElementRef=NULL) const;

    DGNPLATFORM_EXPORT BentleyStatus    DeleteRelationship (DgnElementECInstanceCR sourceDgnInstance, DgnElementECInstanceCR targetDgnInstance, ECN::ECRelationshipClassCR relationshipClass);

};

END_BENTLEY_DGNPLATFORM_NAMESPACE

#pragma managed(pop)