DX Direct Optimization

DX Direct Optimization
This container holds data for an instance of Parameter Direct Optimization.

Methods

ApproveGeneratedData

Approve generated data after nonparametric changes by keeping DX results. This command is recursive and applied with any component dependent on the first component.

Example

The following example shows how to approve generated data. 

    system1 = GetSystem(Name="RSO")
    designofExperiment1 = system1.GetContainer(ComponentName="Design of Experiment")
    designofExperiment1.ApproveGeneratedData()

GetModel

Get the DataReference of the Model. An exception is thrown if the entity is not found.

Return     The DataReference of the Model.
    Type     DataReference
Example

The following example shows how the user can get a Model to change one of its properties. 

    system1 = GetSystem(Name="RSO")
    designofExperiment1 = system1.GetContainer(ComponentName="Design of Experiment")
    dOEModel1 = designofExperiment1.GetModel()
    dOEModel1.DOEType = "eDOETYPE_OSFD"

Data Entities

AmoOptimization

Entity which performs and manages the DesignXplorer Optimization Method Component

Properties

Converged

Convergence state

Type     bool
Read Only    Yes
CrossoverProbability

Maximum Allowable Pareto Percentage

Type     double
Read Only    No
CurrentParetoPercentage

Pareto Percentage

Type     double
Read Only    Yes
CurrentStabilityPercentage

Stability Percentage

Type     double
Read Only    Yes
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
MaximumNumberOfPermutations

Maximum number of permutations for discrete / manufacturable values.

Type     int
Read Only    Yes
MaxNumCandidates

Maximum Number of Candidates

Type     int
Read Only    No
MaxNumCycles

Maximum Number Of Cycles for OSFD algorithm.

Type     int
Read Only    No
MaxNumIterations

Maximum Number of Iterations

Type     int
Read Only    No
MutationProbability

Maximum Allowable Pareto Percentage

Type     double
Read Only    No
NumberOfEvaluations

Number of Evaluations

Type     int
Read Only    Yes
NumberOfFailures

Number of Failures

Type     int
Read Only    Yes
NumberOfInitialSamples

Number of Initial Samples

Type     int
Read Only    No
NumCandidates

Number of Candidates

Type     int
Read Only    Yes
NumIterations

Current Iteration

Type     int
Read Only    Yes
NumSamplesPerIter

Number of Samples Per Iteration

Type     int
Read Only    No
ParetoPercentage

Maximum Allowable Pareto Percentage

Type     double
Read Only    No
RandomGeneratorSeed

LHS Seed

Type     int
Read Only    No
SampleSetSize

Size of Generated Sample Set

Type     int
Read Only    Yes
StabilityCriterion

Maximum Allowable Pareto Percentage

Type     double
Read Only    No
TypeOfInitialSampling

Type Of Initial Sampling

Type     TypeOfInitialSampling
Read Only    No

AsoOptimization

Entity which performs and manages the DesignXplorer Optimization Method Component

Properties

Converged

Convergence state

Type     bool
Read Only    Yes
ConvergenceTolerance

Convergence Tolerance

Type     double
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
MaximumNumberOfPermutations

Maximum number of permutations for discrete / manufacturable values.

Type     int
Read Only    Yes
MaxNumberReductionPerIteration

Maximun Number of Domain Reduction per Iteration

Type     int
Read Only    No
MaxNumCandidates

Maximum Number of Candidates

Type     int
Read Only    No
MaxNumCycles

Maximum Number Of Cycles for OSFD algorithm.

Type     int
Read Only    No
MaxNumDomainReductions

Maximum Number of Domain Reductions

Type     int
Read Only    No
MaxNumEvaluations

Maximum Number of Evaluations

Type     int
Read Only    No
NumberOfEvaluations

Number of Evaluations

Type     int
Read Only    Yes
NumberOfFailures

Number of Failures

Type     int
Read Only    Yes
NumberOfInitialSamples

Number of LHS Initial Samples.

Type     int
Read Only    No
NumberOfScreeningSamples

Number of Screening Samples for the Adaptive Single-Objective optimization method.

Type     int
Read Only    No
NumberOfStartingPoints

Number of Starting Points for the Adaptive Single-Objective optimization method.

Type     int
Read Only    No
NumCandidates

Number of Candidates

Type     int
Read Only    Yes
PercentageOfDomainReductions

Percentage of Domain Reductions

Type     double
Read Only    No
RandomGeneratorSeed

LHS Seed

Type     int
Read Only    No
SampleSetSize

Size of Generated Sample Set

Type     int
Read Only    Yes

CustomConstraintProperties

Entity which wraps and manages the external Parameter Definition for the Optimization Criterion with an external Optimization Method

Properties

No Properties.

CustomObjectiveProperties

Entity which wraps and manages the external Objective Definition for the Optimization Criterion with an external Optimization Method

Properties

No Properties.

CustomParameterProperties

Entity which wraps and manages the external Parameter Definition for the Input Parameter with an external Optimization Method

Properties

No Properties.

DiscreteLevel

The data entity which describes a Discrete Level of an Input Parameter.

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
Index

Zero-based Index of the discrete level in the list of levels of the owning parameter.

Type     int
Read Only    No
Value

Value of the DiscreteLevel.

Type     Object
Read Only    No

Methods

SetValue

Sets the value of a discrete level entity. A discrete level can have an integer value (e.g. a number if holes, a number of turns, etc) or a string value (e.g. a material name or a geometry file name).

Required Arguments

Value    Value set to the discrete level entity.
    Type     Object
Example

The following example shows how to retrieve a discrete level from an input parameter and then change its value. 

    container = system1.GetContainer(ComponentName="Design of Experiment")
    model = container.GetModel()
    DiscreteInputParameter = model.GetParameter(Name="P2")
    level1 = DiscreteInputParameter.GetDiscreteLevel(Name="Level 1")
    level1.SetValue( Value="2500" )

InputParameter

The data entity which describes an Input Parameter in DesignXplorer.

Properties

Attribute1

First editable attribute of the distribution for an uncertainty parameter. The nature of the attribute depends on the distribution type. For instance, the first attribute of a Normal distribution is the Mean value.

Type     double
Read Only    No
Attribute2

Second editable attribute of the distribution for an uncertainty parameter. The nature of the attribute depends on the distribution type. For instance, the second attribute of a Normal distribution is the Standard Deviation value. Some distribution type do not have a second attribute.

Type     double
Read Only    No
ConstantValue

Constant value of the Parameter when it is disabled.

Type     Object
Read Only    No
CustomDefinitionList

