Accessing Parameter APIs

As of ANSYS 18.0, Workbench parameter objects are exposed at the user level through Automation API wrappers in the namespace Ansys.ACT.WorkBench.Automation.Workflows. Simple parameter interactions are now fully supported through these wrappers:

task = ExtAPI.DataModel.Tasks[0]
p0 = task.Parameters[0]
value = p0.Value
newValue = value * 2
p0.Value = newValue

The following table lists the APIs that are available.

ClassMemberDescription

IWBParameter

Name

The parameter name.

Caption

The parameter display text.

Value

The parameter value for the current design point.

Usage

The parameter usage.

Parameter

Name

The parameter name.

Caption

The parameter display text.

Value

The parameter value for the current design point.

Usage

The parameter usage.

InternalObject

The Workbench parameter data reference.

ParameterUsage

Input

A parameter whose value is to be used by the data model.

Output

A parameter whose value is either based on an expression or provided directly by the data model.

Unknown

The parameter usage could not be determined.


Release 18.2 - © ANSYS, Inc. All rights reserved.