nxopen.optimization

Interface OptimizationBuilder

All Superinterfaces:

Builder, IComponentBuilder, Remote, TaggedObject

public interface OptimizationBuilder
extends Builder

Represents a OptimizationBuilder
To create a new instance of this class, use OptimizationCollection.createOptimizationBuilder()

Created in NX6.0.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	OptimizationBuilder.OptimizationAlgorithmType Algorithm type
static class	OptimizationBuilder.OptimizationAttributeType Attribute type
static class	OptimizationBuilder.OptimizationConstraint Defined constraint structure
static class	OptimizationBuilder.OptimizationConstraintLimitType Constraint limit type
static class	OptimizationBuilder.OptimizationConvergenceSpeedType Convergence speed type
static class	OptimizationBuilder.OptimizationObjective Defined Objective Structure
static class	OptimizationBuilder.OptimizationTargetType Optimization type for objective
static class	OptimizationBuilder.OptimizationVariable Defined variable structure

Method Summary

Modifier and Type	Method and Description
double	absoluteConvergenceCriteria() Returns the absolute criteria for optimizer to determine convergence.
OptimizationBuilder.OptimizationAlgorithmType	algorithmType() Returns the algorithm type License requirements: None.
void	buildAllConstraints() Build all the constraints License requirements: None.
void	buildAllObjectives() Build all the objectives License requirements: None.
void	buildAllVariables() Build all the variables License requirements: None.
OptimizationBuilder.OptimizationConvergenceSpeedType	convergenceSpeedType() Returns the convergence speed type License requirements: None.
OptimizationBuilder.OptimizationConstraint[]	getOptimizationConstraints() Returns the constraints License requirements: None.
OptimizationBuilder.OptimizationObjective[]	getOptimizationObjectives() Returns the objectives License requirements: None.
OptimizationBuilder.OptimizationVariable[]	getOptimizationVariables() Returns the variables License requirements: None.
boolean	isShowGraph() Returns the property - is show graph License requirements: None.
boolean	isUpdateDisp() Returns the property - is update display License requirements: None.
int	maxNumberIteration() Returns the maximum number of updates allowed without converging to a solutionthe maximum iterations time License requirements: None.
int	maxTime() Returns the maximum time allowed for this run in seconds License requirements: None.
OptimizationBuilder.OptimizationTargetType	optimizationType() Returns the optimization type License requirements: None.
double	relativeConvergenceCriteria() Returns the relative criteria for optimizer to determine convergence.
void	removeAllConstraints() Remove all the constraints License requirements: None.
void	removeAllObjectives() Remove all the objectives License requirements: None.
void	removeAllVariables() Remove all the variables License requirements: None.
void	runOptimization() Run optimization process License requirements: None.
void	setAbsoluteConvergenceCriteria(double absoluteConvergenceCriteria) License requirements: None.
void	setAlgorithmType(OptimizationBuilder.OptimizationAlgorithmType algorithmType) License requirements: None.
void	setConvergenceSpeedType(OptimizationBuilder.OptimizationConvergenceSpeedType convergenceSpeedType) License requirements: None.
void	setMaxNumberIteration(int maxNumberIteration) License requirements: None.
void	setMaxTime(int maxTime) License requirements: None.
void	setOptimizationConstraints(String[] attributeNames, NXObject[] attributeObjects, OptimizationBuilder.OptimizationAttributeType[] constraintTypes, double[] constraintLowerLimitValue, double[] constraintUpperLimitValue, OptimizationBuilder.OptimizationConstraintLimitType[] constraintLimitType) Sets the constraints License requirements: None.
void	setOptimizationObjectives(String[] attributeNames, NXObject[] attributeObjects, OptimizationBuilder.OptimizationAttributeType[] objectiveTypes, double[] objectiveTargetValues) Sets the objectives License requirements: None.
void	setOptimizationType(OptimizationBuilder.OptimizationTargetType optimizationType) License requirements: None.
void	setOptimizationVariables(String[] attributeNames, NXObject[] attributeObjects, OptimizationBuilder.OptimizationAttributeType[] variableTypes, double[] variableLowerLimitValue, double[] variableUpperLimitValue) Sets the variables License requirements: None.
void	setRelativeConvergenceCriteria(double relativeConvergenceCriteria) License requirements: None.
void	setShowGraph(boolean isShowGraph) License requirements: None.
void	setStudyName(String studyName) License requirements: None.
void	setUpdateDisp(boolean isUpdateDisp) License requirements: None.
String	studyName() Returns the study name which is unique in one part License requirements: None.

Methods inherited from interface nxopen.Builder

commit, destroy, getCommittedObjects, getObject, showResults

Methods inherited from interface nxopen.TaggedObject

