NX Open C++ Reference Guide
Public Types | Public Member Functions | List of all members
NXOpen::CAE::ModelUpdateOptimOptionsBuilder Class Reference

Represents a NXOpen::CAE::ModelUpdateOptimOptionsBuilder
To create a new instance of this class, use NXOpen::CAE::ModelUpdateSolution::CreateOptimOptionsBuilder

Created in NX7.5.0. More...

Inheritance diagram for NXOpen::CAE::ModelUpdateOptimOptionsBuilder:
NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Types

enum  MethodChoice { MethodChoiceLeastSquares, MethodChoiceSteepestDescent, MethodChoiceGeneticAlgorithm }
 the method of the optimizer More...
 
enum  SteepestDescMethodChoice { SteepestDescMethodChoiceLinear, SteepestDescMethodChoiceFractional }
 the mode of the Steepest Descent method More...
 

Public Member Functions

double DesignVarLinearRange ()
 Returns the design variable linear range
Created in NX7.5.0. More...
 
double DesignVarWeight ()
 Returns the design variable weight
Created in NX7.5.0. More...
 
int GaOptNumGenerations ()
 Returns the genetic algorithm optimizer number of generations
Created in NX7.5.0. More...
 
int GaOptNumGenes ()
 Returns the genetic algorithm optimizer number of genes
Created in NX7.5.0. More...
 
int GaOptNumIndividuals ()
 Returns the genetic algorithm optimizer number of individuals
Created in NX7.5.0. More...
 
bool LeastSqrAutoFilter ()
 Returns the least squares auto filter design variable
Created in NX7.5.0. More...
 
int MaxIterations ()
 Returns the maximum iterations
Created in NX7.5.0. More...
 
NXOpen::CAE::ModelUpdateOptimOptionsBuilder::MethodChoice Method ()
 Returns the method
Created in NX7.5.0. More...
 
double MinImprovement ()
 Returns the minimum improvement
Created in NX7.5.0. More...
 
void Optimize ()
 Do the optimization of model update
Created in NX7.5.0. More...
 
void SetDesignVarLinearRange (double designVarLinearRange)
 Sets the design variable linear range
Created in NX7.5.0. More...
 
void SetDesignVarWeight (double designVarWeight)
 Sets the design variable weight
Created in NX7.5.0. More...
 
void SetGaOptNumGenerations (int gaOptNumGenerations)
 Sets the genetic algorithm optimizer number of generations
Created in NX7.5.0. More...
 
void SetGaOptNumGenes (int gaOptNumGenes)
 Sets the genetic algorithm optimizer number of genes
Created in NX7.5.0. More...
 
void SetGaOptNumIndividuals (int gaOptNumIndividuals)
 Sets the genetic algorithm optimizer number of individuals
Created in NX7.5.0. More...
 
void SetLeastSqrAutoFilter (bool leastSqrAutoFilter)
 Sets the least squares auto filter design variable
Created in NX7.5.0. More...
 
void SetMaxIterations (int maxIterations)
 Sets the maximum iterations
Created in NX7.5.0. More...
 
void SetMethod (NXOpen::CAE::ModelUpdateOptimOptionsBuilder::MethodChoice method)
 Sets the method
Created in NX7.5.0. More...
 
void SetMinImprovement (double minImprovement)
 Sets the minimum improvement
Created in NX7.5.0. More...
 
void SetSteepestDescDVarStep (double steepestDescDVarStep)
 Sets the steepest descent design variable step
Created in NX7.5.0. More...
 
void SetSteepestDescMaxInnerIter (int steepestDescMaxInnerIter)
 Sets the steepest descent max inner iterations
Created in NX7.5.0. More...
 
void SetSteepestDescMethod (NXOpen::CAE::ModelUpdateOptimOptionsBuilder::SteepestDescMethodChoice steepestDescMethod)
 Sets the steepest descent method
Created in NX7.5.0. More...
 
double SteepestDescDVarStep ()
 Returns the steepest descent design variable step
Created in NX7.5.0. More...
 
int SteepestDescMaxInnerIter ()
 Returns the steepest descent max inner iterations
Created in NX7.5.0. More...
 
