Interface: IUserOptimizer

IUserOptimizer defines a collection of properties reflecting both the attributes of the optimizer, as defined in the extension's xml file, and the current values for the corresponding properties. For instance, it provides the value of the capability MaximumNumberOfInputParameters which can be checked against the actual number of defined input parameters in the optimization study (property NumberOfInputParametersDefined). An object implementing IUserOptimizer is passed to each callback declared in the extension.

Implemented types

Methods

Name Description
NotifyChange() Notify the application object that something has changed and that an update is required.

Properties

Name Description
AllProperties Gets all properties (flat view).
Attributes Gets the collection of attributes.
BasedOnDirectOptimizationOnly Value of the BasedOnDirectOptimizationOnly attribute of the optimizer. True if the optimizer is only available in the context of a Direct Optimization component.
BasedOnResponseSurfaceOnly Value of the BasedOnResponseSurfaceOnly attribute of the optimizer. True if the optimizer is only available in the context of a Response Surface component.
Caption Gets the caption of the object.
ConstraintHandling Value of the ConstraintHandling attribute of the optimizer. Indicates if Constraint Handling is supported.
ConstraintImportance Value of the ConstraintImportance attribute of the optimizer. Indicates if the Importance property of a constraint is supported.
ConstraintOnInputParameter Value of the ConstraintOnInputParameter attribute of the optimizer. Indicates if constraints defined on an Input Parameter are supported.
Controller Gets the controller associated to the object.
ConvergenceData Value of the ConvergenceData attribute of the optimizer. Indicates if convergence data are supported.
EqualToConstraint Value of the EqualToConstraint attribute of the optimizer. Indicates if the Equal To constraint type is supported.
EqualToConstraintDefined Actual number of Equal To constraints defined in the optimization study.
Extension Gets the extension associated to the object.
GreaterThanConstraint Value of the GreaterThanConstraint attribute of the optimizer. Indicates if the Greater Than constraint type is supported.
GreaterThanConstraintDefined Actual number of Greater Than constraints defined in the optimization study.
HistoryChartXAxisType Value of the HistoryChartXAxisType attribute of the optimizer. Defines the X axis type for history charts.
Icon Gets the icon name of the object.
Id Gets the identifier of the object.
InsideBoundsConstraint Value of the InsideBoundsConstraint attribute of the optimizer. Indicates if the Inside Bounds constraint type is supported.
InsideBoundsConstraintDefined Actual number of Inside Bounds constraints defined in the optimization study.
IsDirectOptimization True if the optimization study is defined in a Direct Optimization context, False if defined in a Response Surface context.
LessThanConstraint Value of the LessThanConstraint attribute of the optimizer. Indicates if the Less Than constraint type is supported.
LessThanConstraintDefined Actual number of Less Than constraints defined in the optimization study.
LogFile Value of the LogFile attribute of the optimizer. Indicates if the optimizer provides messages to generate a log file.
MaximizeObjective Value of the MaximizeObjective attribute of the optimizer. Indicates if the Maximize objective type is supported.
MaximizeObjectiveDefined Actual number of Maximize objectives defined in the optimization study.
MaximumNumberOfConstraints Value of the MaximumNumberOfConstraints attribute of the optimizer. Defines the maximum number of constraints supported by the optimizer.
MaximumNumberOfDoubleListParameters Value of the MaximumNumberOfDoubleListParameters attribute of the optimizer. Indicates the maximum number of double list parameters supported.
MaximumNumberOfDoubleParameters Value of the MaximumNumberOfDoubleParameters attribute of the optimizer. Indicates the maximum number of double parameters supported.
MaximumNumberOfInputParameters Value of the MaximumNumberOfInputParameters attribute of the optimizer. Indicates the maximum number of input parameters supported.
MaximumNumberOfIntegerListParameters Value of the MaximumNumberOfIntegerListParameters attribute of the optimizer. Indicates the maximum number of integer list parameters supported.
MaximumNumberOfObjectives Value of the MaximumNumberOfObjectives attribute of the optimizer. Defines the maximum number of objectives supported by the optimizer.
MinimizeObjective Value of the MinimizeObjective attribute of the optimizer. Indicates if the Minimize objective type is supported.
MinimizeObjectiveDefined Actual number of Minimize objectives defined in the optimization study.
MinimumNumberOfConstraints Value of the MinimumNumberOfConstraints attribute of the optimizer. Defines the minimum number of constraints required.
MinimumNumberOfObjectives Value of the MinimumNumberOfObjectives attribute of the optimizer. Defines the minimum number of objectives required.
Name Gets the internal name of the object.
NumberOfConstraintsDefined Actual number of constraints defined in the optimization study.
NumberOfConstraintsDefinedOnInputs Actual number of constraints defined on input parameters in the optimization study.
NumberOfDoubleListParametersDefined Actual number of double list parameters defined in the optimization study.
NumberOfDoubleParametersDefined Actual number of double parameters defined in the optimization study.
NumberOfInputParametersDefined Actual number of input parameters defined in the optimization study.
NumberOfIntegerListParametersDefined Actual number of integer list parameters defined in the optimization study.
NumberOfObjectivesDefined Actual number of objectives defined in the optimization study.
NumberOfObjectivesDefinedOnInputs Actual number of objectives defined on input parameters in the optimization study.
ObjectiveImportance Value of the ObjectiveImportance attribute of the optimizer. Indicates if the Importance property of an objective is supported.
ObjectiveOnInputParameter Value of the ObjectiveOnInputParameter attribute of the optimizer. Indicates if objectives defined on an Input Parameter are supported.
ObjectLocation Gets the location of the object within his parent.
ObjectType Gets the type of the object.
ParameterRelationship Value of the ParameterRelationship attribute of the optimizer. Indicates if parameter relationships are supported.
Parent Gets the parent object.
Properties Gets the collection of properties.
SeekObjective Value of the SeekObjective attribute of the optimizer. Indicates if the Seek objective type is supported.
SeekObjectiveDefined Actual number of Seek objectives defined in the optimization study.
StartingPointRequired Value of the StartingPointRequired attribute of the optimizer. Indicates if the optimizer requires a starting point.
State Gets the state of the object.
SupportedLocations Gets the locations supported by the object.
Version Gets the version of the object.