Represents a NXOpen.Optimization.OptimizationBuilder More...

Inheritance diagram for NXOpen.Optimization.OptimizationBuilder:

Classes
struct	_OptimizationConstraint
	Defined constraint structure

struct	_OptimizationObjective
	Defined Objective Structure

struct	_OptimizationVariable
	Defined variable structure

struct	OptimizationConstraint
	Defined constraint structure More...

struct	OptimizationObjective
	Defined Objective Structure More...

struct	OptimizationVariable
	Defined variable structure More...

Public Types
enum	OptimizationAlgorithmType { SimulatedAnnealing, GlobalSimplex, Powell, ConjugateGradient, Lexicographic, PatternSwarm }
	Algorithm type More...

enum	OptimizationAttributeType { Expression, KFAttribute, GeometryParameter }
	Attribute type More...

enum	OptimizationConstraintLimitType { Upper, Lower }
	Constraint limit type More...

enum	OptimizationConvergenceSpeedType { Slow, Medium, Fast, Infinite }
	Convergence speed type More...

enum	OptimizationTargetType { Minimum, Maximum, Target }
	Optimization type for objective More...

Public Member Functions
unsafe void	BuildAllConstraints ()
	Build all the constraints More...

unsafe void	BuildAllObjectives ()
	Build all the objectives More...

unsafe void	BuildAllVariables ()
	Build all the variables More...

unsafe NXOpen.Optimization.OptimizationBuilder.OptimizationConstraint[]	GetOptimizationConstraints ()
	Returns the constraints More...

unsafe NXOpen.Optimization.OptimizationBuilder.OptimizationObjective[]	GetOptimizationObjectives ()
	Returns the objectives More...

unsafe NXOpen.Optimization.OptimizationBuilder.OptimizationVariable[]	GetOptimizationVariables ()
	Returns the variables More...

unsafe void	RemoveAllConstraints ()
	Remove all the constraints More...

unsafe void	RemoveAllObjectives ()
	Remove all the objectives More...

unsafe void	RemoveAllVariables ()
	Remove all the variables More...

unsafe void	RunOptimization ()
	Run optimization process More...

unsafe void	SetOptimizationConstraints (string[] attributeNames, NXOpen.NXObject[] attributeObjects, NXOpen.Optimization.OptimizationBuilder.OptimizationAttributeType[] constraintTypes, double[] constraintLowerLimitValue, double[] constraintUpperLimitValue, NXOpen.Optimization.OptimizationBuilder.OptimizationConstraintLimitType[] constraintLimitType)
	Sets the constraints More...

unsafe void	SetOptimizationObjectives (string[] attributeNames, NXOpen.NXObject[] attributeObjects, NXOpen.Optimization.OptimizationBuilder.OptimizationAttributeType[] objectiveTypes, double[] objectiveTargetValues)
	Sets the objectives More...

unsafe void	SetOptimizationVariables (string[] attributeNames, NXOpen.NXObject[] attributeObjects, NXOpen.Optimization.OptimizationBuilder.OptimizationAttributeType[] variableTypes, double[] variableLowerLimitValue, double[] variableUpperLimitValue)
	Sets the variables More...

Public Member Functions inherited from NXOpen.Builder
unsafe NXOpen.NXObject	Commit ()
	Commits any edits that have been applied to the builder. More...

unsafe void	Destroy ()
	Deletes the builder, and cleans up any objects created by the builder. More...

unsafe NXOpen.NXObject[]	GetCommittedObjects ()
	For builders that create more than one object, this method returns the objects that are created by commit. More...

unsafe NXOpen.NXObject	GetObject ()
	Returns the object currently being edited by this builder. More...

unsafe void	ShowResults ()
	Updates the model to reflect the result of an edit to the model for all builders that support showing results. More...

unsafe bool	Validate ()
	Validate whether the inputs to the component are sufficient for commit to be called. More...

Public Member Functions inherited from NXOpen.TaggedObject
void	PrintTestData (String variableName)
	<exclude> More...

void	PrintTestData (String variableName, int lineNumber)
	<exclude> More...

override string	ToString ()
	Returns a String that represents the current Object. More...

Public Member Functions inherited from NXOpen.Utilities.NXRemotableObject
IMessageCtrl	AsyncProcessMessage (IMessage msg, IMessageSink replySink)
	Asynchronously processes the given message. More...

IMessage	SyncProcessMessage (IMessage msg)
	Synchronously processes the given message. More...