NXOpen::CAE::ModelUpdateOptimOptionsBuilder::SteepestDescMethodChoice SteepestDescMethod ()
 Returns the steepest descent method
Created in NX7.5.0. More...
 
- Public Member Functions inherited from NXOpen::Builder
NXOpen::NXObjectCommit ()
 Commits any edits that have been applied to the builder. More...
 
void Destroy ()
 Deletes the builder, and cleans up any objects created by the builder. More...
 
std::vector< NXOpen::NXObject * > GetCommittedObjects ()
 For builders that create more than one object, this method returns the objects that are created by commit. More...
 
NXOpen::NXObjectGetObject ()
 Returns the object currently being edited by this builder. More...
 
void ShowResults ()
 Updates the model to reflect the result of an edit to the model for all builders that support showing results. More...
 
virtual bool Validate ()
 Validate whether the inputs to the component are sufficient for commit to be called. More...
 
- Public Member Functions inherited from NXOpen::TaggedObject
tag_t Tag () const
 Returns the tag of this object. More...
 

Detailed Description

Represents a NXOpen::CAE::ModelUpdateOptimOptionsBuilder
To create a new instance of this class, use NXOpen::CAE::ModelUpdateSolution::CreateOptimOptionsBuilder

Created in NX7.5.0.


Member Enumeration Documentation

the method of the optimizer

Enumerator
MethodChoiceLeastSquares 

Least Squares method.

MethodChoiceSteepestDescent 

Steepest Descent method.

MethodChoiceGeneticAlgorithm 

Genetic Algorithm method.

the mode of the Steepest Descent method

Enumerator
SteepestDescMethodChoiceLinear 

Linear mode.

SteepestDescMethodChoiceFractional 

Fractional mode.

Member Function Documentation

double NXOpen::CAE::ModelUpdateOptimOptionsBuilder::DesignVarLinearRange ( )

Returns the design variable linear range
Created in NX7.5.0.



License requirements : None

double NXOpen::CAE::ModelUpdateOptimOptionsBuilder::DesignVarWeight ( )

Returns the design variable weight
Created in NX7.5.0.



License requirements : None

int NXOpen::CAE::ModelUpdateOptimOptionsBuilder::GaOptNumGenerations ( )

Returns the genetic algorithm optimizer number of generations
Created in NX7.5.0.



License requirements : None

int NXOpen::CAE::ModelUpdateOptimOptionsBuilder::GaOptNumGenes ( )

Returns the genetic algorithm optimizer number of genes
Created in NX7.5.0.



License requirements : None

int NXOpen::CAE::ModelUpdateOptimOptionsBuilder::GaOptNumIndividuals ( )

Returns the genetic algorithm optimizer number of individuals
Created in NX7.5.0.



License requirements : None

bool NXOpen::CAE::ModelUpdateOptimOptionsBuilder::LeastSqrAutoFilter ( )

Returns the least squares auto filter design variable
Created in NX7.5.0.



License requirements : None

int NXOpen::CAE::ModelUpdateOptimOptionsBuilder::MaxIterations ( )

Returns the maximum iterations
Created in NX7.5.0.



License requirements : None

NXOpen::CAE::ModelUpdateOptimOptionsBuilder::MethodChoice NXOpen::CAE::ModelUpdateOptimOptionsBuilder::Method ( )

Returns the method
Created in NX7.5.0.



License requirements : None

double NXOpen::CAE::ModelUpdateOptimOptionsBuilder::MinImprovement ( )

Returns the minimum improvement
Created in NX7.5.0.



License requirements : None

void NXOpen::CAE::ModelUpdateOptimOptionsBuilder::Optimize ( )

Do the optimization of model update
Created in NX7.5.0.



License requirements : nx_correl_update ("FE Model Update")

void NXOpen::CAE::ModelUpdateOptimOptionsBuilder::SetDesignVarLinearRange ( double  designVarLinearRange)

Sets the design variable linear range
Created in NX7.5.0.



License requirements : nx_correl_update ("FE Model Update")

Parameters
designVarLinearRangedesignvarlinearrange
void NXOpen::CAE::ModelUpdateOptimOptionsBuilder::SetDesignVarWeight ( double  designVarWeight)

Sets the design variable weight
Created in NX7.5.0.



License requirements : nx_correl_update ("FE Model Update")

