Parameters

Parameters
This container hold project-level Parameters and Design Points.

Methods

GetAllNamedExpressions

Returns all named expressions associated with a given container.

Return Named expressions in the given container.
Type DataReferenceSet

GetAllParameters

Returns the set of all parameters associated with all entity properties in a given container. Parameters not associated with containers are not returned.

Return The set of parameters present in the given container.
Type DataReferenceSet

Example

In this example 'paramSet' becomes the set of parameters associated with the properties of any entity that resides within the Results container of system1.

    results1 = system1.GetContainer(ComponentName="Results")
    paramSet = results1.GetAllParameters()

Data Entities

DesignPoint

The data entity which describes a project-level design point.

Properties

DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data entities but is used only in those entities that present a label in the user interface.

Type string
Read Only No

Exported

Specifies whether the design point is exported.

Type bool
Read Only No

HasValidRetainedData

Indicates whether the data model and files for this design point is retained in the project and valid. This can happen for a retained DP; or a non-retained DP before previously retained data is deleted.

Type bool
Read Only Yes

IsUpToDate

True if the whole project is up to date for this design point.

Type bool
Read Only Yes

Note

Contains user-defined notes about the design point.

Type string
Read Only No

Retained

Gets or sets whether the design point is retained.

Type bool
Read Only No

StateOfParameters

Indicates the current state of the design point's parameters.

Type DesignPointState
Read Only Yes

UpdateOrder

The update order of the design point.

Type double
Read Only No

Methods

AreParameterValuesEqual

Comparison to see if all parameter values within two different design points are equivalent.

Return True if all parameter values are equal.
Type bool

Required Arguments

DesignPoint2 The second design point
Type DataReference

CopyParameterExpressions

Copies all input parameter expressions from one design point to another.

Invalidates all output parameter values in the desination design point.

Required Arguments

ToDesignPoint The destination design point.
Type DataReference

Delete

Deletes a design point, the associated directory, and all design point files from the project.

Note that the active design point cannot be deleted.

Duplicate

Creates a new design point in which all parameters have the same values as in the specified original design point.

Return The created design point entity.
Type DataReference

Optional Arguments

Name name of new Design Point
Type string

GetParameterValue

Returns the value of a specified parameter in a given design point.

Return The value of the parameter in the specified design point.
Type Object

Required Arguments

Parameter The parameter data reference.
Type DataReference

SetParameterExpression

Sets the expression of the specified input parameter in the given design point.

Required Arguments

Expression The string with the expression for the parameter.
Type string
Parameter The input parameter data reference.
Type DataReference

Example

The following example illustrates the setting of a parameter expression for a given design point.

    dp = Parameters.GetDesignPoint("0")
    param = Parameters.GetParameter("P1")
    dp.SetParameterExpression(param, "cos(1)")

SetParameterExpressions

Sets expressions of the specified parameters in the specified design point.

Required Arguments

ParameterExpressions The parameters and expressions
Type IDictionary<DataReference, string>

DesignPointReportSetting

Design point report setting entity.

Properties

DesignPointReportImage

Report image showing options

Type string
Read Only No

DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data entities but is used only in those entities that present a label in the user interface.

Type string
Read Only No

Parameter

The data entity which describes a project-level Parameter.

Properties

Description

A human-readable description of the parameter.

Type string
Read Only No

DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data entities but is used only in those entities that present a label in the user interface.

Type string
Read Only No

ErrorMessage

An error message as a result of a validation or expression evaluation error.

Type string
Read Only Yes

Expression

The parameter definition as an expression. This property may be a constant expression, or it may depend on the values of other parameters.

Type string
Read Only No

ExpressionType

Indicates whether the expression is constant, derived from another expression, or undefined.

Type ExpressionType
Read Only Yes

PersistedNamedValueEntityReference

the data reference of the entity that the named value refers to

Type DataReference
Read Only No

Usage

Specifies how the paramter is used in the data model.

Type ParameterUsage
Read Only Yes

Value

The current value of the parameter. For derived parameters, this value is the evaluated expression result.

Type Object
Read Only Yes

ValueQuantityName