Properties
unsafe double	AbsoluteConvergenceCriteria `[get, set]`
	Returns or sets the absolute criteria for optimizer to determine convergence. More...

unsafe NXOpen.Optimization.OptimizationBuilder.OptimizationAlgorithmType	AlgorithmType `[get, set]`
	Returns or sets the algorithm type More...

unsafe NXOpen.Optimization.OptimizationBuilder.OptimizationConvergenceSpeedType	ConvergenceSpeedType `[get, set]`
	Returns or sets the convergence speed type More...

unsafe bool	IsShowGraph `[get, set]`
	Returns or sets the property - is show graph More...

unsafe bool	IsUpdateDisp `[get, set]`
	Returns or sets the property - is update display More...

unsafe int	MaxNumberIteration `[get, set]`
	Returns or sets the maximum number of updates allowed without converging to a solutionthe maximum iterations time More...

unsafe int	MaxTime `[get, set]`
	Returns or sets the maximum time allowed for this run in seconds More...

unsafe NXOpen.Optimization.OptimizationBuilder.OptimizationTargetType	OptimizationType `[get, set]`
	Returns or sets the optimization type More...

unsafe double	RelativeConvergenceCriteria `[get, set]`
	Returns or sets the relative criteria for optimizer to determine convergence. More...

unsafe string	StudyName `[get, set]`
	Returns or sets the study name which is unique in one part More...

Properties inherited from NXOpen.Builder
unsafe NXOpen.PreviewBuilder	PreviewBuilder `[get]`
	Returns the preview builder subobject. More...

Properties inherited from NXOpen.TaggedObject
Tag	Tag `[get]`
	Returns the tag of this object. More...

Properties inherited from NXOpen.Utilities.NXRemotableObject
IMessageSink	NextSink `[get]`
	Gets the next message sink in the sink chain. More...

Additional Inherited Members
Protected Member Functions inherited from NXOpen.TaggedObject
new void	initialize ()
	<exclude> More...

Detailed Description

Represents a NXOpen.Optimization.OptimizationBuilder

To create a new instance of this class, use NXOpen.Optimization.OptimizationCollection.CreateOptimizationBuilder

Created in NX6.0.0

Member Enumeration Documentation

enum NXOpen.Optimization.OptimizationBuilder.OptimizationAlgorithmType

Algorithm type

Enumerator
SimulatedAnnealing	Simulated annealing
GlobalSimplex	Global simplex
Powell	Powell
ConjugateGradient	Conjugate gradient
Lexicographic	Lexicographic
PatternSwarm	Pattern swarm

enum NXOpen.Optimization.OptimizationBuilder.OptimizationAttributeType

Attribute type

Enumerator
Expression	Expression attribute
KFAttribute	KF attribute
GeometryParameter	Geometry/feature parameter attribute

enum NXOpen.Optimization.OptimizationBuilder.OptimizationConstraintLimitType

Constraint limit type

Enumerator
Upper	Upper limit
Lower	Lower limit

enum NXOpen.Optimization.OptimizationBuilder.OptimizationConvergenceSpeedType

Convergence speed type

Enumerator
Slow	Slow convergence speed
Medium	Medium convergence speed
Fast	Fast convergence speed
Infinite	Infinite convergence speed

enum NXOpen.Optimization.OptimizationBuilder.OptimizationTargetType

Optimization type for objective

Enumerator
Minimum	Target is minimum value of design objective
Maximum	Target is maximum value of design objective
Target	Target is specified value of design objective

Member Function Documentation

unsafe void NXOpen.Optimization.OptimizationBuilder.BuildAllConstraints ( )

inline

Build all the constraints

Created in NX6.0.0

License requirements: None.

unsafe void NXOpen.Optimization.OptimizationBuilder.BuildAllObjectives ( )

inline

Build all the objectives

Created in NX6.0.0

License requirements: None.

unsafe void NXOpen.Optimization.OptimizationBuilder.BuildAllVariables ( )

inline

Build all the variables

Created in NX6.0.0

License requirements: None.

unsafe NXOpen.Optimization.OptimizationBuilder.OptimizationConstraint [] NXOpen.Optimization.OptimizationBuilder.GetOptimizationConstraints ( )

inline

Returns the constraints

Created in NX6.0.0

License requirements: None.

Returns: Constraints

unsafe NXOpen.Optimization.OptimizationBuilder.OptimizationObjective [] NXOpen.Optimization.OptimizationBuilder.GetOptimizationObjectives ( )

inline

Returns the objectives

Created in NX6.0.0

License requirements: None.

Returns: Objectives

