OptimizationBuilder Class¶
-
class
NXOpen.Optimization.
OptimizationBuilder
¶ Bases:
NXOpen.Builder
Represents a
NXOpen.Optimization.OptimizationBuilder
To create a new instance of this class, use
NXOpen.Optimization.OptimizationCollection.CreateOptimizationBuilder()
New in version NX6.0.0.
Properties¶
Property | Description |
---|---|
AbsoluteConvergenceCriteria | Returns or sets the absolute criteria for optimizer to determine convergence. |
AlgorithmType | Returns or sets the algorithm type |
ConvergenceSpeedType | Returns or sets the convergence speed type |
IsShowGraph | Returns or sets the property - is show graph |
IsUpdateDisp | Returns or sets the property - is update display |
MaxNumberIteration | Returns or sets the maximum number of updates allowed without converging to a solutionthe maximum iterations time |
MaxTime | Returns or sets the maximum time allowed for this run in seconds |
OptimizationType | Returns or sets the optimization type |
RelativeConvergenceCriteria | Returns or sets the relative criteria for optimizer to determine convergence. |
StudyName | Returns or sets the study name which is unique in one part |
Tag | Returns the Tag for this object. |
Methods¶
Method | Description |
---|---|
BuildAllConstraints | Build all the constraints |
BuildAllObjectives | Build all the objectives |
BuildAllVariables | Build all the variables |
Commit | Commits any edits that have been applied to the builder. |
Destroy | Deletes the builder, and cleans up any objects created by the builder. |
GetCommittedObjects | For builders that create more than one object, this method returns the objects that are created by commit. |
GetObject | Returns the object currently being edited by this builder. |
GetOptimizationConstraints | Returns the constraints |
GetOptimizationObjectives | Returns the objectives |
GetOptimizationVariables | Returns the variables |
RemoveAllConstraints | Remove all the constraints |
RemoveAllObjectives | Remove all the objectives |
RemoveAllVariables | Remove all the variables |
RunOptimization | Run optimization process |
SetOptimizationConstraints | Sets the constraints |
SetOptimizationObjectives | Sets the objectives |
SetOptimizationVariables | Sets the variables |
ShowResults | Updates the model to reflect the result of an edit to the model for all builders that support showing results. |
Validate | Validate whether the inputs to the component are sufficient for commit to be called. |
Enumerations¶
OptimizationBuilderOptimizationAlgorithmType Enumeration | Algorithm type |
OptimizationBuilderOptimizationAttributeType Enumeration | Attribute type |
OptimizationBuilderOptimizationConstraintLimitType Enumeration | Constraint limit type |
OptimizationBuilderOptimizationConvergenceSpeedType Enumeration | Convergence speed type |
OptimizationBuilderOptimizationTargetType Enumeration | Optimization type for objective |
Structs¶
OptimizationBuilderOptimizationConstraint_Struct Struct | Defined constraint structure |
OptimizationBuilderOptimizationObjective_Struct Struct | Defined Objective Structure |
OptimizationBuilderOptimizationVariable_Struct Struct | Defined variable structure |
Property Detail¶
AbsoluteConvergenceCriteria¶
-
OptimizationBuilder.
AbsoluteConvergenceCriteria
¶ Returns or sets the absolute criteria for optimizer to determine convergence.
This value is multiplied by the first objective result,and if the difference in last two objective results is less than this, then it is converged
-------------------------------------
Getter Method
Signature
AbsoluteConvergenceCriteria
Returns: Return type: float New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
AbsoluteConvergenceCriteria
Parameters: absoluteConvergenceCriteria (float) – New in version NX6.0.0.
License requirements: None.
AlgorithmType¶
-
OptimizationBuilder.
AlgorithmType
¶ Returns or sets the algorithm type
-------------------------------------
Getter Method
Signature
AlgorithmType
Returns: Return type: NXOpen.Optimization.OptimizationBuilderOptimizationAlgorithmType
New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
AlgorithmType
Parameters: algorithmType ( NXOpen.Optimization.OptimizationBuilderOptimizationAlgorithmType
) –New in version NX6.0.0.
License requirements: None.
ConvergenceSpeedType¶
-
OptimizationBuilder.
ConvergenceSpeedType
¶ Returns or sets the convergence speed type
-------------------------------------
Getter Method
Signature
ConvergenceSpeedType
Returns: Return type: NXOpen.Optimization.OptimizationBuilderOptimizationConvergenceSpeedType
New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ConvergenceSpeedType
Parameters: convergenceSpeedType ( NXOpen.Optimization.OptimizationBuilderOptimizationConvergenceSpeedType
) –New in version NX6.0.0.
License requirements: None.
IsShowGraph¶
-
OptimizationBuilder.
IsShowGraph
¶ Returns or sets the property - is show graph
-------------------------------------
Getter Method
Signature
IsShowGraph
Returns: Return type: bool New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
IsShowGraph
Parameters: isShowGraph (bool) – New in version NX6.0.0.
License requirements: None.
IsUpdateDisp¶
-
OptimizationBuilder.
IsUpdateDisp
¶ Returns or sets the property - is update display
-------------------------------------
Getter Method
Signature
IsUpdateDisp
Returns: Return type: bool New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
IsUpdateDisp
Parameters: isUpdateDisp (bool) – New in version NX6.0.0.
License requirements: None.
MaxNumberIteration¶
-
OptimizationBuilder.
MaxNumberIteration
¶ Returns or sets the maximum number of updates allowed without converging to a solutionthe maximum iterations time
-------------------------------------
Getter Method
Signature
MaxNumberIteration
Returns: Return type: int New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
MaxNumberIteration
Parameters: maxNumberIteration (int) – New in version NX6.0.0.
License requirements: None.
MaxTime¶
-
OptimizationBuilder.
MaxTime
¶ Returns or sets the maximum time allowed for this run in seconds
-------------------------------------
Getter Method
Signature
MaxTime
Returns: Return type: int New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
MaxTime
Parameters: maxTime (int) – New in version NX6.0.0.
License requirements: None.
OptimizationType¶
-
OptimizationBuilder.
OptimizationType
¶ Returns or sets the optimization type
-------------------------------------
Getter Method
Signature
OptimizationType
Returns: Return type: NXOpen.Optimization.OptimizationBuilderOptimizationTargetType
New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
OptimizationType
Parameters: optimizationType ( NXOpen.Optimization.OptimizationBuilderOptimizationTargetType
) –New in version NX6.0.0.
License requirements: None.
RelativeConvergenceCriteria¶
-
OptimizationBuilder.
RelativeConvergenceCriteria
¶ Returns or sets the relative criteria for optimizer to determine convergence.
If one minus the ratio of the last two iterations is less than this value, the solution is converged
-------------------------------------
Getter Method
Signature
RelativeConvergenceCriteria
Returns: Return type: float New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
RelativeConvergenceCriteria
Parameters: relativeConvergenceCriteria (float) – New in version NX6.0.0.
License requirements: None.
StudyName¶
-
OptimizationBuilder.
StudyName
¶ Returns or sets the study name which is unique in one part
-------------------------------------
Getter Method
Signature
StudyName
Returns: Return type: str New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
StudyName
Parameters: studyName (str) – New in version NX6.0.0.
License requirements: None.
Method Detail¶
BuildAllConstraints¶
-
OptimizationBuilder.
BuildAllConstraints
¶ Build all the constraints
Signature
BuildAllConstraints()
New in version NX6.0.0.
License requirements: None.
BuildAllObjectives¶
-
OptimizationBuilder.
BuildAllObjectives
¶ Build all the objectives
Signature
BuildAllObjectives()
New in version NX6.0.0.
License requirements: None.
BuildAllVariables¶
-
OptimizationBuilder.
BuildAllVariables
¶ Build all the variables
Signature
BuildAllVariables()
New in version NX6.0.0.
License requirements: None.
GetOptimizationConstraints¶
-
OptimizationBuilder.
GetOptimizationConstraints
¶ Returns the constraints
Signature
GetOptimizationConstraints()
Returns: Constraints Return type: list of NXOpen.Optimization.OptimizationBuilderOptimizationConstraint_Struct
New in version NX6.0.0.
License requirements: None.
GetOptimizationObjectives¶
-
OptimizationBuilder.
GetOptimizationObjectives
¶ Returns the objectives
Signature
GetOptimizationObjectives()
Returns: Objectives Return type: list of NXOpen.Optimization.OptimizationBuilderOptimizationObjective_Struct
New in version NX6.0.0.
License requirements: None.
GetOptimizationVariables¶
-
OptimizationBuilder.
GetOptimizationVariables
¶ Returns the variables
Signature
GetOptimizationVariables()
Returns: Variables Return type: list of NXOpen.Optimization.OptimizationBuilderOptimizationVariable_Struct
New in version NX6.0.0.
License requirements: None.
RemoveAllConstraints¶
-
OptimizationBuilder.
RemoveAllConstraints
¶ Remove all the constraints
Signature
RemoveAllConstraints()
New in version NX6.0.0.
License requirements: None.
RemoveAllObjectives¶
-
OptimizationBuilder.
RemoveAllObjectives
¶ Remove all the objectives
Signature
RemoveAllObjectives()
New in version NX6.0.0.
License requirements: None.
RemoveAllVariables¶
-
OptimizationBuilder.
RemoveAllVariables
¶ Remove all the variables
Signature
RemoveAllVariables()
New in version NX6.0.0.
License requirements: None.
RunOptimization¶
-
OptimizationBuilder.
RunOptimization
¶ Run optimization process
Signature
RunOptimization()
New in version NX6.0.0.
License requirements: None.
SetOptimizationConstraints¶
-
OptimizationBuilder.
SetOptimizationConstraints
¶ Sets the constraints
Signature
SetOptimizationConstraints(attributeNames, attributeObjects, constraintTypes, constraintLowerLimitValue, constraintUpperLimitValue, constraintLimitType)
Parameters: - attributeNames (list of str) – Constraint attribute name array
- attributeObjects (list of
NXOpen.NXObject
) – Constraint attribute type array - constraintTypes (list of
NXOpen.Optimization.OptimizationBuilderOptimizationAttributeType
) – Constraint attribute type array - constraintLowerLimitValue (list of float) – Constraint lower limit value array
- constraintUpperLimitValue (list of float) – Constraint upper limit value array
- constraintLimitType (list of
NXOpen.Optimization.OptimizationBuilderOptimizationConstraintLimitType
) – Constraint atribute limit type array
New in version NX6.0.0.
License requirements: None.
SetOptimizationObjectives¶
-
OptimizationBuilder.
SetOptimizationObjectives
¶ Sets the objectives
Signature
SetOptimizationObjectives(attributeNames, attributeObjects, objectiveTypes, objectiveTargetValues)
Parameters: - attributeNames (list of str) – Objective attribute name array
- attributeObjects (list of
NXOpen.NXObject
) – Objective attribute object array - objectiveTypes (list of
NXOpen.Optimization.OptimizationBuilderOptimizationAttributeType
) – Objective attribute type array - objectiveTargetValues (list of float) – Objective target value array
New in version NX6.0.0.
License requirements: None.
SetOptimizationVariables¶
-
OptimizationBuilder.
SetOptimizationVariables
¶ Sets the variables
Signature
SetOptimizationVariables(attributeNames, attributeObjects, variableTypes, variableLowerLimitValue, variableUpperLimitValue)
Parameters: - attributeNames (list of str) – Variable attribute name array
- attributeObjects (list of
NXOpen.NXObject
) – Variable attribute object array - variableTypes (list of
NXOpen.Optimization.OptimizationBuilderOptimizationAttributeType
) – Variable attribute type array - variableLowerLimitValue (list of float) – Variable lower limit value array
- variableUpperLimitValue (list of float) – Variable upper limit value array
New in version NX6.0.0.
License requirements: None.
Validate¶
-
OptimizationBuilder.
Validate
¶ Validate whether the inputs to the component are sufficient for commit to be called.
If the component is not in a state to commit then an exception is thrown. For example, if the component requires you to set some property, this method will throw an exception if you haven’t set it. This method throws a not-yet-implemented NXException for some components.
Signature
Validate()
Returns: Was self validation successful Return type: bool New in version NX3.0.1.
License requirements: None.