printTestData, printTestData, tag, tagValue

Methods inherited from interface nxopen.geometricutilities.IComponentBuilder

validate

Method Detail

studyName

String studyName()
          throws NXException,
                 RemoteException

Returns the study name which is unique in one part
License requirements: None.

Created in NX6.0.0

Throws:

NXException

RemoteException

setStudyName

void setStudyName(String studyName)
           throws NXException,
                  RemoteException

License requirements: None.

Created in NX6.0.0

Parameters:

studyName -

Throws:

NXException

RemoteException

optimizationType

OptimizationBuilder.OptimizationTargetType optimizationType()
                                                     throws NXException,
                                                            RemoteException

Returns the optimization type
License requirements: None.

Created in NX6.0.0

Throws:

NXException

RemoteException

setOptimizationType

void setOptimizationType(OptimizationBuilder.OptimizationTargetType optimizationType)
                  throws NXException,
                         RemoteException

License requirements: None.

Created in NX6.0.0

Parameters:

optimizationType -

Throws:

NXException

RemoteException

algorithmType

OptimizationBuilder.OptimizationAlgorithmType algorithmType()
                                                     throws NXException,
                                                            RemoteException

Returns the algorithm type
License requirements: None.

Created in NX6.0.0

Throws:

NXException

RemoteException

setAlgorithmType

void setAlgorithmType(OptimizationBuilder.OptimizationAlgorithmType algorithmType)
               throws NXException,
                      RemoteException

License requirements: None.

Created in NX6.0.0

Parameters:

algorithmType -

Throws:

NXException

RemoteException

runOptimization

void runOptimization()
              throws NXException,
                     RemoteException

Run optimization process
License requirements: None.

Created in NX6.0.0

Throws:

NXException

RemoteException

convergenceSpeedType

OptimizationBuilder.OptimizationConvergenceSpeedType convergenceSpeedType()
                                                                   throws NXException,
                                                                          RemoteException

Returns the convergence speed type
License requirements: None.

Created in NX6.0.0

Throws:

NXException

RemoteException

setConvergenceSpeedType

void setConvergenceSpeedType(OptimizationBuilder.OptimizationConvergenceSpeedType convergenceSpeedType)
                      throws NXException,
                             RemoteException

License requirements: None.

Created in NX6.0.0

Parameters:

convergenceSpeedType -

Throws:

NXException

RemoteException

maxNumberIteration

int maxNumberIteration()
                throws NXException,
                       RemoteException

Returns the maximum number of updates allowed without converging to a solutionthe maximum iterations time
License requirements: None.

Created in NX6.0.0

Throws:

NXException

RemoteException

setMaxNumberIteration

void setMaxNumberIteration(int maxNumberIteration)
                    throws NXException,
                           RemoteException

License requirements: None.

Created in NX6.0.0

Parameters:

maxNumberIteration -

Throws:

NXException

RemoteException

maxTime

int maxTime()
     throws NXException,
            RemoteException

Returns the maximum time allowed for this run in seconds
License requirements: None.

Created in NX6.0.0

Throws:

NXException

RemoteException

setMaxTime

void setMaxTime(int maxTime)
         throws NXException,
                RemoteException

License requirements: None.

Created in NX6.0.0

Parameters:

maxTime -

Throws:

NXException

RemoteException

absoluteConvergenceCriteria

double absoluteConvergenceCriteria()
                            throws NXException,
                                   RemoteException

Returns 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
License requirements: None.

Created in NX6.0.0

Throws:

NXException

RemoteException

setAbsoluteConvergenceCriteria

void setAbsoluteConvergenceCriteria(double absoluteConvergenceCriteria)
                             throws NXException,
                                    RemoteException

License requirements: None.

Created in NX6.0.0

Parameters:

absoluteConvergenceCriteria -

Throws:

NXException

RemoteException

relativeConvergenceCriteria

double relativeConvergenceCriteria()
                            throws NXException,
                                   RemoteException

Returns 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
License requirements: None.

Created in NX6.0.0

Throws:

NXException

RemoteException

setRelativeConvergenceCriteria

void setRelativeConvergenceCriteria(double relativeConvergenceCriteria)
                             throws NXException,
                                    RemoteException

License requirements: None.

Created in NX6.0.0

Parameters:

relativeConvergenceCriteria -

Throws:

NXException

RemoteException

isUpdateDisp

boolean isUpdateDisp()
              throws NXException,
                     RemoteException

Returns the property - is update display
License requirements: None.

Created in NX6.0.0

Throws:

NXException

RemoteException

setUpdateDisp

void setUpdateDisp(boolean isUpdateDisp)
            throws NXException,
                   RemoteException

