public interface OptimizationBuilder extends Builder
OptimizationBuilder
OptimizationCollection.createOptimizationBuilder()
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
|
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. |
commit, destroy, getCommittedObjects, getObject, showResults
printTestData, printTestData, tag, tagValue
validate
String studyName() throws NXException, RemoteException
NXException
RemoteException
void setStudyName(String studyName) throws NXException, RemoteException
studyName
- NXException
RemoteException
OptimizationBuilder.OptimizationTargetType optimizationType() throws NXException, RemoteException
NXException
RemoteException
void setOptimizationType(OptimizationBuilder.OptimizationTargetType optimizationType) throws NXException, RemoteException
optimizationType
- NXException
RemoteException
OptimizationBuilder.OptimizationAlgorithmType algorithmType() throws NXException, RemoteException
NXException
RemoteException
void setAlgorithmType(OptimizationBuilder.OptimizationAlgorithmType algorithmType) throws NXException, RemoteException
algorithmType
- NXException
RemoteException
void runOptimization() throws NXException, RemoteException
NXException
RemoteException
OptimizationBuilder.OptimizationConvergenceSpeedType convergenceSpeedType() throws NXException, RemoteException
NXException
RemoteException
void setConvergenceSpeedType(OptimizationBuilder.OptimizationConvergenceSpeedType convergenceSpeedType) throws NXException, RemoteException
convergenceSpeedType
- NXException
RemoteException
int maxNumberIteration() throws NXException, RemoteException
NXException
RemoteException
void setMaxNumberIteration(int maxNumberIteration) throws NXException, RemoteException
maxNumberIteration
- NXException
RemoteException
int maxTime() throws NXException, RemoteException
NXException
RemoteException
void setMaxTime(int maxTime) throws NXException, RemoteException
maxTime
- NXException
RemoteException
double absoluteConvergenceCriteria() throws NXException, RemoteException
NXException
RemoteException
void setAbsoluteConvergenceCriteria(double absoluteConvergenceCriteria) throws NXException, RemoteException
absoluteConvergenceCriteria
- NXException
RemoteException
double relativeConvergenceCriteria() throws NXException, RemoteException
NXException
RemoteException
void setRelativeConvergenceCriteria(double relativeConvergenceCriteria) throws NXException, RemoteException
relativeConvergenceCriteria
- NXException
RemoteException
boolean isUpdateDisp() throws NXException, RemoteException
NXException
RemoteException
void setUpdateDisp(boolean isUpdateDisp) throws NXException, RemoteException
isUpdateDisp
- NXException
RemoteException
boolean isShowGraph() throws NXException, RemoteException
NXException
RemoteException
void setShowGraph(boolean isShowGraph) throws NXException, RemoteException
isShowGraph
- NXException
RemoteException
OptimizationBuilder.OptimizationObjective[] getOptimizationObjectives() throws NXException, RemoteException
NXException
RemoteException
void setOptimizationObjectives(String[] attributeNames, NXObject[] attributeObjects, OptimizationBuilder.OptimizationAttributeType[] objectiveTypes, double[] objectiveTargetValues) throws NXException, RemoteException
attributeNames
- Objective attribute name array attributeObjects
- Objective attribute object arrayobjectiveTypes
- Objective attribute type arrayobjectiveTargetValues
- Objective target value arrayNXException
RemoteException
OptimizationBuilder.OptimizationVariable[] getOptimizationVariables() throws NXException, RemoteException
NXException
RemoteException
void setOptimizationVariables(String[] attributeNames, NXObject[] attributeObjects, OptimizationBuilder.OptimizationAttributeType[] variableTypes, double[] variableLowerLimitValue, double[] variableUpperLimitValue) throws NXException, RemoteException
attributeNames
- Variable attribute name array attributeObjects
- Variable attribute object arrayvariableTypes
- Variable attribute type arrayvariableLowerLimitValue
- Variable lower limit value arrayvariableUpperLimitValue
- Variable upper limit value arrayNXException
RemoteException
OptimizationBuilder.OptimizationConstraint[] getOptimizationConstraints() throws NXException, RemoteException
NXException
RemoteException
void setOptimizationConstraints(String[] attributeNames, NXObject[] attributeObjects, OptimizationBuilder.OptimizationAttributeType[] constraintTypes, double[] constraintLowerLimitValue, double[] constraintUpperLimitValue, OptimizationBuilder.OptimizationConstraintLimitType[] constraintLimitType) throws NXException, RemoteException
attributeNames
- Constraint attribute name array attributeObjects
- Constraint attribute type arrayconstraintTypes
- Constraint attribute type arrayconstraintLowerLimitValue
- Constraint lower limit value arrayconstraintUpperLimitValue
- Constraint upper limit value arrayconstraintLimitType
- Constraint atribute limit type arrayNXException
RemoteException
void buildAllObjectives() throws NXException, RemoteException
NXException
RemoteException
void removeAllObjectives() throws NXException, RemoteException
NXException
RemoteException
void buildAllVariables() throws NXException, RemoteException
NXException
RemoteException
void removeAllVariables() throws NXException, RemoteException
NXException
RemoteException
void buildAllConstraints() throws NXException, RemoteException
NXException
RemoteException
void removeAllConstraints() throws NXException, RemoteException
NXException
RemoteException
Copyright 2011 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.