ECEnabler.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/ECObjects.h>
#include <ECObjects/ECInstance.h>
#include <ECObjects/ECSchema.h>
#include <Bentley/RefCounted.h>
#include <Bentley/bset.h>

BEGIN_BENTLEY_ECOBJECT_NAMESPACE

typedef RefCountedPtr<StandaloneECEnabler>              StandaloneECEnablerPtr;
typedef RefCountedPtr<ECEnabler>                        ECEnablerPtr;
typedef RefCountedPtr<StandaloneECRelationshipInstance> StandaloneECRelationshipInstancePtr;

#define INVALID_PROPERTY_INDEX  0;

//=======================================================================================    
//=======================================================================================    
struct ECEnabler : RefCountedBase
    {
    struct IPropertyProcessor 
        {
        virtual bool _ProcessPrimitiveProperty (IECInstance const& instance, WCharCP propName, ECValue const& propValue) const = 0;
        };

#if defined (EXPERIMENTAL_TEXT_FILTER)
    enum PropertyProcessingResult  {PROPERTY_PROCESSING_RESULT_Miss=0, PROPERTY_PROCESSING_RESULT_Hit=1, PROPERTY_PROCESSING_RESULT_NoCandidates=3};
    enum PropertyProcessingOptions {PROPERTY_PROCESSING_OPTIONS_SingleType=0, PROPERTY_PROCESSING_OPTIONS_AllTypes=1};
#endif

public:
    ECOBJECTS_EXPORT WCharCP                    GetName() const;

    ECOBJECTS_EXPORT ECClassCR                  GetClass() const;

    ECOBJECTS_EXPORT ECObjectsStatus            GetPropertyIndex     (uint32_t& propertyIndex, WCharCP propertyAccessString) const;

    ECOBJECTS_EXPORT ECObjectsStatus            GetAccessString      (WCharCP& propertyAccessString, uint32_t propertyIndex) const;

    ECOBJECTS_EXPORT uint32_t                   GetFirstPropertyIndex (uint32_t parentIndex) const;

    ECOBJECTS_EXPORT uint32_t                   GetNextPropertyIndex  (uint32_t parentIndex, uint32_t inputIndex) const;

    ECOBJECTS_EXPORT bool                       HasChildProperties (uint32_t parentIndex) const;

    ECOBJECTS_EXPORT uint32_t                   GetParentPropertyIndex (uint32_t childIndex) const;

    ECOBJECTS_EXPORT ECObjectsStatus         GetPropertyIndices (bvector<uint32_t>& indices, uint32_t parentIndex) const;

    ECOBJECTS_EXPORT IStandaloneEnablerLocaterR GetStandaloneEnablerLocater();

    ECOBJECTS_EXPORT StandaloneECEnablerPtr     GetEnablerForStructArrayMember (SchemaKeyCR schemaKey, WCharCP className); 
    
#if defined (EXPERIMENTAL_TEXT_FILTER)
    //  also add the class to \a failedClasses.
    ECOBJECTS_EXPORT PropertyProcessingResult ProcessPrimitiveProperties (bset<ECClassCP>& failedClasses, IECInstanceCR instance, ECN::PrimitiveType primitiveType, IPropertyProcessor const& proc, PropertyProcessingOptions opts = PROPERTY_PROCESSING_OPTIONS_SingleType) const;
#endif
    };


//=======================================================================================    
//=======================================================================================    
 struct IECRelationshipEnabler
 {
protected:
    virtual StandaloneECRelationshipInstancePtr _CreateWipRelationshipInstance () const = 0;

    virtual ECN::ECRelationshipClassCR     _GetRelationshipClass() const = 0;

 public:
    ECOBJECTS_EXPORT StandaloneECRelationshipInstancePtr  CreateWipRelationshipInstance() const;
    ECOBJECTS_EXPORT ECN::ECRelationshipClassCR      GetRelationshipClass() const;
 };

END_BENTLEY_ECOBJECT_NAMESPACE