Custom Definition List

Type     List<DataReference>
Read Only    No
DiscreteLevels

List of the discrete levels.

Type     List<DataReference>
Read Only    Yes
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
DistributionLowerBound

Distribution lower bound of the variation range for an uncertainty Parameter.

Type     double
Read Only    No
DistributionType

Distribution type for an uncertainty parameter.

Type     DistributionType
Read Only    No
DistributionUpperBound

Distribution upper bound of the variation range for an uncertainty Parameter.

Type     double
Read Only    No
Enabled

True if the Parameter is enabled for the current study.

Type     bool
Read Only    No
Kurtosis

Kurtosis value of the distribution for an uncertainty parameter.

Type     double
Read Only    Yes
LowerBound

Lower bound of the variation range for a Continuous Parameter.

Type     double
Read Only    No
Mean

Mean value of the distribution for an uncertainty parameter.

Type     double
Read Only    Yes
Nature

Nature of the Parameter.

Type     ParameterNature
Read Only    No
NumberOfLevels

Number of levels if the parameter nature is Discrete, or the parameter nature is Continuous and the UseManufacturableValues property is set to True.

Type     int
Read Only    Yes
Skewness

Skewness value of the distribution for an uncertainty parameter.

Type     double
Read Only    Yes
StandardDeviation

Standard deviation value of the distribution for an uncertainty parameter.

Type     double
Read Only    Yes
Type

Type of the Parameter, either a DesignVariable in a GDO context, or an UncertaintyVariable in a SixSigma Analysis context.

Type     SimulationType
Read Only    Yes
Units

Units

Type     string
Read Only    Yes
UpperBound

Upper bound of the variation range for a Continuous Parameter.

Type     double
Read Only    No
UseManufacturableValues

True to restrict the variation of the parameter to defined Manufacturable Values.

Type     bool
Read Only    No

Methods

AddDiscreteLevel

Adds a Discrete Level entity on a discrete input parameter. A discrete level can have an integer value (e.g. a number of holes, a number of turns, etc) or a string value (e.g. a material name or a geometry file name). The command has optional arguments to specify the Name of the level and its Index in the list of levels of the parameter. By default, the new level is added to the end of the list. The various discrete levels of an input parameter represent independent configurations of the project, processed in the order of their creation.

Return     The created entity.
    Type     DataReference

Required Arguments

Value    The value of the discrete level. Value can be an integer or a string.
    Type     Object

Optional Arguments

DisplayText    DisplayText of the created entity. If not specified, a default name of the form "Level [#]" is used.
    Type     string
Index    The position of the new level in the list of discrete levels of the parameter. Index is zero-based. If it is not specified, the new level is appended to the list.
    Type     int
    Default Value    -1
Example

The following example shows how to add new discrete levels on a discrete input parameter. The third level is inserted between the two others. 

    container = system1.GetContainer(ComponentName="Design of Experiment")
    model = container.GetModel()
    DiscreteInputParameter = model.GetParameter(Name="P2")
    DiscreteInputParameter.AddDiscreteLevel(Value=3000, DisplayText="Three thousand turns")
    DiscreteInputParameter.AddDiscreteLevel(Value=2000, DisplayText="Two thousand turns")
    DiscreteInputParameter.AddDiscreteLevel(Value=5000, Index="1")

AddLevels

Adds a list of levels to a continuous input parameter. Each level is a quantity or a real number corresponding to a manufacturable value. The list of levels forms a restriction filter used when post-processing the input parameter. If levels are added outside of the variation range, the lower and upper bounds are adjusted accordingly.

Required Arguments

Levels    List of added levels.
    Type     List<string>

Optional Arguments

Overwrite    True in order to overwrite the existing levels, False by default.
    Type     bool
Example

The following example shows how to overwrite the manufacturable values of an input parameter and how to define an additional value later. 

    container = system1.GetContainer(ComponentName="Design of Experiment")
    model = container.GetModel()
    InputParameter = model.GetParameter(Name="P1")
    InputParameter.UseManufacturableValues = True
    InputParameter.AddLevels(Levels=["0.3 [mm]", "0.5 [mm]", "1e-3 [m]"], Overwrite=True)
    InputParameter.AddLevels(Levels="7 [mm]")

CreateOptimizationCriterion

Creates an OptimizationCriterion entity associated to a parameter.

Return     The DataReference of the OptimizationCriterion.
    Type     DataReference

Required Arguments

Parameter    The parameter on which the criterion is created.
    Type     DataReference
Example

The following example shows how to create an OptimizationCriterion entity. 

    container = system1.GetContainer(ComponentName="Optimization")
    model = container.GetModel()
    parameter1 = model.GetParameter(Name="P1")
    optimizationCriterion = parameter1.CreateOptimizationCriterion()

DeleteDiscreteLevels

Deletes a list of levels from a discrete input parameter.

Required Arguments

DiscreteLevels    List of the DiscreteLevel entities to delete.
    Type     List<DataReference>
Example

The following example shows how to add and then delete one or more levels from a discrete input parameter. 

    container = system1.GetContainer(ComponentName="Design of Experiment")
    model = container.GetModel()
    DiscreteInputParameter = model.GetParameter(Name="P1")
    level1 = DiscreteInputParameter.AddDiscreteLevel(Value=3000, DisplayText="Three thousand turns")
    level2 = DiscreteInputParameter.AddDiscreteLevel(Value=2000, DisplayText="Two thousand turns")
    level3 = DiscreteInputParameter.AddDiscreteLevel(Value=5000, Index="1")
    DiscreteInputParameter.DeleteDiscreteLevels(DiscreteLevels=[level1, level2])

DeleteLevels

Deletes a list of levels from a continuous input parameter.

Required Arguments

Indices    Indices of the items to remove from the levels list
    Type     List<int>
Example

The following example shows how to add and then delete one or more levels from a continuous input parameter for which the UseManufacturableValues property is set to True. 

    container = system1.GetContainer(ComponentName="Design of Experiment")
    model = container.GetModel()
    InputParameter = model.GetParameter(Name="P1")
    InputParameter.UseManufacturableValues = True
    InputParameter.AddLevels(Levels=["0.3 [mmm]", "0.5 [mm]", "1e-3 [m]"], Overwrite=True)
    InputParameter.DeleteLevels( Indices=[0, 1] )

ExportData

Export the data of a DesignXplorer entity to a csv file. The entity can be one of the DesignXplorer chart entities, a ParametricTable or an InputParameter entity.

Required Arguments

FileName    The exported file name.
    Type     string

