Parameters
This container hold project-level Parameters and Design Points.
Returns all named expressions associated with a given container.
Return
Named expressions in the given container.
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.
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()
The data entity which describes a project-level design point.
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.
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.
Indicates the current state of the design point's parameters.
Comparison to see if all parameter values within two different design points are equivalent.
Return
True if all parameter values are equal.
Required Arguments
Copies all input parameter expressions from one design point to another.
Invalidates all output parameter values in the desination design point.
Required Arguments
Deletes a design point, the associated directory, and all design point files from the project.
Note that the active design point cannot be deleted.
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.
Returns the value of a specified parameter in a given design point.
Return
The value of the parameter in the specified design point.
Required Arguments
Sets the expression of the specified input parameter in the given design point.
Required Arguments
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)")
Sets expressions of the specified parameters in the specified design point.
Required Arguments
Design point report setting entity.
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.
The data entity which describes a project-level Parameter.
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.
An error message as a result of a validation or expression evaluation error.
The parameter definition as an expression. This property may be a constant expression, or it may depend on the values of other parameters.
Indicates whether the expression is constant, derived from another expression, or undefined.
The current value of the parameter. For derived parameters, this value is the evaluated expression result.
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.
Deletes a parameter.
A parameter can only be deleted when it is no longer associated with any properties/entities in the project.
Disassociates a data model property from an existing parameter.
To associate the parameter with a property, call AssociateParameter.
Required Arguments
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
Optional Arguments
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)
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.
Optional Arguments
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.
Sets a parameter's quantity name.
Required Arguments
Set the unit string for a parameter across all design points.
Required Arguments
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.
This stores the data reference to any generated charts from the Graphics system. e.g. a result of CreateMultiAxisChart.
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.
If this property is set the base design point will be excluded.
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")
This stores the data reference to any generated charts from the Graphics system. e.g. a result of CreateChartXY.
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.
If this property is set the base design point will be excluded.
The parameter entity to be plotted on the primary (bottom) x-axis.
The parameter entity to be plotted on the secondary (top) x-axis.
The parameter entity to be plotted on the left (primary) y-axis.
The parameter entity to be plotted on the right (secondary) y-axis.