unsafe NXOpen.Optimization.OptimizationBuilder.OptimizationVariable [] NXOpen.Optimization.OptimizationBuilder.GetOptimizationVariables ( )

inline

Returns the variables

Created in NX6.0.0

License requirements: None.

Returns: Variables

unsafe void NXOpen.Optimization.OptimizationBuilder.RemoveAllConstraints ( )

inline

Remove all the constraints

Created in NX6.0.0

License requirements: None.

unsafe void NXOpen.Optimization.OptimizationBuilder.RemoveAllObjectives ( )

inline

Remove all the objectives

Created in NX6.0.0

License requirements: None.

unsafe void NXOpen.Optimization.OptimizationBuilder.RemoveAllVariables ( )

inline

Remove all the variables

Created in NX6.0.0

License requirements: None.

unsafe void NXOpen.Optimization.OptimizationBuilder.RunOptimization ( )

inline

Run optimization process

Created in NX6.0.0

License requirements: None.

unsafe void NXOpen.Optimization.OptimizationBuilder.SetOptimizationConstraints	(	string[]	attributeNames,
		NXOpen.NXObject[]	attributeObjects,
		NXOpen.Optimization.OptimizationBuilder.OptimizationAttributeType[]	constraintTypes,
		double[]	constraintLowerLimitValue,
		double[]	constraintUpperLimitValue,
		NXOpen.Optimization.OptimizationBuilder.OptimizationConstraintLimitType[]	constraintLimitType
	)

inline

Sets the constraints

Created in NX6.0.0

License requirements: None.

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

unsafe void NXOpen.Optimization.OptimizationBuilder.SetOptimizationObjectives	(	string[]	attributeNames,
		NXOpen.NXObject[]	attributeObjects,
		NXOpen.Optimization.OptimizationBuilder.OptimizationAttributeType[]	objectiveTypes,
		double[]	objectiveTargetValues
	)

inline

Sets the objectives

Created in NX6.0.0

License requirements: None.

Parameters

attributeNames	Objective attribute name array
attributeObjects	Objective attribute object array
objectiveTypes	Objective attribute type array
objectiveTargetValues	Objective target value array

unsafe void NXOpen.Optimization.OptimizationBuilder.SetOptimizationVariables	(	string[]	attributeNames,
		NXOpen.NXObject[]	attributeObjects,
		NXOpen.Optimization.OptimizationBuilder.OptimizationAttributeType[]	variableTypes,
		double[]	variableLowerLimitValue,
		double[]	variableUpperLimitValue
	)

inline

Sets the variables

Created in NX6.0.0

License requirements: None.

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

Property Documentation

unsafe double NXOpen.Optimization.OptimizationBuilder.AbsoluteConvergenceCriteria

getset

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

Created in NX6.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe NXOpen.Optimization.OptimizationBuilder.OptimizationAlgorithmType NXOpen.Optimization.OptimizationBuilder.AlgorithmType

getset

Returns or sets the algorithm type

Created in NX6.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe NXOpen.Optimization.OptimizationBuilder.OptimizationConvergenceSpeedType NXOpen.Optimization.OptimizationBuilder.ConvergenceSpeedType

getset

Returns or sets the convergence speed type

Created in NX6.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe bool NXOpen.Optimization.OptimizationBuilder.IsShowGraph

getset

Returns or sets the property - is show graph

Created in NX6.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe bool NXOpen.Optimization.OptimizationBuilder.IsUpdateDisp

getset

Returns or sets the property - is update display

Created in NX6.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe int NXOpen.Optimization.OptimizationBuilder.MaxNumberIteration

getset

Returns or sets the maximum number of updates allowed without converging to a solutionthe maximum iterations time

Created in NX6.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe int NXOpen.Optimization.OptimizationBuilder.MaxTime

getset

Returns or sets the maximum time allowed for this run in seconds

Created in NX6.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe NXOpen.Optimization.OptimizationBuilder.OptimizationTargetType NXOpen.Optimization.OptimizationBuilder.OptimizationType

getset

Returns or sets the optimization type

Created in NX6.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe double NXOpen.Optimization.OptimizationBuilder.RelativeConvergenceCriteria

getset

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

Created in NX6.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe string NXOpen.Optimization.OptimizationBuilder.StudyName

getset

Returns or sets the study name which is unique in one part

Created in NX6.0.0

License requirements to get this property: None.

License requirements to set this property: None.

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

Optimization_OptimizationBuilder.cs

Classes

Public Types

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

Member Function Documentation

Property Documentation