Optional Arguments

AppendMode    True to append to an existing csv file, False to overwrite it.
    Type     bool
    Default Value    False
Example

The following example shows how the user can export the table of Design Points and then the Parameters Parallel chart of a Design of Experiments component. 

    container = system1.GetContainer(ComponentName="Design of Experiment")
    model = container.GetModel()
    parametricTable = model.GetParametricTable(Name="DesignPoints")
    parametricTable.ExportData(FileName="doe.csv")
    chart = model.GetChart(Name="DesignPointsParallel")
    chart.ExportData(FileName="doe.csv", AppendMode=True)

GetCustomParameterDefinition

Get the DataReference of a CustomParameterProperties entity associated with an Input Parameter. An exception is thrown if the entity is not found.

Return     The DataReference of the CustomParameterProperties.
    Type     DataReference

Required Arguments

ExtensionName    Extension's Name.
    Type     string
Example

The following example shows how the user can get a CustomParameterProperties. 

    system1 = GetSystem(Name="DOP")
    optimization1 = system1.GetContainer(ComponentName="Optimization")
    optimizationModel1 = optimization1.GetModel()
    inputParameter1 = optimizationModel1.GetParameter(Name="P1")
    customParameterDefinition1 = inputParameter1.GetCustomParameterDefinition(ExtensionName="UncertaintyParameterDefiniton@PythonOptimizer")
    customParameterDefinition1.Distribution = "Triangular"

GetDiscreteLevel

Get a discrete level by name from an input parameter. The parameter's full and ordered list of discrete levels is available as its "DiscreteLevels" property.

Return     The DataReference of the discrete level entity.
    Type     DataReference

Required Arguments

Name    The name of the discrete level.
    Type     string
Example

The following example shows how the user can retrieve a discrete level of a discrete input parameter by its name. 

    system1 = GetSystem(Name="RSO")
    designofExperiment1 = system1.GetContainer(ComponentName="Design of Experiment")
    dOEModel1 = designofExperiment1.GetModel()
    DiscreteInputParameter1 = dOEModel1.GetParameter(Name="P1")
    level = DiscreteInputParameter1.GetDiscreteLevel(Name="Level 1")

GetOptimizationCriterion

Get the DataReference of the OptimizationCriterion associated with a Parameter. An exception is thrown if the entity is not found.

Return     The DataReference of the OptimizationCriterion.
    Type     DataReference

Required Arguments

Parameter    Parent Parameter.
    Type     DataReference
Example

The following example shows how the user can get a OptimizationCriterion to change one of its properties. 

    system1 = GetSystem(Name="RSO")
    optimization1 = system1.GetContainer(ComponentName="Optimization")
    optimizationModel1 = optimization1.GetModel()
    parameter3 = optimizationModel1.GetParameter(Name="P3")
    optimizationCriterion = parameter3.GetOptimizationCriterion()
    optimizationCriterion.ObjectiveType = "eGT_MinimumPossible"

GetParameterStatistics

Get the DataReference of the ParameterStatistics entity associated with a Parameter.

Return     The DataReference of the ParameterStatistics entity.
    Type     DataReference
Example

The following example shows how the user can get a ParameterStatistics entity and examine its Mean property. 

    system1 = GetSystem(Name="SSA")
    sixSigmaAnalysis1 = system1.GetContainer(ComponentName="Six Sigma Analysis")
    sixSigmaModel1 = sixSigmaAnalysis1.GetModel()
    parameter4 = sixSigmaModel1.GetParameter(Name="P4")
    parameterStatistics1 = parameter4.GetParameterStatistics()
    mean = parameterStatistics1.Mean

MisqpOptimization

Entity which performs and manages the DesignXplorer Optimization Method Component

Properties

Converged

Convergence state

Type     bool
Read Only    Yes
DerivativeApproximationType

DerivativeApproximationType

Type     DerivativeApproximationType
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
InitialFiniteDifferenceDelta

Relative Gradient Step

Type     double
Read Only    No
MaxConvPercentage

Allowable Convergence Percentage

Type     double
Read Only    No
MaximumNumberOfPermutations

Maximum number of permutations for discrete / manufacturable values.

Type     int
Read Only    Yes
MaxNumCandidates

Maximum Number of Candidates

Type     int
Read Only    No
MaxNumIterations

Maximum Number of Iterations

Type     int
Read Only    No
NumberOfEvaluations

Number of Evaluations

Type     int
Read Only    Yes
NumberOfFailures

Number of Failures

Type     int
Read Only    Yes
NumCandidates

Number of Candidates

Type     int
Read Only    Yes
NumIterations

Current Iteration

Type     int
Read Only    Yes
SampleSetSize

Size of Generated Sample Set

Type     int
Read Only    Yes

MOGAOptimization

Entity which performs and manages the DesignXplorer Optimization Method Component

Properties

Converged

Convergence state

Type     bool
Read Only    Yes
CrossoverProbability

Maximum Allowable Pareto Percentage

Type     double
Read Only    No
CurrentParetoPercentage

Pareto Percentage

Type     double
Read Only    Yes
CurrentStabilityPercentage

Stability Percentage

Type     double
Read Only    Yes
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
MaximumNumberOfPermutations

Maximum number of permutations for discrete / manufacturable values.

Type     int
Read Only    Yes
MaxNumCandidates

Maximum Number of Candidates

Type     int
Read Only    No
MaxNumCycles

Maximum Number Of Cycles for OSFD algorithm.

Type     int
Read Only    No
MaxNumIterations

Maximum Number of Iterations

Type     int
Read Only    No
MutationProbability

Maximum Allowable Pareto Percentage

Type     double
Read Only    No
NumberOfEvaluations

Number of Evaluations

Type     int
Read Only    Yes
NumberOfFailures

Number of Failures

Type     int
Read Only    Yes
NumberOfInitialSamples

Number of Initial Samples.

Type     int
Read Only    No
NumCandidates

Number of Candidates

Type     int
Read Only    Yes
NumIterations

Current Iteration

Type     int
Read Only    Yes
NumSamplesPerIter

Number of Samples Per Iteration

Type     int
Read Only    No
ParetoPercentage

Maximum Allowable Pareto Percentage

Type     double
Read Only    No
RandomGeneratorSeed

LHS Seed

Type     int
Read Only    No
SampleSetSize

Size of Generated Sample Set

Type     int
Read Only    Yes
StabilityCriterion

Stability Criterion

Type     double
Read Only    No
TypeOfInitialSampling

Type Of Initial Sampling

Type     TypeOfInitialSampling
Read Only    No

NlpqlOptimization

Entity which performs and manages the DesignXplorer Optimization Method Component

Properties

Converged

Convergence state

Type     bool
Read Only    Yes
DerivativeApproximationType

DerivativeApproximationType

Type     DerivativeApproximationType
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
InitialFiniteDifferenceDelta

Relative Gradient Step

Type     double
Read Only    No
MaxConvPercentage

Allowable Convergence Percentage

Type     double
Read Only    No
MaximumNumberOfPermutations

Maximum number of permutations for discrete / manufacturable values.

Type     int
Read Only    Yes
MaxNumCandidates

Maximum Number of Candidates

Type     int
Read Only    No
MaxNumIterations

Maximum Number of Iterations

Type     int
Read Only    No
NumberOfEvaluations

Number of Evaluations

Type     int
Read Only    Yes
NumberOfFailures

Number of Failures

Type     int
Read Only    Yes
NumCandidates

Number of Candidates

Type     int
Read Only    Yes
NumIterations

Current Iteration

Type     int
Read Only    Yes
SampleSetSize

Size of Generated Sample Set

Type     int
Read Only    Yes

OptimizationCriterion

The data entity which describes the objective and constraint associated with a Parameter for an Optimization Study.

Properties

AllowedValues

Allowed Values Type of parameter if Parameter is a continuous input parameter.

Type     AllowedContinuousValues
Read Only    No
ConstraintFirstValue

Constraint First Value used when ConstraintType is eGI_LessThanTarget, eGI_GreaterThanTarget, eGI_NearTarget or eGI_InsideBounds.

Type     double
Read Only    No
ConstraintHandling

Constraint Handling

Type     ConstraintHandlingType
Read Only    No
ConstraintImportance

Importance of the constraint when multiple objectives are defined.

Type     ImportanceLevel
Read Only    No
ConstraintSecondValue

Constraint Second Value used when ConstraintType is eGI_InsideBounds.

Type     double
Read Only    No
ConstraintType

Constraint type for the Parameter to be optimized.

Type     ConstraintType
Read Only    No
CustomConstraintDefinitionList

List of custom constraint definitions.

Type     List<DataReference>
Read Only    No
CustomObjectiveDefinitionList

List of custom objective definitions.

Type     List<DataReference>
Read Only    No
FeasibleTolerance

Tolerance associated to the constraint value.

Type     double
Read Only    No
FitnessInitialValue

The initial value when tolerance settings are on.

Type     double
Read Only    No
GridInterval

Grid Interval of the parameter if Parameter is a continuous input parameter and the allowed values type is Snap To Grid.

Type     double
Read Only    No
HistoryChart

DataReference of the associated history chart entity.

Type     DataReference
Read Only    No
LowerBound

Lower Bound of the variation range if Parameter is an input parameter.

Type     double
Read Only    No
ObjectiveImportance

Importance of the objective when multiple objectives are defined.

Type     ImportanceLevel
Read Only    No
ObjectiveTargetValue

Objective Target Value if ObjectiveType is SeekTarget.

Type     double
Read Only    No
ObjectiveType

Objective type for the Parameter to be optimized.

Type     GoalType
Read Only    No
StartingValue

The value of the parameter in the starting point if Parameter is an input parameter and the optimization method uses a starting point.

Type     double
Read Only    No
TargetTolerance

Tolerance associated to the Target value.

Type     double
Read Only    No
Units

Unit of the Parameter.

Type     string
Read Only    Yes
UpperBound

Upper Bound of the variation range if Parameter is an input parameter.

Type     double
Read Only    No

Methods

GetChart

Get the DataReference of the HistoryChart associated with an OptimizationCriterion. An exception is thrown if the entity is not found.

Return     The DataReference of the OptimizationCriterion.
    Type     DataReference
Example

The following example shows how the user can get a HistoryChart to export its data as .csv file. 

    system = GetSystem(Name="RSO")
    optimization = system.GetContainer(ComponentName="Optimization")
    optimizationModel = optimization.GetModel()
    parameter = optimizationModel.GetParameter(Name="P3")
    criterion = parameter.GetOptimizationCriterion()
    historyChart = criterion.GetChart()
    historyChart.ExportData(FileName="D:/Temp/HistoryChart.csv")

GetCustomConstraintDefinition

Get the DataReference of a CustomConstraintProperties entity associated with an Optimization Criterion. An exception is thrown if the entity is not found.

Return     The DataReference of the CustomConstraintProperties.
    Type     DataReference

Required Arguments

ExtensionName    Extension's Name.
    Type     string
Example

The following example shows how the user can get a CustomConstraintProperties. 

    system1 = GetSystem(Name="DOP")
    optimization1 = system1.GetContainer(ComponentName="Optimization")
    optimizationModel1 = optimization1.GetModel()
    outputParameter1 = optimizationModel1.GetParameter(Name="P4")
    optimizationCriterion1 = outputParameter1.CreateOptimizationCriterion()
    customConstraintDefinition1 = optimizationCriterion1.GetCustomConstraintDefinition(ExtensionName="CommonConstraintDefinition@PythonOptimizer")
    customConstraintDefinition1.FeasibleTolerance = 0.02

GetCustomObjectiveDefinition

Get the DataReference of a CustomObjectiveProperties entity associated with an Optimization Criterion. An exception is thrown if the entity is not found.

Return     The DataReference of the CustomObjectiveProperties.
    Type     DataReference

Required Arguments

ExtensionName    Extension's Name.
    Type     string
Example

The following example shows how the user can get a CustomObjectiveProperties. 

    system1 = GetSystem(Name="DOP")
    optimization1 = system1.GetContainer(ComponentName="Optimization")
    optimizationModel1 = optimization1.GetModel()
    outputParameter1 = optimizationModel1.GetParameter(Name="P4")
    optimizationCriterion1 = outputParameter1.CreateOptimizationCriterion()
    customObjectiveDefinition1 = optimizationCriterion1.GetCustomObjectiveDefinition(ExtensionName="CommonObjectiveDefinition@PythonOptimizer")
    customObjectiveDefinition1.RelativeObjectiveWeight = 0.9

OptimizationMethod

Entity which wraps and manages the external Optimization Method for the Optimization component

Properties

No Properties.

OptimizationModel

Entity which performs and manages the DesignXplorer Optimization Component

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
EstimatedNumberofEvaluations

Estimated Number of Evaluations for the automated optimization method.

Type     int
Read Only    Yes
ExportDesignPoints

If True and PreserveDesignPoints is True as well, export project for each preserved Design Point.

Type     bool
Read Only    No
Method

Optimization Method

Type     DataReference
Read Only    No
MethodName

Type of the optimization

Type     string
Read Only    No
MethodSelection

Type of the optimization method selection.

Type     OptimizationMethodSelection
Read Only    No
NumberOfRetries

Indicates the number of times DX will try to update the failed design points.

Type     int
Read Only    No
PreserveDesignPoints

If True, preserve the Design Points at the project level after the component Update.

Type     bool
Read Only    No
RetainDesignPoints

If True and PreserveDesignPoints is True as well, retain data for each preserved Design Point.

Type     bool
Read Only    No
RetryDelay

Indicates how much time will elapse between tries. This option is only applicable when NumberOfRetries is greater than 0, otherwise it has no effect.

Type     Quantity
Read Only    No
RunTimeIndex

Type of the Run Time Index to select automatically the optimization method.

Type     RunTimeIndex
Read Only    No
ToleranceSettings

If True, enable fitness terms at Optimization Criterion level.

Type     bool
Read Only    No
VerifyCandidatePoints

If True, verifies the candidates by a design points update.

Type     bool
Read Only    No

Methods

CreateChart

Creates a Chart entity. The chart must be updated once after its creation by invoking its Update method. Then changes to its properties will update the chart automatically.

Return     The DataReference of the Chart.
    Type     DataReference

Required Arguments

ChartType    Type of chart to be created. The possible values depend on the type of Model. For instance, a ResponseSurface model accepts Spider, LocalSensitivity and Response chart while a CorrelationModel accepts CorrelationMatrix, DeterminationMatrix and CorrelationScatter charts.
    Type     ChartType

Optional Arguments

DisplayText    Displayed name of the chart. If not specified, a default name is applied, depending on the value of ChartType.
    Type     string
Example

The following example shows how to create a chart. 

    container = system1.GetContainer(ComponentName="Optimization")
    model = container.GetModel()
    TradeoffChart = model.CreateChart(ChartType="eChartTradeoff")
    TradeoffChart.Update()

CreateCustomCandidatePoint

Creates a custom candidate point. The Expressions dictionary can be used to specify a value or a quantity for some or all of the input parameters. In the context of a response surface based optimization, the output values are evaluated from the response surface.

Return     The created entity.
    Type     DataReference

Optional Arguments

DisplayText    DisplayText of the created entity. If not specified, a default name of the form "Custom Candidate Point [#]" is used.
    Type     string
Expressions    The values for each input parameter. If not specified, each parameter is initialized to its current value.
    Type     IDictionary<DataReference, string>
Example

The following example shows how to create a CustomCandidatePoint entity on an Optimization model based on a ResponseSurface. 

    container = system1.GetContainer(ComponentName="Optimization")
    model = container.GetModel()
    inputParameter1 = model.GetParameter(Name="P1")
    inputParameter2 = model.GetParameter(Name="P2")
    customCandidatePoint = model.CreateCustomCandidatePoint( DisplayText="Existing Design", 
                      Expressions={inputParameter1: "2.01", inputParameter2: "15.5"})

CreateParameterRelationship

Creates a Parameter Relationship

Return     The DataReference of the ParameterRelationship.
    Type     DataReference

Optional Arguments

LeftExpression    Left Expression.
    Type     string
RightExpression    Right Expression.
    Type     string
Type    Parameter Relationship Type.
    Type     ParameterRelationshipType
    Default Value    ePRT_LessThanOrEqualTo
Example

The following example shows how to create an ParameterRelationship entity. 

    container = system1.GetContainer(ComponentName="Optimization")
    model = container.GetModel()
    parameterRelationship = model.CreateParameterRelationship(LeftExpression="P1+P2",RightExpression="P3",Type="PRT_LessThanOrEqualTo")
    parameterRelationship2 = model.CreateParameterRelationship(LeftExpression="P4+P5",RightExpression="10[inch]",Type="PRT_GreaterThanOrEqualTo")

DeleteCharts

Deletes a list of Chart entities.

Required Arguments

Charts    List of Chart entities to delete.
    Type     List<DataReference>
Example

The following example shows how to delete existing charts. 

    container = system1.GetContainer(ComponentName="Optimization")
    model = container.GetModel()
    chart1 = model.GetChart(Name="TradeoffChart 1")
    chart2 = model.GetChart(Name="SamplesChart 1")
    model.DeleteCharts(Charts=[chart1, chart2])

DeleteCustomCandidatePoints

Deletes a list of CustomCandidatePoint entities.

Required Arguments

CustomCandidatePoints    CustomCandidatePoint entities to delete.
    Type     List<DataReference>
Example

The following example shows how to delete existing CustomCandidatePoint entities from an optimization model. 

    container = system1.GetContainer(ComponentName="Optimization")
    model = container.GetModel()
    customCandidatePoint1 = model.GetCustomCandidatePoint(Name="CustomCandidatePoint 1")
    customCandidatePoint2 = model.GetCustomCandidatePoint(Name="CustomCandidatePoint 2")
    model.DeleteCustomCandidatePoints(CustomCandidatePoints=[customCandidatePoint1, customCandidatePoint2])

DeleteObjectives

Deletes a list of OptimizationCriterion entities.

Required Arguments

OptimizationCriteria    List of Objective entities to delete.
    Type     List<DataReference>
Example

The following example shows how to delete existing OptimizationCriterion entities. 

    container = system1.GetContainer(ComponentName="Optimization")
    model = container.GetModel()
    parameter1 = model.GetParameter(Name="P1")
    optimizationCriterion1 = parameter1.GetOptimizationCriterion()
    parameter3 = model.GetParameter(Name="P3")
    optimizationCriterion3 = parameter3.GetOptimizationCriterion()
    model.DeleteOptimizationCriteria(OptimizationCriteria=[optimizationCriterion1, optimizationCriterion3])

DeleteParameterRelationships

Deletes a list of ParameterRelationship entities.

Required Arguments

ParameterRelationships    DataReferences of the entities to delete
    Type     List<DataReference>
Example

The following example shows how to delete existing ParameterRelationships. 

    container = system1.GetContainer(ComponentName="Optimization")
    model = container.GetModel()
    pr1 = model.GetParameterRelationship(Name="ParameterRelationShip 1")
    pr2 = model.GetParameterRelationship(Name="ParameterRelationShip 2")
    pr3 = model.GetParameterRelationship(Name="ParameterRelationShip 3")
    model.DeleteParameterRelationships(ParameterRelationships=[pr1, pr2, pr3])

