Parameters
This namespace holds top-level commands and queries related to Parameters, Design Points and DesignXploration.
Clears the Design Points Cache for Design Exploration features. DesignXplorer is using an internal cache of Design Points to reduce the number of Design Point update operations. This cache is available accross all of the design exploration systems of a project. This command clears all the data contained in the cache.
The following example shows how to clear the cache in a project.
ClearDesignPointsCache()
A command to create a new design point that contains all the parameters, but with their values set to null.
The design point can be created initially as a "exported" design point, which will allow the files and associated databases to be reloaded at a later time to view the results of the design point update.
Return A DataReference to the new design point entity.
Optional Arguments
The following example illustrates proper CreateDesignPoint command invocation:
newDP = Parameters.CreateDesignPoint(Exported=True, Retained=False)
Creates a parameter, optionally associated with a data entity property. The expression and visible name for the parameters can be optionally specified.
Return
A DataReference to the new parameter entity.
Optional Arguments
The following two examples illustrate input and output parameter creation
myEntity = #Query to obtain your entity on to which parameters will be created.
inptParam1 = Parameters.CreateParameter(Entity=myEntity,
PropertyName="Value",
IsOutput=False,
IsDirectOutput=False,
Expression=None,
DisplayText="My Input Parameter")
outpParam1 = Parameters.CreateParameter(Entity=myEntity,
PropertyName="Value",
IsOutput=True,
IsDirectOutput=True,
Expression=None,
DisplayText="My Output Parameter")
exprParam1 = Parameters.CreateParameter(Entity=None,
PropertyName=None,
IsOutput=False,
IsDirectOutput=False,
Expression="cos(1)",
DisplayText="My Input Expression Parameter")
exprParam2 = Parameters.CreateParameter(Entity=None,
PropertyName=None,
IsOutput=True,
IsDirectOutput=False,
Expression="sin(P1)",
DisplayText="My Output Expression Parameter")
Creates a multi-axis parallel coordinate chart based on the parameters supplied to the command.
chart1 = Parameters.CreateParameterSummaryChart(Parameters=[])
-or-
parameter1 = Parameters.GetParameter(Name="P1")
parameter2 = Parameters.GetParameter(Name="P2")
parameter3 = Parameters.GetParameter(Name="P3")
chart1 = Parameters.CreateParameterSummaryChart(Parameters=[parameter1, parameter2, parameter3])
Return A data reference that represents the created chart.
Required Arguments
Creates a 2-dimensional (x,y) chart that can be used to compare two parameters.
Return
A data reference that represents the chart that is created.
Optional Arguments
This example illustrates the creation of a chart comparing two parameters.
parameter1 = Parameters.GetParameter(Name="P1")
parameter2 = Parameters.GetParameter(Name="P2")
chart1 = Parameters.CreateParameterVsParameterChart(XAxisBottom=parameter1, YAxisLeft=parameter2)
Export the parameter values for up-to-date parameters for all the design points to a csv file.
Required Arguments
Optional Arguments
The following example shows how the user can export up-to-date parameter values of all the design points of the project.
Parameters.ExportAllDesignPointsData(FileName="designPoints.csv")
Export the link to design set to a csv file.
Required Arguments
Optional Arguments
The following example shows how the user can export the dictionary of linked point.
Parameters.ExportLink(FileName="Link.csv")
Returns a set of all design points in the project.
Return
A data reference set containing all the design points.
Returns a set of all design points, sorted by their update order in ascending, in the project.
Return
A data reference set containing all the sorted design points.
Retrieves a set of all exported design points.
Return
A set of all design points.
Optional Arguments
Returns a set of all parameters in the project.
Return
A data reference set containing all the parameters.
Retrieves a set of all retained design points.
Return
A set of all design points.
Optional Arguments
Retrieves a set of all retained design points with valid data
Return
A set of all design points.
Optional Arguments
Returns a design point based on the name of the design point.
Return
The design point of interest.
Required Arguments
A query to return a reference for a named expression given a name and a scope
Return
The named expression of interest.
Required Arguments
Optional Arguments
A query to return a reference for a parameter given a name and a scope
Return
The parameter of interest.
Required Arguments
Optional Arguments
A query to return a reference for a parameter summary chart by name.
Return
The parameter chart of interest.
Required Arguments
A query to return a reference for a parameter vs. parameter chart by name.
Return
The parameter chart of interest.
Required Arguments
Returns a data reference to a named scope
Return
the Scope in the Parameter Manager
Required Arguments
Checks whether a parameter is up to date in a design point.
Return
True if the parameter is up to date in the design point.
Required Arguments
Indicates whether a parameter is up to date in a design point.
Return
Return if the parameter is up to date in the design point.
Required Arguments
Optional Arguments
Optimizes Update Order of Design Points to minimize the number of modifications between two consecutives Design Points
Sets the expression of the specified parameter in the base design point.
Required Arguments