ECDBuffer.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 once

#include "ECObjects.h"


EC_TYPEDEFS(ECDBuffer);
EC_TYPEDEFS(ScopedDataAccessor);
BEGIN_BENTLEY_ECOBJECT_NAMESPACE
    
typedef uint32_t NullflagsBitmask;
typedef uint16_t ClassIndex;
typedef uint16_t SchemaIndex;
typedef RefCountedPtr<ClassLayout> ClassLayoutPtr;


enum ArrayModifierFlags ENUM_UNDERLYING_TYPE (uint32_t)
    {
    PROPERTYLAYOUTMODIFIERFLAGS_None              = 0x00,
    PROPERTYLAYOUTMODIFIERFLAGS_IsArrayFixedCount = 0x01,
    PROPERTYLAYOUTMODIFIERFLAGS_IsReadOnly        = 0x02,
    PROPERTYLAYOUTMODIFIERFLAGS_IsCalculated      = 0x04
    };

/*=================================================================================**/
struct PropertyLayout
    {
private:
    PropertyLayout (){}

public:
    ECOBJECTS_EXPORT WCharCP                     GetAccessString() const;       
    ECOBJECTS_EXPORT uint32_t                    GetParentStructIndex() const;  
    ECOBJECTS_EXPORT uint32_t                    GetOffset() const;             
    ECOBJECTS_EXPORT uint32_t                    GetNullflagsOffset() const;    
    ECOBJECTS_EXPORT NullflagsBitmask            GetNullflagsBitmask() const;   
    ECOBJECTS_EXPORT ECTypeDescriptor            GetTypeDescriptor() const;     

    ECOBJECTS_EXPORT uint32_t                    GetModifierFlags() const; 
    ECOBJECTS_EXPORT uint32_t                    GetModifierData() const;       
    ECOBJECTS_EXPORT bool                        IsReadOnlyProperty () const;   

    ECOBJECTS_EXPORT bool                        SetReadOnlyMask (bool readOnly);
    ECOBJECTS_EXPORT bool                        IsFixedSized() const; 
    ECOBJECTS_EXPORT bool                        HoldsCalculatedProperty() const; 

    ECOBJECTS_EXPORT uint32_t                     GetSizeInFixedSection() const;
    
    ECOBJECTS_EXPORT WString                      ToString();
    };

 /*=================================================================================**/
struct ClassLayout : RefCountedBase
    {
private:
    //ClassLayout (){}

public:

    ECOBJECTS_EXPORT static ClassLayoutPtr BuildFromClass (ECClassCR ecClass);

    ECOBJECTS_EXPORT static ClassLayoutPtr CreateEmpty    (WCharCP  className);

    ECOBJECTS_EXPORT WString const & GetECClassName() const; 

    ECOBJECTS_EXPORT int            GetECPointerIndex (ECRelationshipEnd end) const;
    
    ECOBJECTS_EXPORT uint32_t        GetChecksum () const;

    ECOBJECTS_EXPORT uint32_t        GetPropertyCount () const;

    ECOBJECTS_EXPORT uint32_t        GetPropertyCountExcludingEmbeddedStructs () const;

    ECOBJECTS_EXPORT ECObjectsStatus GetPropertyLayout (PropertyLayoutCP & propertyLayout, WCharCP accessString) const;

    ECOBJECTS_EXPORT ECObjectsStatus GetPropertyLayoutByIndex (PropertyLayoutCP & propertyLayout, uint32_t propertyIndex) const;

    ECOBJECTS_EXPORT ECObjectsStatus GetPropertyLayoutIndex (uint32_t& propertyIndex, PropertyLayoutCR propertyLayout) const;

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

    ECOBJECTS_EXPORT bool            IsPropertyReadOnly (uint32_t propertyIndex) const;

    ECOBJECTS_EXPORT bool            SetPropertyReadOnly (uint32_t propertyIndex, bool readOnly) const;
    
    ECOBJECTS_EXPORT uint32_t       CalculateBytesUsed(Byte const * propertyData) const;

    ECOBJECTS_EXPORT bool           IsCompatible(ClassLayoutCR layout) const;

    ECOBJECTS_EXPORT WString       ToString() const;
    };

typedef RefCountedPtr<ClassLayout>  ClassLayoutPtr;
typedef bvector<ClassLayoutPtr>     ClassLayoutVector;

/*=================================================================================**/
struct SchemaLayout
{
private:
    SchemaLayout (){}

public:

    ECOBJECTS_EXPORT SchemaIndex            GetSchemaIndex() const;

    ECOBJECTS_EXPORT BentleyStatus          AddClassLayout (ClassLayoutR classLayout, ClassIndex classIndex);

    ECOBJECTS_EXPORT BentleyStatus          ReplaceClassLayout (ClassLayoutR classLayout, ClassIndex classIndex);

    ECOBJECTS_EXPORT ClassLayoutCP          GetClassLayout (ClassIndex classIndex) const;

    ECOBJECTS_EXPORT ClassLayoutCP          FindClassLayout (WCharCP className) const;

    ECOBJECTS_EXPORT BentleyStatus          FindClassIndex (ClassIndex& classIndex, WCharCP className) const;

    ECOBJECTS_EXPORT BentleyStatus          FindAvailableClassIndex (ClassIndex& classIndex) const;
   
    ECOBJECTS_EXPORT uint32_t               GetMaxIndex () const;

    ECOBJECTS_EXPORT bool                   IsEmpty() const;

    ECOBJECTS_EXPORT static SchemaLayoutP   Create (SchemaIndex index);
};

//=======================================================================================
//=======================================================================================
struct ECDBuffer
    {
    friend  struct ArrayResizer;
    friend  struct ECDBufferScope;
private:
    mutable bool        m_allowWritingDirectlyToInstanceMemory;
    mutable bool        m_allPropertiesCalculated;

private:
    virtual void MakeClassAbstract() = 0;
public:
public:
    ECOBJECTS_EXPORT bool                   IsEmpty() const;
    ECOBJECTS_EXPORT void                   ClearValues();
    ECOBJECTS_EXPORT ECObjectsStatus        CopyFromBuffer (ECDBufferCR source);
    };   

END_BENTLEY_ECOBJECT_NAMESPACE