DuplicateChart

Duplicates a Chart entity. The chart must be updated once after its creation by invoking its Update method. Then changes to its properties will update the chart automatically.

Return     The DataReference of the Chart.
    Type     DataReference

Required Arguments

Chart    The source chart to duplicate.
    Type     DataReference

Optional Arguments

DisplayText    Displayed name of the chart. If not specified, a default name is applied, depending on the value of ChartType.
    Type     string
TargetModel    The model on which the duplicated chart is created. If this parameter is not set, the model of the source chart is used.
    Type     DataReference
TargetResponsePoint    Parent TargetResponsePoint of the chart. If this parameter is not set, the response point of the source chart is used if applicable.
    Type     DataReference
Example

The following example shows how to duplicate a chart. 

    designofExperiment1 = system1.GetContainer(ComponentName="Design of Experiment")
    dOEModel1 = designofExperiment1.GetModel()
    designPointsCurvesChart1 = dOEModel1.GetChart(Name="DesignPointsCurves")
    chart1 = dOEModel1.DuplicateChart(Chart=designPointsCurvesChart1)
    chart1.Update()

ExportData

Export the data of model's entities to a csv file. These entities can be candidate points, custom candidate points, charts, parametric tables or input parameters.

Required Arguments

Entities    An optional list of entities containing data to be exported in the same file.
    Type     List<DataReference>
FileName    The exported file name.
    Type     string

Optional Arguments

AppendMode    True to append to an existing csv file, False to overwrite it.
    Type     bool
    Default Value    False
Example

The following example shows how the user can export the candidate points of an optimization component. 

    container = system1.GetContainer(ComponentName="Optimization")
    model = container.GetModel()
    candidates = model.GetCandidatePoints()
    model.ExportData(FileName="doe.csv", Entities=candidates)

GetCandidatePoint

Get the DataReference of a CandidatePoint entity. An exception is thrown if the entity is not found.

Return     The DataReference of the CandidatePoint entity.
    Type     DataReference

Required Arguments

Name    Name of the CandidatePoint to retrieve.
    Type     string
Example

The following example shows how to retrieve an existing CandidatePoint entity. 

    system1 = GetSystem(Name="DOP")
    container = system1.GetContainer(ComponentName="Optimization")
    model = container.GetModel()
    candidatePoint = model.GetCandidatePoint(Name="CandidatePoint 1")

GetCandidatePoints

Get the DataReferenceSet of all of the existing CandidatePoint entities on the model.

Return     The DataReferenceSet of the CandidatePoint entities.
    Type     DataReferenceSet
Example

The following example shows how to retrieve the candidate points of an optimization model. 

    system1 = GetSystem(Name="DOP")
    container = system1.GetContainer(ComponentName="Optimization")
    model = container.GetModel()
    candidatePoints = model.GetCandidatePoints()

GetChart

Query to return the chart reference for a given model and chart name.

Return     The DataReference of the chart.
    Type     DataReference

Required Arguments

Name    Name of the chart.
    Type     string
GetConvergenceChart

Query to return the chart reference for a given model and chart name.

Return     The DataReference of the chart.
    Type     DataReference
GetCustomCandidatePoint

Get the DataReference of a CustomCandidatePoint entity. An exception is thrown if the entity is not found.

Return     The DataReference of the CustomCandidatePoint entity.
    Type     DataReference

Required Arguments

Name    Name of the CustomCandidatePoint to retrieve.
    Type     string
Example

The following example shows how to retrieve an existing CustomCandidatePoint entity. 

    system1 = GetSystem(Name="DOP")
    container = system1.GetContainer(ComponentName="Optimization")
    model = container.GetModel()
    customCandidatePoint = model.GetCustomCandidatePoint(Name="CustomCandidatePoint 1")

GetCustomCandidatePoints

Get the DataReferenceSet of all of the existing CustomCandidatePoint entities of the model.

Return     The DataReferenceSet of the CustomCandidatePoint entities.
    Type     DataReferenceSet
Example

The following example shows how to retrieve the custom candidate points of an optimization model. 

    system1 = GetSystem(Name="DOP")
    container = system1.GetContainer(ComponentName="Optimization")
    model = container.GetModel()
    customCandidatePoints = model.GetCustomCandidatePoints()

GetDesignPointReportSetting

Get the DataReference of a DesignPointReportSetting entity associated with a Model. An exception is thrown if the entity is not found.

Return     The DataReference of the DesignPointReportSetting.
    Type     DataReference
Example

The following example shows how the user can get a DesignPointReportSetting to change one of its properties. 

    system1 = GetSystem(Name="GDO")
    designofExperiment1 = system1.GetContainer(ComponentName="Design of Experiment")
    dOEModel1 = designofExperiment1.GetModel()
    designPointReportSettingEntity1 = dOEModel1.GetDesignPointReportSetting()
    designPointReportSettingEntity1.DesignPointReportImage = "FFF-Results:Figure001.png"

GetOptimizationCriteria

Get the DataReferenceSet of all of the existing OptimizationCriterion entities of the model.

Return     The DataReference of the OptimizationCriterion entities.
    Type     DataReferenceSet

Required Arguments

Model    Parent Optimization model
    Type     DataReference
Example

The following example shows how to retrieve the objectives of an optimization model, as a set of OptimizationCriterion entities. 

    system1 = GetSystem(Name="DOP")
    container = system1.GetContainer(ComponentName="Optimization")
    model = container.GetModel()
    criteria = model.GetOptimizationCriteria()

GetParameter

Get the DataReference of a Parameter. An exception is thrown if the entity is not found.

Return     The DataReference of the Parameter.
    Type     DataReference

Required Arguments

Name    Name of the Parameter.
    Type     string
Example

The following example shows how the user can get a parameter of a model to change one of its properties. 

    system1 = GetSystem(Name="RSO")
    designofExperiment1 = system1.GetContainer(ComponentName="Design of Experiment")
    dOEModel1 = designofExperiment1.GetModel()
    inputParameter1 = dOEModel1.GetParameter(Name="P1")
    inputParameter1.LowerBound = 1

GetParameterRelationship

Get the DataReference of a ParameterRelationship entity. An exception is thrown if the entity is not found.

Return     The DataReference of the ParameterRelationship entity.
    Type     DataReference

Required Arguments

Name    Name of the ParameterRelationship to retrieve.
    Type     string
Example

The following example shows how the user can retrieve an existing ParameterRelationship entity. 

    container = system1.GetContainer(ComponentName="Optimization")
    model = container.GetModel()
    parameterRelationship = model.GetParameterRelationship(Name="ParameterRelationShip 1")

