Public Member Functions | List of all members
IActiveParameters Struct Referenceabstract

Holds the "active" values of the parameters within a parametric model. More...

#include <ParametricModeling.h>

Inheritance diagram for IActiveParameters:
RefCountedBase IParameterValues RefCounted< IRefCounted > IRefCounted IParameterDefinitions IEditParameterDefinitions

Public Member Functions

DGNPLATFORM_EXPORT ElementHandle GetDependencyRoot () const
 Returns the element to which property and constraint dependencies are bound. More...
 
DGNPLATFORM_EXPORT ParameterStatus ApplyParameters (IParameterValuesCR values)
 Applies the specified values to the active parameters. More...
 
- Public Member Functions inherited from RefCounted< IRefCounted >
void * operator new (size_t size)
 
void operator delete (void *rawMemory, size_t size)
 
UInt32 AddRef () const
 
UInt32 Release () const
 
 RefCounted ()
 
 RefCounted (RefCounted const &rhs)
 
RefCountedoperator= (RefCounted const &rhs)
 
UInt32 GetRefCount () const
 
- Public Member Functions inherited from IParameterValues
DGNPLATFORM_EXPORT
ECN::IECInstanceR 
GetProperties ()
 
DGNPLATFORM_EXPORT DgnModelR GetHostModel () const
 Returns the model in which the parameter values are hosted. More...
 
DGNPLATFORM_EXPORT
ECN::ECObjectsStatus 
GetValue (ECN::ECValueR v, WCharCP accessString, ParameterUnits units=ParameterUnits::Storage) const
 Attempts to retrieve the value of a parameter by access string. More...
 
DGNPLATFORM_EXPORT
ECN::IECInstanceCR 
GetProperties () const
 Returns these parameter values as a collection of DgnECInstances. More...
 
DGNPLATFORM_EXPORT bool IsReadOnly () const
 Returns whether the values held by this object are read-only. If it returns true, methods like SetValue() and WriteValues() which attempt to modify the values will fail. More...
 
DGNPLATFORM_EXPORT
ECN::ECObjectsStatus 
SetValue (WCharCP accessString, ECN::ECValueCR value, ParameterUnits units=ParameterUnits::Storage)
 Modifies the value of the specified parameter in memory. The change does not become persistent until WriteValues() is invoked. More...
 
DGNPLATFORM_EXPORT ParameterStatus WriteValues ()
 Writes any changes made via SetValue() persistently. More...
 

Additional Inherited Members

- Protected Member Functions inherited from RefCounted< IRefCounted >
virtual ~RefCounted ()
 
- Protected Member Functions inherited from IRefCounted
virtual ~IRefCounted ()
 
void * operator new (size_t size)
 
void operator delete (void *rawMemory, size_t size)
 

Detailed Description

Holds the "active" values of the parameters within a parametric model.

Properties and constraints within the model can be bound to the active parameters such that modifying the value of an active parameter updates the values of all bound properties and constraints. The update mechanism is based on a dependency between the element hosting the bound property and a "dependency root" element defined by the parametric model.

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

Member Function Documentation

DGNPLATFORM_EXPORT ParameterStatus ApplyParameters ( IParameterValuesCR  values)

Applies the specified values to the active parameters.

DGNPLATFORM_EXPORT ElementHandle GetDependencyRoot ( ) const

Returns the element to which property and constraint dependencies are bound.


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

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