Parameters
designVarWeightdesignvarweight
void NXOpen::CAE::ModelUpdateOptimOptionsBuilder::SetGaOptNumGenerations ( int  gaOptNumGenerations)

Sets the genetic algorithm optimizer number of generations
Created in NX7.5.0.



License requirements : nx_correl_update ("FE Model Update")

Parameters
gaOptNumGenerationsgaoptnumgenerations
void NXOpen::CAE::ModelUpdateOptimOptionsBuilder::SetGaOptNumGenes ( int  gaOptNumGenes)

Sets the genetic algorithm optimizer number of genes
Created in NX7.5.0.



License requirements : nx_correl_update ("FE Model Update")

Parameters
gaOptNumGenesgaoptnumgenes
void NXOpen::CAE::ModelUpdateOptimOptionsBuilder::SetGaOptNumIndividuals ( int  gaOptNumIndividuals)

Sets the genetic algorithm optimizer number of individuals
Created in NX7.5.0.



License requirements : nx_correl_update ("FE Model Update")

Parameters
gaOptNumIndividualsgaoptnumindividuals
void NXOpen::CAE::ModelUpdateOptimOptionsBuilder::SetLeastSqrAutoFilter ( bool  leastSqrAutoFilter)

Sets the least squares auto filter design variable
Created in NX7.5.0.



License requirements : nx_correl_update ("FE Model Update")

Parameters
leastSqrAutoFilterleastsqrautofilter
void NXOpen::CAE::ModelUpdateOptimOptionsBuilder::SetMaxIterations ( int  maxIterations)

Sets the maximum iterations
Created in NX7.5.0.



License requirements : nx_correl_update ("FE Model Update")

Parameters
maxIterationsmaxiterations
void NXOpen::CAE::ModelUpdateOptimOptionsBuilder::SetMethod ( NXOpen::CAE::ModelUpdateOptimOptionsBuilder::MethodChoice  method)

Sets the method
Created in NX7.5.0.



License requirements : nx_correl_update ("FE Model Update")

Parameters
methodmethod
void NXOpen::CAE::ModelUpdateOptimOptionsBuilder::SetMinImprovement ( double  minImprovement)

Sets the minimum improvement
Created in NX7.5.0.



License requirements : nx_correl_update ("FE Model Update")

Parameters
minImprovementminimprovement
void NXOpen::CAE::ModelUpdateOptimOptionsBuilder::SetSteepestDescDVarStep ( double  steepestDescDVarStep)

Sets the steepest descent design variable step
Created in NX7.5.0.



License requirements : nx_correl_update ("FE Model Update")

Parameters
steepestDescDVarStepsteepestdescdvarstep
void NXOpen::CAE::ModelUpdateOptimOptionsBuilder::SetSteepestDescMaxInnerIter ( int  steepestDescMaxInnerIter)

Sets the steepest descent max inner iterations
Created in NX7.5.0.



License requirements : nx_correl_update ("FE Model Update")

Parameters
steepestDescMaxInnerItersteepestdescmaxinneriter
void NXOpen::CAE::ModelUpdateOptimOptionsBuilder::SetSteepestDescMethod ( NXOpen::CAE::ModelUpdateOptimOptionsBuilder::SteepestDescMethodChoice  steepestDescMethod)

Sets the steepest descent method
Created in NX7.5.0.



License requirements : nx_correl_update ("FE Model Update")

Parameters
steepestDescMethodsteepestdescmethod
double NXOpen::CAE::ModelUpdateOptimOptionsBuilder::SteepestDescDVarStep ( )

Returns the steepest descent design variable step
Created in NX7.5.0.



License requirements : None

int NXOpen::CAE::ModelUpdateOptimOptionsBuilder::SteepestDescMaxInnerIter ( )

Returns the steepest descent max inner iterations
Created in NX7.5.0.



License requirements : None

NXOpen::CAE::ModelUpdateOptimOptionsBuilder::SteepestDescMethodChoice NXOpen::CAE::ModelUpdateOptimOptionsBuilder::SteepestDescMethod ( )

Returns the steepest descent method
Created in NX7.5.0.



License requirements : None


The documentation for this class was generated from the following file:
Copyright 2017 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.