ECContext.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 "ECObjects.h"
#include <Geom/GeomApi.h>
#include <ECObjects/StandaloneECInstance.h>

BEGIN_BENTLEY_ECOBJECT_NAMESPACE

typedef RefCountedPtr<ECSchemaReadContext>      ECSchemaReadContextPtr;
//=======================================================================================
//=======================================================================================
struct ECSchemaReadContext : RefCountedBase
{
    static const int CATEGORY_PARTITION_SIZE = 5000;
    enum PriorityPartiion
        {
        ReaderContext   = -1* CATEGORY_PARTITION_SIZE, //Whatever we found is off highest priority
        UserSpace       = 0*  CATEGORY_PARTITION_SIZE,
        External        = 1*  CATEGORY_PARTITION_SIZE,
        StandardPaths   = 2*  CATEGORY_PARTITION_SIZE,
        Final           = 3*  CATEGORY_PARTITION_SIZE,
        };

private:
    virtual void MakeClassAbstract() = 0;
public:
public:

    ECOBJECTS_EXPORT static ECSchemaReadContextPtr CreateContext (IStandaloneEnablerLocaterP standaloneEnablerLocater, bool acceptLegacyImperfectLatestCompatibleMatch = false);

    ECOBJECTS_EXPORT static ECSchemaReadContextPtr CreateContext (bool acceptLegacyImperfectLatestCompatibleMatch = false);

        ECOBJECTS_EXPORT void AddSchemaLocater (IECSchemaLocaterR locater, uint32_t priority = 0);

    ECOBJECTS_EXPORT void RemoveSchemaLocater (IECSchemaLocaterR locater);

    ECOBJECTS_EXPORT void AddSchemaPath (WCharCP path);

    ECOBJECTS_EXPORT void AddCulture(WCharCP culture);

    ECOBJECTS_EXPORT bvector<WString>* GetCultures();

    ECOBJECTS_EXPORT void SetFinalSchemaLocater (IECSchemaLocaterR locater);

    ECOBJECTS_EXPORT ECSchemaPtr         LocateSchema (SchemaKeyR key, SchemaMatchType matchType);

    ECOBJECTS_EXPORT ECSchemaCacheR GetCache ();
};

typedef RefCountedPtr<ECInstanceReadContext>      ECInstanceReadContextPtr;
//=======================================================================================
//=======================================================================================
struct ECInstanceReadContext : RefCountedBase
{
    // InstanceXml does not contain primitive type information. An IPrimitiveTypeResolver can assist the
    // ECInstanceReadContext in determining the type of a serialized primitive value.
    // If no IPrimitiveTypeResolver is supplied, the primitive type defined for the ECProperty is used.
    struct IPrimitiveTypeResolver
        {
        };

private:
    virtual void MakeClassAbstract() = 0;
public:
public:

    ECOBJECTS_EXPORT static ECInstanceReadContextPtr CreateContext (ECSchemaCR, IStandaloneEnablerLocaterP = NULL, IPrimitiveTypeResolver const* typeResolver = NULL);

    ECOBJECTS_EXPORT static ECInstanceReadContextPtr CreateContext (ECSchemaReadContextR, ECSchemaCR fallBackSchema, ECSchemaPtr* foundSchema);
};
END_BENTLEY_ECOBJECT_NAMESPACE