DgnECTypes.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)

DGNPLATFORM_TYPEDEFS (DgnECExtendedType);
DGNPLATFORM_TYPEDEFS (IDgnECTypeAdapterContext);
DGNPLATFORM_TYPEDEFS (IDgnECTypeAdapter);
DGNPLATFORM_TYPEDEFS (IDgnECStandaloneTypeAdapterContext);
DGNPLATFORM_TYPEDEFS (DgnECUnit);

BEGIN_BENTLEY_DGNPLATFORM_NAMESPACE

typedef RefCountedPtr<IDgnECTypeAdapter> IDgnECTypeAdapterPtr;



/*=================================================================================**/
struct DgnECExtendedType
    {
    friend struct DgnECTypeRegistry;

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

    /*=================================================================================**/
    enum StandardType
        {
        ElementType                         = 1,
        Level                               = 2,
        Color                               = 3,
        Weight                              = 4,
        Style                               = 5,
        ElementClass                        = 6,
        Coordinates                         = 7,
        Distance                            = 8,
        Area                                = 9,
        Volume                              = 10,
        Angle                               = 11,
        TextStyle                           = 15,
        RenderingMaterial                   = 16,
        DirectionAngle                      = 17,
        UnitlessPoint                       = 18,
        NamedScale                          = 19,
        ProjectionNamedGroup                = 20,
        FileSize                            = 24,
        FileSizeLong                        = 25,
        DisplayPriority                     = 26,

        FontName                            = 27,
        BigFontName                         = 28,
        ElementID                           = 29,
        HatchCell                           = 30,
        XyzRotations                        = 57,
        UnitDefinition                      = 58,
        };
    };

/*=================================================================================**/
typedef RefCountedPtr<IDgnECTypeAdapterContext> IDgnECTypeAdapterContextPtr;
typedef RefCountedPtr<IDgnECStandaloneTypeAdapterContext> IDgnECStandaloneTypeAdapterContextPtr;
struct IDgnECTypeAdapterContext : ECN::IECTypeAdapterContext
    {
public:
    DGNPLATFORM_EXPORT static IDgnECTypeAdapterContextPtr   Create (ECN::ECPropertyCR ecproperty, DgnECInstanceCR instance, WCharCP accessString, UInt32 componentIndex = COMPONENT_INDEX_None);
    DGNPLATFORM_EXPORT static IDgnECStandaloneTypeAdapterContextPtr   CreateStandalone (ECN::ECPropertyCR ecproperty, ECN::IECInstanceCR instance, WCharCP accessString, UInt32 componentIndex=COMPONENT_INDEX_None, DgnFileP dgnFile=NULL, DgnModelRefP modelRef=NULL, ElementRefP elemRef=NULL);
    };

/*=================================================================================**/
struct IDgnECStandaloneTypeAdapterContext : IDgnECTypeAdapterContext
    {
public:
    DGNPLATFORM_EXPORT bool                 ReInitialize (ECN::ECPropertyCR ecproperty, ECN::IECInstanceCR instance, WCharCP accessString, UInt32 componentIndex=COMPONENT_INDEX_None, DgnFileP dgnFile=NULL, DgnModelRefP modelRef=NULL, ElementRefP elemRef=NULL);
    };

/*=================================================================================**/
struct IDgnECTypeAdapter : ECN::IECTypeAdapter
    {
public:
    DGNPLATFORM_EXPORT bool                 Validate (ECN::ECValueCR v, IDgnECTypeAdapterContextCR context) const;

    DGNPLATFORM_EXPORT bool                 GetStandardValues (StandardValuesCollection& values, IDgnECTypeAdapterContextCR context) const;

    DGNPLATFORM_EXPORT static IDgnECTypeAdapterR    GetForProperty (ECN::ECPropertyCR ecProperty);

    DGNPLATFORM_EXPORT static IDgnECTypeAdapterR    GetForArrayMember (ECN::ArrayECPropertyCR arrayProperty);

    };


/*=================================================================================**/
struct DgnECUnit
    {
public:
    enum WorkingUnit
        {
        Distance,           
        Area,               
        Volume,             
        Angle,              
        Unspecified = 0xFF  
        };
private:
    WString             m_ecunitName;
    WorkingUnit         m_workingUnit;
public:
    DgnECUnit (WorkingUnit workingUnit = Unspecified) : m_workingUnit(workingUnit) { }
    DgnECUnit (WCharCP standardECUnitName) : m_ecunitName (standardECUnitName), m_workingUnit (Unspecified) { }

    bool                IsSpecified() const         { return IsECUnit() || IsWorkingUnit(); }
    bool                IsECUnit() const        { return !m_ecunitName.empty(); }
    bool                IsWorkingUnit() const   { return Unspecified != m_workingUnit; }

    DGNPLATFORM_EXPORT WCharCP  GetECUnitName() const  { return !m_ecunitName.empty() ? m_ecunitName.c_str() : NULL; }
    WorkingUnit                 GetWorkingUnit() const { return m_workingUnit; }
    DGNPLATFORM_EXPORT WCharCP  GetID() const;
    DGNPLATFORM_EXPORT static DgnECUnit FromID (WCharCP id);
    };
END_BENTLEY_DGNPLATFORM_NAMESPACE

#pragma managed(pop)