A named set of parameter values, representing a "variation" on a parametric model. More...
#include <ParametricModeling.h>
Public Member Functions | |
| DGNPLATFORM_EXPORT WString | GetName () const |
| Returns the name of this parameter set. More... | |
| DGNPLATFORM_EXPORT WString | GetDescription () const |
| Returns the optional description of this parameter set. More... | |
| DGNPLATFORM_EXPORT bool | SetName (WCharCP name) |
| Sets the name of this parameter set. The name must be unique and non-empty. More... | |
| DGNPLATFORM_EXPORT bool | SetDescription (WCharCP desc) |
| Sets the optional description of this parameter set. More... | |
| DGNPLATFORM_EXPORT Int32 | GetSortOrder () const |
| Returns the sorting order of this parameter set. More... | |
| DGNPLATFORM_EXPORT bool | SetSortOrder (Int32 priority) |
| Sets the sorting priority of this parameter set. 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) | |
| RefCounted & | operator= (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) |
| Protected Member Functions inherited from NonCopyableClass | |
| NonCopyableClass () | |
| ~NonCopyableClass () | |
Detailed Description
A named set of parameter values, representing a "variation" on a parametric model.
Each variation has the same parameter definitions as the model itself, but may provide a different value for each parameter. The name of each IParameterSet must be unique within the model. The description and sort order are used chiefly for presentation in the UI.
- Remarks
- Required library : DgnPlatform<ApiNumber>.lib i.e. DgnPlatform5.lib
Member Function Documentation
| DGNPLATFORM_EXPORT WString GetDescription | ( | ) | const |
Returns the optional description of this parameter set.
| DGNPLATFORM_EXPORT WString GetName | ( | ) | const |
Returns the name of this parameter set.
| DGNPLATFORM_EXPORT Int32 GetSortOrder | ( | ) | const |
Returns the sorting order of this parameter set.
| DGNPLATFORM_EXPORT bool SetDescription | ( | WCharCP | desc | ) |
Sets the optional description of this parameter set.
| DGNPLATFORM_EXPORT bool SetName | ( | WCharCP | name | ) |
Sets the name of this parameter set. The name must be unique and non-empty.
| DGNPLATFORM_EXPORT bool SetSortOrder | ( | Int32 | priority | ) |
Sets the sorting priority of this parameter set.
The documentation for this struct was generated from the following file: