NXOpen::Optimization::OptimizationBuilder Class Reference

Represents a Optimization::OptimizationBuilder
To create a new instance of this class, use Optimization::OptimizationCollection::CreateOptimizationBuilder

Created in NX6.0.0. More...

Inheritance diagram for NXOpen::Optimization::OptimizationBuilder:

Classes
struct	OptimizationConstraint
	Defined constraint structure. More...
struct	OptimizationObjective
	Defined Objective Structure. More...
struct	OptimizationVariable
	Defined variable structure. More...

Public Types
enum	OptimizationAlgorithmType {   OptimizationAlgorithmTypeSimulatedAnnealing, OptimizationAlgorithmTypeGlobalSimplex, OptimizationAlgorithmTypePowell, OptimizationAlgorithmTypeConjugateGradient,   OptimizationAlgorithmTypeLexicographic, OptimizationAlgorithmTypePatternSwarm }
	Algorithm type. More...
enum	OptimizationAttributeType { OptimizationAttributeTypeExpression, OptimizationAttributeTypeKFAttribute, OptimizationAttributeTypeGeometryParameter }
	Attribute type. More...
enum	OptimizationConstraintLimitType { OptimizationConstraintLimitTypeUpper, OptimizationConstraintLimitTypeLower }
	Constraint limit type. More...
enum	OptimizationConvergenceSpeedType { OptimizationConvergenceSpeedTypeSlow, OptimizationConvergenceSpeedTypeMedium, OptimizationConvergenceSpeedTypeFast, OptimizationConvergenceSpeedTypeInfinite }
	Convergence speed type. More...
enum	OptimizationTargetType { OptimizationTargetTypeMinimum, OptimizationTargetTypeMaximum, OptimizationTargetTypeTarget }
	Optimization type for objective. More...

Public Member Functions
double	AbsoluteConvergenceCriteria ()
	Returns the absolute criteria for optimizer to determine convergence.
NXOpen::Optimization::OptimizationBuilder::OptimizationAlgorithmType	AlgorithmType ()
	Returns the algorithm type Created in NX6.0.0.
void	BuildAllConstraints ()
	Build all the constraints Created in NX6.0.0.
void	BuildAllObjectives ()
	Build all the objectives Created in NX6.0.0.
void	BuildAllVariables ()
	Build all the variables Created in NX6.0.0.
NXOpen::Optimization::OptimizationBuilder::OptimizationConvergenceSpeedType	ConvergenceSpeedType ()
	Returns the convergence speed type Created in NX6.0.0.
std::vector < NXOpen::Optimization::OptimizationBuilder::OptimizationConstraint >	GetOptimizationConstraints ()
	Returns the constraints.
std::vector < NXOpen::Optimization::OptimizationBuilder::OptimizationObjective >	GetOptimizationObjectives ()
	Returns the objectives.
std::vector < NXOpen::Optimization::OptimizationBuilder::OptimizationVariable >	GetOptimizationVariables ()
	Returns the variables.
bool	IsShowGraph ()
	Returns the property - is show graph Created in NX6.0.0.
bool	IsUpdateDisp ()
	Returns the property - is update display Created in NX6.0.0.
int	MaxNumberIteration ()
	Returns the maximum number of updates allowed without converging to a solutionthe maximum iterations time Created in NX6.0.0.
int	MaxTime ()
	Returns the maximum time allowed for this run in seconds Created in NX6.0.0.
NXOpen::Optimization::OptimizationBuilder::OptimizationTargetType	OptimizationType ()
	Returns the optimization type Created in NX6.0.0.
double	RelativeConvergenceCriteria ()
	Returns the relative criteria for optimizer to determine convergence.
void	RemoveAllConstraints ()
	Remove all the constraints Created in NX6.0.0.
void	RemoveAllObjectives ()
	Remove all the objectives Created in NX6.0.0.
void	RemoveAllVariables ()
	Remove all the variables Created in NX6.0.0.
void	RunOptimization ()
	Run optimization process Created in NX6.0.0.
void	SetAbsoluteConvergenceCriteria (double absoluteConvergenceCriteria)
	Sets the absolute criteria for optimizer to determine convergence.
void	SetAlgorithmType (NXOpen::Optimization::OptimizationBuilder::OptimizationAlgorithmType algorithmType)
	Sets the algorithm type Created in NX6.0.0.
void	SetConvergenceSpeedType (NXOpen::Optimization::OptimizationBuilder::OptimizationConvergenceSpeedType convergenceSpeedType)
	Sets the convergence speed type Created in NX6.0.0.
void	SetMaxNumberIteration (int maxNumberIteration)
	Sets the maximum number of updates allowed without converging to a solutionthe maximum iterations time Created in NX6.0.0.
void	SetMaxTime (int maxTime)
	Sets the maximum time allowed for this run in seconds Created in NX6.0.0.
void	SetOptimizationConstraints (std::vector< NXString > &attributeNames, const std::vector< NXOpen::NXObject * > &attributeObjects, const std::vector< NXOpen::Optimization::OptimizationBuilder::OptimizationAttributeType > &constraintTypes, const std::vector< double > &constraintLowerLimitValue, const std::vector< double > &constraintUpperLimitValue, const std::vector< NXOpen::Optimization::OptimizationBuilder::OptimizationConstraintLimitType > &constraintLimitType)
	Sets the constraints Created in NX6.0.0.
void	SetOptimizationObjectives (std::vector< NXString > &attributeNames, const std::vector< NXOpen::NXObject * > &attributeObjects, const std::vector< NXOpen::Optimization::OptimizationBuilder::OptimizationAttributeType > &objectiveTypes, const std::vector< double > &objectiveTargetValues)
	Sets the objectives Created in NX6.0.0.
void	SetOptimizationType (NXOpen::Optimization::OptimizationBuilder::OptimizationTargetType optimizationType)
	Sets the optimization type Created in NX6.0.0.
void	SetOptimizationVariables (std::vector< NXString > &attributeNames, const std::vector< NXOpen::NXObject * > &attributeObjects, const std::vector< NXOpen::Optimization::OptimizationBuilder::OptimizationAttributeType > &variableTypes, const std::vector< double > &variableLowerLimitValue, const std::vector< double > &variableUpperLimitValue)
	Sets the variables Created in NX6.0.0.
void	SetRelativeConvergenceCriteria (double relativeConvergenceCriteria)
	Sets the relative criteria for optimizer to determine convergence.
void	SetShowGraph (bool isShowGraph)
	Sets the property - is show graph Created in NX6.0.0.
void	SetStudyName (const NXString &studyName)
	Sets the study name which is unique in one part Created in NX6.0.0.
void	SetStudyName (const char *studyName)
	Sets the study name which is unique in one part Created in NX6.0.0.
void	SetUpdateDisp (bool isUpdateDisp)
	Sets the property - is update display Created in NX6.0.0.
NXString	StudyName ()
	Returns the study name which is unique in one part Created in NX6.0.0.
Public Member Functions inherited from NXOpen::Builder
NXOpen::NXObject *	Commit ()
	Commits any edits that have been applied to the builder.
void	Destroy ()
	Deletes the builder, and cleans up any objects created by the builder.
std::vector< NXOpen::NXObject * >	GetCommittedObjects ()
	For builders that create more than one object, this method returns the objects that are created by commit.
NXOpen::NXObject *	GetObject ()
	Returns the object currently being edited by this builder.
void	ShowResults ()
	Updates the model to reflect the result of an edit to the model for all builders that support showing results.
virtual bool	Validate ()
	Validate whether the inputs to the component are sufficient for commit to be called.
Public Member Functions inherited from NXOpen::TaggedObject
tag_t	GetTag () const
	<b>Deprecated</b>:<br>    Use Tag instead.
tag_t	Tag () const
	Returns the tag of this object.

Detailed Description

Represents a Optimization::OptimizationBuilder
To create a new instance of this class, use Optimization::OptimizationCollection::CreateOptimizationBuilder

Created in NX6.0.0.

Member Enumeration Documentation

enum NXOpen::Optimization::OptimizationBuilder::OptimizationAlgorithmType

Algorithm type.

Enumerator:

OptimizationAlgorithmTypeSimulatedAnnealing	Simulated annealing.
OptimizationAlgorithmTypeGlobalSimplex	Global simplex.
OptimizationAlgorithmTypePowell	Powell.
OptimizationAlgorithmTypeConjugateGradient	Conjugate gradient.
OptimizationAlgorithmTypeLexicographic	Lexicographic.
OptimizationAlgorithmTypePatternSwarm	Pattern swarm.

enum NXOpen::Optimization::OptimizationBuilder::OptimizationAttributeType

Attribute type.

Enumerator:

OptimizationAttributeTypeExpression	Expression attribute.
OptimizationAttributeTypeKFAttribute	KF attribute.
OptimizationAttributeTypeGeometryParameter	Geometry/feature parameter attribute.

enum NXOpen::Optimization::OptimizationBuilder::OptimizationConstraintLimitType

Constraint limit type.

Enumerator:

OptimizationConstraintLimitTypeUpper	Upper limit.
OptimizationConstraintLimitTypeLower	Lower limit.

enum NXOpen::Optimization::OptimizationBuilder::OptimizationConvergenceSpeedType

Convergence speed type.

Enumerator:

OptimizationConvergenceSpeedTypeSlow	Slow convergence speed.
OptimizationConvergenceSpeedTypeMedium	Medium convergence speed.
OptimizationConvergenceSpeedTypeFast	Fast convergence speed.
OptimizationConvergenceSpeedTypeInfinite	Infinite convergence speed.

enum NXOpen::Optimization::OptimizationBuilder::OptimizationTargetType

Optimization type for objective.

Enumerator:

OptimizationTargetTypeMinimum	Target is minimum value of design objective.
OptimizationTargetTypeMaximum	Target is maximum value of design objective.
OptimizationTargetTypeTarget	Target is specified value of design objective.

Member Function Documentation

double NXOpen::Optimization::OptimizationBuilder::AbsoluteConvergenceCriteria

(

)

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
Created in NX6.0.0.

License requirements : None

NXOpen::Optimization::OptimizationBuilder::OptimizationAlgorithmType NXOpen::Optimization::OptimizationBuilder::AlgorithmType

(

)

Returns the algorithm type
Created in NX6.0.0.

License requirements : None

void NXOpen::Optimization::OptimizationBuilder::BuildAllConstraints

(

)

Build all the constraints
Created in NX6.0.0.

License requirements : None

void NXOpen::Optimization::OptimizationBuilder::BuildAllObjectives

(

)

Build all the objectives
Created in NX6.0.0.

License requirements : None

void NXOpen::Optimization::OptimizationBuilder::BuildAllVariables

(

)

Build all the variables
Created in NX6.0.0.

License requirements : None

NXOpen::Optimization::OptimizationBuilder::OptimizationConvergenceSpeedType NXOpen::Optimization::OptimizationBuilder::ConvergenceSpeedType

(

)

Returns the convergence speed type
Created in NX6.0.0.

License requirements : None

std::vector<NXOpen::Optimization::OptimizationBuilder::OptimizationConstraint> NXOpen::Optimization::OptimizationBuilder::GetOptimizationConstraints

(

)

Returns the constraints.

Returns

Constraints
Created in NX6.0.0.

License requirements : None

std::vector<NXOpen::Optimization::OptimizationBuilder::OptimizationObjective> NXOpen::Optimization::OptimizationBuilder::GetOptimizationObjectives

(

)

Returns the objectives.

Returns

Objectives
Created in NX6.0.0.

License requirements : None

std::vector<NXOpen::Optimization::OptimizationBuilder::OptimizationVariable> NXOpen::Optimization::OptimizationBuilder::GetOptimizationVariables

(

)

Returns the variables.

Returns

Variables
Created in NX6.0.0.

License requirements : None

bool NXOpen::Optimization::OptimizationBuilder::IsShowGraph

(

)

Returns the property - is show graph
Created in NX6.0.0.

License requirements : None

bool NXOpen::Optimization::OptimizationBuilder::IsUpdateDisp

(

)

Returns the property - is update display
Created in NX6.0.0.

License requirements : None

int NXOpen::Optimization::OptimizationBuilder::MaxNumberIteration

(

)

Returns the maximum number of updates allowed without converging to a solutionthe maximum iterations time
Created in NX6.0.0.

License requirements : None

int NXOpen::Optimization::OptimizationBuilder::MaxTime

(

)

Returns the maximum time allowed for this run in seconds
Created in NX6.0.0.

License requirements : None

NXOpen::Optimization::OptimizationBuilder::OptimizationTargetType NXOpen::Optimization::OptimizationBuilder::OptimizationType

(

)

Returns the optimization type
Created in NX6.0.0.

License requirements : None

double NXOpen::Optimization::OptimizationBuilder::RelativeConvergenceCriteria

(

)

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
Created in NX6.0.0.

License requirements : None

void NXOpen::Optimization::OptimizationBuilder::RemoveAllConstraints

(

)

Remove all the constraints
Created in NX6.0.0.

License requirements : None

void NXOpen::Optimization::OptimizationBuilder::RemoveAllObjectives

(

)

Remove all the objectives
Created in NX6.0.0.

License requirements : None

void NXOpen::Optimization::OptimizationBuilder::RemoveAllVariables

(

)

Remove all the variables
Created in NX6.0.0.

License requirements : None

void NXOpen::Optimization::OptimizationBuilder::RunOptimization

(

)

Run optimization process
Created in NX6.0.0.

License requirements : None

void NXOpen::Optimization::OptimizationBuilder::SetAbsoluteConvergenceCriteria

(

double

absoluteConvergenceCriteria

)

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
Created in NX6.0.0.

License requirements : None

Parameters

absoluteConvergenceCriteria

absoluteconvergencecriteria

void NXOpen::Optimization::OptimizationBuilder::SetAlgorithmType

(

NXOpen::Optimization::OptimizationBuilder::OptimizationAlgorithmType

algorithmType

)

Sets the algorithm type
Created in NX6.0.0.

License requirements : None

Parameters

algorithmType

algorithmtype

void NXOpen::Optimization::OptimizationBuilder::SetConvergenceSpeedType

(

NXOpen::Optimization::OptimizationBuilder::OptimizationConvergenceSpeedType

convergenceSpeedType

)

Sets the convergence speed type
Created in NX6.0.0.

License requirements : None

Parameters

convergenceSpeedType

convergencespeedtype

void NXOpen::Optimization::OptimizationBuilder::SetMaxNumberIteration

(

int

maxNumberIteration

)

Sets the maximum number of updates allowed without converging to a solutionthe maximum iterations time
Created in NX6.0.0.

License requirements : None

Parameters

maxNumberIteration

maxnumberiteration

void NXOpen::Optimization::OptimizationBuilder::SetMaxTime

(

int

maxTime

)

Sets the maximum time allowed for this run in seconds
Created in NX6.0.0.

License requirements : None

Parameters

maxTime

maxtime

void NXOpen::Optimization::OptimizationBuilder::SetOptimizationConstraints	(	std::vector< NXString > &	attributeNames,
		const std::vector< NXOpen::NXObject * > &	attributeObjects,
		const std::vector< NXOpen::Optimization::OptimizationBuilder::OptimizationAttributeType > &	constraintTypes,
		const std::vector< double > &	constraintLowerLimitValue,
		const std::vector< double > &	constraintUpperLimitValue,
		const std::vector< NXOpen::Optimization::OptimizationBuilder::OptimizationConstraintLimitType > &	constraintLimitType
	)

Sets the constraints
Created in NX6.0.0.

License requirements : None

Parameters

attributeNames	Constraint attribute name array NOTE: The full Unicode character set is not supported for this parameter.
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

void NXOpen::Optimization::OptimizationBuilder::SetOptimizationObjectives	(	std::vector< NXString > &	attributeNames,
		const std::vector< NXOpen::NXObject * > &	attributeObjects,
		const std::vector< NXOpen::Optimization::OptimizationBuilder::OptimizationAttributeType > &	objectiveTypes,
		const std::vector< double > &	objectiveTargetValues
	)

Sets the objectives
Created in NX6.0.0.

License requirements : None

Parameters

attributeNames	Objective attribute name array NOTE: The full Unicode character set is not supported for this parameter.
attributeObjects	Objective attribute object array
objectiveTypes	Objective attribute type array
objectiveTargetValues	Objective target value array

void NXOpen::Optimization::OptimizationBuilder::SetOptimizationType

(

NXOpen::Optimization::OptimizationBuilder::OptimizationTargetType

optimizationType

)

Sets the optimization type
Created in NX6.0.0.

License requirements : None

Parameters

optimizationType

optimizationtype

void NXOpen::Optimization::OptimizationBuilder::SetOptimizationVariables	(	std::vector< NXString > &	attributeNames,
		const std::vector< NXOpen::NXObject * > &	attributeObjects,
		const std::vector< NXOpen::Optimization::OptimizationBuilder::OptimizationAttributeType > &	variableTypes,
		const std::vector< double > &	variableLowerLimitValue,
		const std::vector< double > &	variableUpperLimitValue
	)

Sets the variables
Created in NX6.0.0.

License requirements : None

Parameters

attributeNames	Variable attribute name array NOTE: The full Unicode character set is not supported for this parameter.
attributeObjects	Variable attribute object array
variableTypes	Variable attribute type array
variableLowerLimitValue	Variable lower limit value array
variableUpperLimitValue	Variable upper limit value array

void NXOpen::Optimization::OptimizationBuilder::SetRelativeConvergenceCriteria

(

double

relativeConvergenceCriteria

)

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
Created in NX6.0.0.

License requirements : None

Parameters

relativeConvergenceCriteria

relativeconvergencecriteria

void NXOpen::Optimization::OptimizationBuilder::SetShowGraph

(

bool

isShowGraph

)

Sets the property - is show graph
Created in NX6.0.0.

License requirements : None

Parameters

isShowGraph

isshowgraph

void NXOpen::Optimization::OptimizationBuilder::SetStudyName

(

const NXString &

studyName

)

Sets the study name which is unique in one part
Created in NX6.0.0.

License requirements : None

Parameters

studyName

studyname

void NXOpen::Optimization::OptimizationBuilder::SetStudyName

(

const char *

studyName

)

Sets the study name which is unique in one part
Created in NX6.0.0.

License requirements : None

Parameters

studyName

studyname

void NXOpen::Optimization::OptimizationBuilder::SetUpdateDisp

(

bool

isUpdateDisp

)

Sets the property - is update display
Created in NX6.0.0.

License requirements : None

Parameters

isUpdateDisp

isupdatedisp

NXString NXOpen::Optimization::OptimizationBuilder::StudyName

(

)

Returns the study name which is unique in one part
Created in NX6.0.0.

License requirements : None

---

The documentation for this class was generated from the following file:

• Optimization_OptimizationBuilder.hxx