GetParameterRelationships

Get the Parameter Relationships associated to a Model. If the optional argument Enabled is not specified, the query returns all Parameter Relationships. If it is specified and True, the query returns only enabled Parameter Relationships. If it is False, the query returns only disabled Parameter Relationships.

Return     The DataReferenceSet of the ParameterRelationship entities.
    Type     DataReferenceSet

Optional Arguments

Enabled    If True, the query returns only enabled Parameter Relationships. If False, the query returns only disabled Parameter Relationships. If the argument is ommitted, the query returns all Parameter Relationships.
    Type     bool
Example

The following example shows how the user can retrieve all the Parameter Relationships defined on a model. 

    container = system1.GetContainer(ComponentName="Optimization")
    model = container.GetModel()
    allParameterRelationships = model.GetParameterRelationships()
    enabledParameterRelationships = model.GetParameterRelationships(Enabled="True")
    disabledParameterRelationships = model.GetParameterRelationships(Enabled="False")

GetParameters

Get the DataReferences of the InputParameter and OutputParameter of the model. If the optional argument InputParameters is not specified, the query returns all parameters. If it is specified and True, the query returns only input parameters. If it is False, the query returns only output parameters.

Return     The DataReferences of the Parameters
    Type     DataReferenceSet

Optional Arguments

InputParameters    If True, the query returns only input parameters. If False, the query returns only output parameters. If the argument is ommitted, the query returns all parameters.
    Type     bool
Example

The following example shows how the user can get the parameters of a model. 

    system1 = GetSystem(Name="RSO")
    designofExperiment1 = system1.GetContainer(ComponentName="Design of Experiment")
    dOEModel1 = designofExperiment1.GetModel()
    parameters = dOEModel1.GetParameters()

GetParametricTable

Get the DataReference of ParametricTable. An exception is thrown if the entity is not found. Names of the tables generated internally are: "DesignPoints", "CorrelationMatrix", "CorrelationScatter", "MinDesignPoints", "MaxDesignPoints", "ResponsePoints", "DeterminationMatrix".

Return     The DataReference of the ParametricTable
    Type     DataReference

Required Arguments

Name    Name of the ParametricTable
    Type     string
Example

The following example shows how the user can get a ParametricTable to add a new row and set values. 

    system1 = GetSystem(Name="RSO")
    designofExperiment1 = system1.GetContainer(ComponentName="Design of Experiment")
    dOEModel1 = designofExperiment1.GetModel()
    parametricTable = dOEModel1.GetParametricTable(Name="DesignPoints")
    parametricTable.AddRow()
    parametricTable.SetCellValue(RowIndex=9,ColumnIndex=0,Value="2.1")

ImportCustomCandidatePointsFromDps

Create custom candidate points in an Optimization model by importing points with a query to the DPS.

Return     The imported entities.
    Type     DataReferenceSet

Required Arguments

QueryString    The query.
    Type     string
Example

The following example shows how the user can create custom candidate points with a query to the DPS. Up to three design points with the best value for the fitness will be imported as custom candidate points. 

    container = system1.GetContainer(ComponentName="Optimization")
    model = container.GetModel()
    customCandidatePoints = model.ImportCustomCandidatePointsFromDps( QueryString="?eval_status=evaluated&sort=fitness&limit=3")

SendStudyToDpsProject

Send optimization study to the Design Point Service.

Return     State of the definition.
    Type     DefinitionState
Example

The following example shows how the user can send the fitness definition of the optimization model to the single configuration in the connected Design Point Service.

The current fitness definition is overwritten.

    system1 = GetSystem(Name="DOP")
    container = system1.GetContainer(ComponentName="Optimization")
    model = container.GetModel()
    model.SendStudyToDpsProject()

SetVariationReferencePoint

Sets a point as the reference to calculate the variation of the parameters in each of the candidate and custom candidate points of the container. The variation is calculated by the command and can be retrieved for each parameter of each point.

Required Arguments

Point    Point entity to set as the reference point.
    Type     DataReference

Optional Arguments

Source    The source of the output values to set as the reference.
    Type     OutputSource
    Default Value    Simulation
Example

The following example shows how to set a custom candidate point as the reference and how to retrieve the calculated variation on the parameters of a second candidate point. 

    container = system1.GetContainer(ComponentName="Optimization")
    model = container.GetModel()
    customCandidatePoint = model.GetCustomCandidatePoint(Name="CustomCandidatePoint")
    model.SetVariationReferencePoint(Point=customCandidatePoint, Source="Simulation")
    bestCandidate = model.GetCandidatePoint(Name="CandidatePoint")
    variationOfOutputsAsDecimals = bestCandidate.GetOutputValues(Source="Simulation", ValueType="VariationToReference")

VerifyPoints

Verify the CandidatePoint entities by performing a design point update to generate Simulation output values, so that they can be compared to the ResponseSurface output values. This command has no effect if the optimization model is used as part of a Direct Optimization system.

Required Arguments

Points    List of points to verify.
    Type     List<DataReference>

Optional Arguments

PullFromCacheOnly    If True, the command attempts to pull output values from the design point cache but does not trigger any design point update.
    Type     bool
    Default Value    False
Example

The following example shows how the user can verify all the candidate points generated by the optimization model and extract the existing output parameter values from the first candidate point. 

    system1 = GetSystem(Name="RSO")
    container = system1.GetContainer(ComponentName="Optimization")
    model = container.GetModel()
    candidatePoints = model.GetCandidatePoints()
    model.VerifyPoints(Points=candidatePoints)
    responseSurfaceValues = candidatePoints[0].GetOutputValues(Source="ResponseSurface")
    verifiedValues = candidatePoints[0].GetOutputValues(Source="Simulation")

OutputParameter

Output parameter entity for DesignXplorer.

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
EnableAutoRefinement

Determines whether the Auto Refinement is applicable to the output parameter.

Type     bool
Read Only    No
IgnoreForFiltering

Determines whether the parameter filtering is not applicable to the output parameter in the correlation context.

Type     bool
Read Only    No
InheritFromModelSettings

Determines whether the Maximum Predicted Relative Error defined at the Model level is applicable to the output parameter.

Type     bool
Read Only    No
LowerBound

Minimum value extracted from existing design points and/or sample sets.

Type     double
Read Only    Yes
MaximumPredictedError

Maximum Predicted Error for an output parameter with the GARS algorithm. This is the maximum predicted error for the selected output parameter.

