DgnComponentHandlers.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 <DgnPlatform\ParametricCellHandlers.h>

DGNPLATFORM_TYPEDEFS (ParametricCellRemapTable);

BEGIN_BENTLEY_DGNPLATFORM_NAMESPACE


/*=================================================================================**/
struct IDgnComponentDefinitionHandler
    {
private:
    virtual void MakeClassAbstract() = 0;
public:
public:
    virtual ~IDgnComponentDefinitionHandler() {}
    DGNPLATFORM_EXPORT  IParameterDefinitionsPtr                GetParameterDefinitions() const;
    DGNPLATFORM_EXPORT  IParameterSetCollectionPtr              GetParameterSets() const;
    DGNPLATFORM_EXPORT  IDgnComponentDefinitionModelHandlerCP   GetDefinitionModelHandler() const;
    };

/*---------------------------------------------------------------------------------**/
struct ParametricCellRemapTable
    {
private:
    typedef bmap<WString, WString>  RemapTable;

    RemapTable      m_variations;
    RemapTable      m_variables;

    static WCharCP                  GetRemappedValue (WCharCP toRemap, RemapTable const& table);
    static bool                     SetRemappedValue (WCharCP remapFrom, WCharCP remapTo, RemapTable& table);
public:
    DGNPLATFORM_EXPORT WCharCP      ResolveParameterSet (WCharCP oldParameterSetName) const;
    DGNPLATFORM_EXPORT WCharCP      ResolveVariable (WCharCP oldVariableAccessString) const;

    DGNPLATFORM_EXPORT bool         RemapParameterSet (WCharCP remapFrom, WCharCP remapTo);
    DGNPLATFORM_EXPORT bool         RemapVariable (WCharCP remapFromAccessString, WCharCP remapToAccessString);

    DGNPLATFORM_EXPORT void         Clear();

    typedef RemapTable::const_iterator  VariableIterator;
    VariableIterator                begin() const   { return m_variables.begin(); }
    VariableIterator                end() const     { return m_variables.end(); }

    typedef RemapTable::const_iterator  ParameterSetIterator;
    ParameterSetIterator            BeginParameterSets() const  { return m_variations.begin(); }
    ParameterSetIterator            EndParameterSets() const    { return m_variations.end(); }
    };

/*---------------------------------------------------------------------------------**/
enum class UpdateParametricCellDefStatus
    {
    Success                     = SUCCESS,  
    SchemasDiffer               = 1,        
    ReadOnly,                               
    CellNotFound,                           

    Error                       = ERROR,    
    };

/*---------------------------------------------------------------------------------**/
struct IDgnComponentDefinitionModelHandler : IDgnComponentDefinitionHandler
    {
private:
    virtual void MakeClassAbstract() = 0;
public:
public:
    DGNPLATFORM_EXPORT ParameterStatus                  CreateParameterSet (IParameterSetPtr& parameterSet, WCharCP name, WCharCP description, IParameterValuesCR values) const;

    DGNPLATFORM_EXPORT ParameterStatus                  DeleteParameterSet (IParameterSetR parameterSet) const;

    DGNPLATFORM_EXPORT ParameterStatus                  CreateCellDefinition (DgnFileR targetFile) const;

    DGNPLATFORM_EXPORT UpdateParametricCellDefStatus    UpdateCellDefinition (DgnFileR targetFile, ParametricCellRemapTableCR remapTable) const;

    DGNPLATFORM_EXPORT void                             InitializeRemapTable (ParametricCellRemapTableR remapTable, ParametricCellDefinitionCR cellDef) const;
    };
END_BENTLEY_DGNPLATFORM_NAMESPACE