License requirements: None.

Created in NX6.0.0

Parameters:

isUpdateDisp -

Throws:

NXException

RemoteException

isShowGraph

boolean isShowGraph()
             throws NXException,
                    RemoteException

Returns the property - is show graph
License requirements: None.

Created in NX6.0.0

Throws:

NXException

RemoteException

setShowGraph

void setShowGraph(boolean isShowGraph)
           throws NXException,
                  RemoteException

License requirements: None.

Created in NX6.0.0

Parameters:

isShowGraph -

Throws:

NXException

RemoteException

getOptimizationObjectives

OptimizationBuilder.OptimizationObjective[] getOptimizationObjectives()
                                                               throws NXException,
                                                                      RemoteException

Returns the objectives
License requirements: None.

Created in NX6.0.0

Returns:

Objectives

Throws:

NXException

RemoteException

setOptimizationObjectives

void setOptimizationObjectives(String[] attributeNames,
                               NXObject[] attributeObjects,
                               OptimizationBuilder.OptimizationAttributeType[] objectiveTypes,
                               double[] objectiveTargetValues)
                        throws NXException,
                               RemoteException

Sets the objectives
License requirements: None.

Created in NX6.0.0

Parameters:

attributeNames - Objective attribute name array

attributeObjects - Objective attribute object array

objectiveTypes - Objective attribute type array

objectiveTargetValues - Objective target value array

Throws:

NXException

RemoteException

getOptimizationVariables

OptimizationBuilder.OptimizationVariable[] getOptimizationVariables()
                                                             throws NXException,
                                                                    RemoteException

Returns the variables
License requirements: None.

Created in NX6.0.0

Returns:

Variables

Throws:

NXException

RemoteException

setOptimizationVariables

void setOptimizationVariables(String[] attributeNames,
                              NXObject[] attributeObjects,
                              OptimizationBuilder.OptimizationAttributeType[] variableTypes,
                              double[] variableLowerLimitValue,
                              double[] variableUpperLimitValue)
                       throws NXException,
                              RemoteException

Sets the variables
License requirements: None.

Created in NX6.0.0

Parameters:

attributeNames - Variable attribute name array

attributeObjects - Variable attribute object array

variableTypes - Variable attribute type array

variableLowerLimitValue - Variable lower limit value array

variableUpperLimitValue - Variable upper limit value array

Throws:

NXException

RemoteException

getOptimizationConstraints

OptimizationBuilder.OptimizationConstraint[] getOptimizationConstraints()
                                                                 throws NXException,
                                                                        RemoteException

Returns the constraints
License requirements: None.

Created in NX6.0.0

Returns:

Constraints

Throws:

NXException

RemoteException

setOptimizationConstraints

void setOptimizationConstraints(String[] attributeNames,
                                NXObject[] attributeObjects,
                                OptimizationBuilder.OptimizationAttributeType[] constraintTypes,
                                double[] constraintLowerLimitValue,
                                double[] constraintUpperLimitValue,
                                OptimizationBuilder.OptimizationConstraintLimitType[] constraintLimitType)
                         throws NXException,
                                RemoteException

Sets the constraints
License requirements: None.

Created in NX6.0.0

Parameters:

attributeNames - Constraint attribute name array

attributeObjects - Constraint attribute type array

constraintTypes - Constraint attribute type array

constraintLowerLimitValue - Constraint lower limit value array

constraintUpperLimitValue - Constraint upper limit value array

constraintLimitType - Constraint atribute limit type array

Throws:

NXException

RemoteException

buildAllObjectives

void buildAllObjectives()
                 throws NXException,
                        RemoteException

Build all the objectives
License requirements: None.

Created in NX6.0.0

Throws:

NXException

RemoteException

removeAllObjectives

void removeAllObjectives()
                  throws NXException,
                         RemoteException

Remove all the objectives
License requirements: None.

Created in NX6.0.0

Throws:

NXException

RemoteException

buildAllVariables

void buildAllVariables()
                throws NXException,
                       RemoteException

Build all the variables
License requirements: None.

Created in NX6.0.0

Throws:

NXException

RemoteException

removeAllVariables

void removeAllVariables()
                 throws NXException,
                        RemoteException

Remove all the variables
License requirements: None.

Created in NX6.0.0

Throws:

NXException

RemoteException

buildAllConstraints

void buildAllConstraints()
                  throws NXException,
                         RemoteException

Build all the constraints
License requirements: None.

Created in NX6.0.0

Throws:

NXException

RemoteException

removeAllConstraints

void removeAllConstraints()
                   throws NXException,
                          RemoteException

Remove all the constraints
License requirements: None.

Created in NX6.0.0

Throws:

NXException

RemoteException