Type     double
Read Only    Yes
MaxPredictedRelativeError

Maximum Relative Error targeted for an output parameter when refining with the Kriging algorithm. This is the maximum predicted relative error that is acceptable for the selected output parameter.

Type     double
Read Only    No
PredictedRelativeError

Current value of the Predicted Relative Error when refining with the Kriging algorithm

Type     double
Read Only    Yes
Scaling

Scaling

Type     bool
Read Only    No
Tolerance

Maximum Error targeted for an output parameter when refining with the GARS algorithm. This is the maximum predicted error that is acceptable for the selected output parameter.

Type     double
Read Only    No
TransformationType

Transformation Type

Type     TransformationType
Read Only    No
Units

Units

Type     string
Read Only    Yes
UpperBound

Maximum value extracted from existing design points and/or sample sets.

Type     double
Read Only    Yes

Methods

CreateOptimizationCriterion

Creates an OptimizationCriterion entity associated to a parameter.

Return     The DataReference of the OptimizationCriterion.
    Type     DataReference

Required Arguments

Parameter    The parameter on which the criterion is created.
    Type     DataReference
Example

The following example shows how to create an OptimizationCriterion entity. 

    container = system1.GetContainer(ComponentName="Optimization")
    model = container.GetModel()
    parameter1 = model.GetParameter(Name="P1")
    optimizationCriterion = parameter1.CreateOptimizationCriterion()

GetOptimizationCriterion

Get the DataReference of the OptimizationCriterion associated with a Parameter. An exception is thrown if the entity is not found.

Return     The DataReference of the OptimizationCriterion.
    Type     DataReference

Required Arguments

Parameter    Parent Parameter.
    Type     DataReference
Example

The following example shows how the user can get a OptimizationCriterion to change one of its properties. 

    system1 = GetSystem(Name="RSO")
    optimization1 = system1.GetContainer(ComponentName="Optimization")
    optimizationModel1 = optimization1.GetModel()
    parameter3 = optimizationModel1.GetParameter(Name="P3")
    optimizationCriterion = parameter3.GetOptimizationCriterion()
    optimizationCriterion.ObjectiveType = "eGT_MinimumPossible"

GetParameterStatistics

Get the DataReference of the ParameterStatistics entity associated with a Parameter.

Return     The DataReference of the ParameterStatistics entity.
    Type     DataReference
Example

The following example shows how the user can get a ParameterStatistics entity and examine its Mean property. 

    system1 = GetSystem(Name="SSA")
    sixSigmaAnalysis1 = system1.GetContainer(ComponentName="Six Sigma Analysis")
    sixSigmaModel1 = sixSigmaAnalysis1.GetModel()
    parameter4 = sixSigmaModel1.GetParameter(Name="P4")
    parameterStatistics1 = parameter4.GetParameterStatistics()
    mean = parameterStatistics1.Mean

ParameterRelationship

Entity which manages the calculated Statistics of a parameter for a Six-Sigma Component

Properties

Enabled

True if the Parameter is enabled for the current study.

Type     bool
Read Only    No
ErrorMessage

Error Message associated to the Parameter Relationship.

Type     string
Read Only    Yes
LeftExpression

Left Expression of Parameter Relationship.

Type     string
Read Only    No
LeftExpressionQuantityName

Quantity Name of Left Expression of Parameter Relationship.

Type     string
Read Only    No
LeftExpressionValue

Value of the left expression (as a quantity string), or an error message.

Type     string
Read Only    Yes
RelationshipType

Type of Parameter Relationship.

Type     ParameterRelationshipType
Read Only    No
RightExpression

Right Expression of Parameter Relationship.

Type     string
Read Only    No
RightExpressionQuantityName

Quantity Name of Right Expression of Parameter Relationship.

Type     string
Read Only    No
RightExpressionValue

Value of the right expression (as a quantity string), or an error message.

Type     string
Read Only    Yes

Methods

DuplicateParameterRelationship

Duplicates a Parameter Relationship.

Return     The created entity.
    Type     DataReference

Optional Arguments

TargetModel    The model on which the Parameter Relationship is created. If this parameter is not set, the model of the source Parameter Relationship is used.
    Type     DataReference
Example

The following example shows how to duplicate a Parameter Relationship. 

    container = system1.GetContainer(ComponentName="Optimization")
    model = container.GetModel()
    pr1 = model.GetParameterRelationship(Name="ParameterRelationShip")
    pr2 = pr1.DuplicateParameterRelationship()
    container = system1.GetContainer(ComponentName="Optimization 1")
    model2 = container.GetModel()
    pr3 = pr1.DuplicateParameterRelationship(TargetModel = model2)

GetChart

Get the DataReference of the ParameterRelationshipChart associated with a ParameterRelationship. An exception is thrown if the entity is not found.

Return     The DataReference of the ParameterRelationshipChart.
    Type     DataReference
Example

The following example shows how the user can get a ParameterRelationshipChart to export its data as .csv file. 

    system1 = GetSystem(Name="RSO")
    optimization1 = system1.GetContainer(ComponentName="Optimization")
    optimizationModel1 = optimization1.GetModel()
    parameterRelationship1 = optimizationModel1.GetParameterRelationship(Name="ParameterRelationship")
    chart1 = parameterRelationship1.GetChart()
    Parameters.ExportData(Data=chart1,FileName="E:/Temp/Relationship.csv")

ParameterRelationshipChart

The data entity which describes a ParameterRelationship chart. It allows you to visualize how parameter relationship evolves during the optimization process, depending on the optimizer.

Properties

DisplayParameterFullName

If True, the legend of the chart contains the full name of the parameters. Otherwise it contains the short name such as "P1".

Type     bool
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
IsUpToDate

True if the entity is up-to-date.

Type     bool
Read Only    No

ScreeningOptimization

Entity which performs and manages the DesignXplorer Optimization Method Component

Properties

Converged

Convergence state

Type     bool
Read Only    Yes
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
MaximumNumberOfPermutations

Maximum number of permutations for discrete / manufacturable values.

Type     int
Read Only    Yes
MaxNumCandidates

Maximum Number of Candidates

Type     int
Read Only    No
NumberOfEvaluations

Number of Evaluations

Type     int
Read Only    Yes
NumberOfFailures

Number of Failures

Type     int
Read Only    Yes
NumberOfSamples

Number of Samples

Type     int
Read Only    No
NumCandidates

Number of Candidates

Type     int
Read Only    Yes
SampleSetSize

Size of Generated Sample Set

Type     int
Read Only    Yes