Gets the value quantity name if ValueSpec is a QuantitySpec. Null otherwise. If the entity is a parameter then setting this property will constrain the dimensions of values of the parameter to be consistent with the quantity name. This property does not constrain the values of named expressions.

Type string
Read Only No

Methods

Delete

Deletes a parameter.

A parameter can only be deleted when it is no longer associated with any properties/entities in the project.

Disassociate

Disassociates a data model property from an existing parameter.

To associate the parameter with a property, call AssociateParameter.

Required Arguments

Entity The data model entity that holds the property to be disassociated.
Type DataReference
PropertyName The name of the property to be disassociated.
Type string

DisassociateInContext

Disassociates a data model property for a given context from an existing parameter.

To associate the parameter with a property in context, call AssociateParameterInContext.

Required Arguments

Entity The data model entity that holds the property to be disassociated.
Type DataReference
PropertyName The name of the property to be disassociated.
Type string

Optional Arguments

Context The context of the association.
Type DataReference

Example

The following example illustrates proper DisassociateParameterInContext invocation:

    entity1 = ...
    parameter1 = Parameters.GetParameter(Name="p1")
    parameter1.DisassociateInContext(entity1, "SampleProperty")

Callers may provide a Context argument.

    contextEntity1 = ...
    parameter1.DisassociateInContext(entity1, "SampleProperty", contextEntity1)

GetAssociatedEntityProperties

Returns the entity properties associated with a given parameter. If a container is specified, returns only the entity properties for the given container.

Return A ParameterizedEntityPropertiesCollection dictionary containing a data reference to each entity with parameterized properties and the list of property names within that entity.
Type ParameterizedEntityPropertiesCollection

Optional Arguments

Container Optionally specifies a container for which the entity properties should be returned.
Type DataContainerReference

GetDependencies

For a derived parameter, returns the list of parameters referred to by this parameter's expression.

Return Data references to the parameters that this parameter is dependent upon.
Type List<DataReference>

SetQuantityName

Sets a parameter's quantity name.

Required Arguments

QuantityName The quantity name.
Type string

SetQuantityUnit

Set the unit string for a parameter across all design points.

Required Arguments

Unit The new units of the parameter.
Type string

ParameterSummaryChart

This is a summary chart that will display all parameters against all design points. This is useful for understanding and visualizing the full parameter space, but is not very useful for comparing one parameter against another. For parameter vs. parameter charts, see CreateParameterVsParameterChart.

Properties

Chart

This stores the data reference to any generated charts from the Graphics system. e.g. a result of CreateMultiAxisChart.

Type DataReference
Read Only No

DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data entities but is used only in those entities that present a label in the user interface.

Type string
Read Only No

IsBaseDesignPointExcluded

If this property is set the base design point will be excluded.

Type bool
Read Only No

Variables

The variables that have been added to the chart.

Type DataReferenceSet
Read Only No

Methods

Delete

Deletes a parameter chart.

ParameterVsParameterChart

This chart type can be used to plot one parameter against another or parameters vs. design points.

There are 4 accessable axes, X-Top, X-Bottom, Y-Left and Y-Right.

    chart1 = Parameters.CreateParameterVsParameterChart()
    chart1.XAxisBottom = Parameters.GetParameter("P1")
    chart1.XAxisTop = Parameters.GetParameter("P2")
    chart1.YAxisLeft = Parameters.GetParameter("P3")
    chart1.YAxisRight = Parameters.GetParameter("P4")

Properties

Chart

This stores the data reference to any generated charts from the Graphics system. e.g. a result of CreateChartXY.

Type DataReference
Read Only No

DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data entities but is used only in those entities that present a label in the user interface.

Type string
Read Only No

IsBaseDesignPointExcluded

If this property is set the base design point will be excluded.

Type bool
Read Only No

XAxisBottom

The parameter entity to be plotted on the primary (bottom) x-axis.

Type DataReference
Read Only No

XAxisTop

The parameter entity to be plotted on the secondary (top) x-axis.

Type DataReference
Read Only No

YAxisLeft

The parameter entity to be plotted on the left (primary) y-axis.

Type DataReference
Read Only No

YAxisRight

The parameter entity to be plotted on the right (secondary) y-axis.

Type DataReference
Read Only No

Methods

Delete

Deletes a parameter chart.