Public Member Functions | List of all members
IDgnComponentDefinitionModelHandler Struct Referenceabstract

Handler responsible for managing a DgnModel which can serve as a "definition model" for parametric modeling. More...

#include <DgnComponentHandlers.h>

Inheritance diagram for IDgnComponentDefinitionModelHandler:
IDgnComponentDefinitionHandler

Public Member Functions

DGNPLATFORM_EXPORT ParameterStatus CreateParameterSet (IParameterSetPtr &parameterSet, WCharCP name, WCharCP description, IParameterValuesCR values) const
 Creates a new parameter set. More...
 
DGNPLATFORM_EXPORT ParameterStatus DeleteParameterSet (IParameterSetR parameterSet) const
 Deletes the specified parameter set. More...
 
DGNPLATFORM_EXPORT ParameterStatus CreateCellDefinition (DgnFileR targetFile) const
 Creates a parametric cell definition element (and associated hidden cell model) from this handler's model in the specified DgnFile. More...
 
DGNPLATFORM_EXPORT
UpdateParametricCellDefStatus 
UpdateCellDefinition (DgnFileR targetFile, ParametricCellRemapTableCR remapTable) const
 Updates the parametric cell definition having the same name as this handler's model in the specified DgnFile to match the current state of the definition model. More...
 
DGNPLATFORM_EXPORT void InitializeRemapTable (ParametricCellRemapTableR remapTable, ParametricCellDefinitionCR cellDef) const
 Initializes a table of remappings between current and updated parameter set and parameter definition names, used when updating a parametric cell definition. More...
 
- Public Member Functions inherited from IDgnComponentDefinitionHandler
virtual ~IDgnComponentDefinitionHandler ()
 
DGNPLATFORM_EXPORT
IParameterDefinitionsPtr 
GetParameterDefinitions () const
 Returns the parameter definitions associated with the model managed by this handler. More...
 
DGNPLATFORM_EXPORT
IParameterSetCollectionPtr 
GetParameterSets () const
 Returns a collection of all parameter sets defined for the model managed by this handler. More...
 
DGNPLATFORM_EXPORT
IDgnComponentDefinitionModelHandlerCP 
GetDefinitionModelHandler () const
 If the model managed by this handler can serve as a "definition model" for parametric modeling purposes, returns a handler which exposes that functionality; or else returns null. More...
 

Detailed Description

Handler responsible for managing a DgnModel which can serve as a "definition model" for parametric modeling.

In general, a definition model can be freely edited by the user, and placed as a parametric cell. Upon placement, a new, read-only cell model is created from the definition model.

Remarks
Required library : DgnPlatform<ApiNumber>.lib i.e. DgnPlatform5.lib

Member Function Documentation

DGNPLATFORM_EXPORT ParameterStatus CreateCellDefinition ( DgnFileR  targetFile) const

Creates a parametric cell definition element (and associated hidden cell model) from this handler's model in the specified DgnFile.

Parameters
[in]targetFileThe DgnFile in which to create the parametric cell definition
Returns
Success if the cell definition was created, or else an error code.
DGNPLATFORM_EXPORT ParameterStatus CreateParameterSet ( IParameterSetPtr &  parameterSet,
WCharCP  name,
WCharCP  description,
IParameterValuesCR  values 
) const

Creates a new parameter set.

Parameters
[out]parameterSetHolds the created parameter set.
[in]nameThe name of the new parameter set. Must be non-empty and unique within all existing parameter sets.
[in]descriptionThe description of the new parameter set, or null if no description is desired.
[in]valuesThe initial values of all parameters for the new parameter set. The values must come from this handler's DgnModel.
Returns
Success if the parameter set was created, or else an error code.
DGNPLATFORM_EXPORT ParameterStatus DeleteParameterSet ( IParameterSetR  parameterSet) const

Deletes the specified parameter set.

Parameters
[in]parameterSetThe parameter set to delete
Returns
Success if the parameter set was deleted, or else an error code
DGNPLATFORM_EXPORT void InitializeRemapTable ( ParametricCellRemapTableR  remapTable,
ParametricCellDefinitionCR  cellDef 
) const

Initializes a table of remappings between current and updated parameter set and parameter definition names, used when updating a parametric cell definition.

Parameters
[in]remapTableThe table which will be initialized with default remappings
[in]cellDefThe existing parametric cell definition which is to be updated.
DGNPLATFORM_EXPORT UpdateParametricCellDefStatus UpdateCellDefinition ( DgnFileR  targetFile,
ParametricCellRemapTableCR  remapTable 
) const

Updates the parametric cell definition having the same name as this handler's model in the specified DgnFile to match the current state of the definition model.

Parameters
[in]targetFileThe DgnFile containing the cell definition to be updated
[in]remapTableIndicates how to remap names of parameter sets and parameter definitions between the previous and updated cell definitions
Returns
Success if the cell definition and all cell instances were updated, or else an error code

The documentation for this struct was generated from the following file:

Copyright © 2017 Bentley Systems, Incorporated. All rights reserved.