NX Open C++ Reference Guide
Public Types | Public Member Functions
NXOpen::CAE::Optimization::TBSOptimizationSolution Class Reference

Represents the solution to contain optimization setting
This is an abstract class, and cannot be created. More...

Inheritance diagram for NXOpen::CAE::Optimization::TBSOptimizationSolution:
NXOpen::NXObject NXOpen::TaggedObject NXOpen::INXObject NXOpen::CAE::Optimization::TBSTopologyOptimizationSolution

List of all members.

Public Types

enum  ResultStatus { ResultStatusValid, ResultStatusOutOfDate, ResultStatusInvalid }
 Define the status of optimization result. More...

Public Member Functions

NXOpen::CAE::Optimization::TBSConstraintCollectionConstraints ()
 Represents the response constrain collection belonging to this optimization solution
Created in NX8.0.0.
NXOpen::CAE::Optimization::TBSOptimizationParametersControlParameters ()
 Returns the parameters to control optimization
Created in NX8.0.0.
NXOpen::CAE::Optimization::TBSDesignAreaDesignArea ()
 Returns the design area that will be modified during optimization
Created in NX8.0.0.
NXOpen::CAE::Optimization::TBSDesignVariableCollectionDesignVariables ()
 Represents the design variable collection belonging to this optimization solution
Created in NX8.0.0.
void Destroy (bool deleteResult)
 Deletes an optimization solution and the associated result file optional
Created in NX8.0.0.
NXOpen::TaggedObjectFind (const NXString &journalIdentifier)
 Finds the TaggedObject with the given identifier as recorded in a journal.
int GetIterationNumber ()
 Returns the iteration number during the optimization.
NXOpen::CAE::Optimization::TBSOptimizationSolution::ResultStatus GetPostResult (int iterationID, NXString *postResultName)
 Returns the post result file name and status.
NXOpen::CAE::Optimization::TBSOptimizationSolution::ResultStatus GetSmoothResult (NXOpen::CAE::Optimization::TBSSmooth *smooth, NXString *smoothResultName)
 Returns the result file name and status for a specified smoothing setting.
NXOpen::CAE::Optimization::TBSObjectivesObjectives ()
 Returns the objective function of the optimization
Created in NX8.0.0.
NXOpen::CAE::Optimization::TBSOutputControlOptionsOutputControlOptions ()
 Returns the output control options of the optimization
Created in NX8.0.0.
void Rename (const NXString &name, bool renameResults)
 Rename Solution and optionally rename associated results files
Created in NX8.0.0.
NXOpen::CAE::Optimization::TBSRestrictAreaCollectionRestrictAreas ()
 Represents the restrict area collection belonging to this optimization solution
Created in NX8.0.0.
NXOpen::CAE::Optimization::TBSSmoothCollectionSmoothings ()
 Represents the smooth collection belonging to this optimization solution
Created in NX8.0.0.
void Solve ()
 Solves the optimization solution
Created in NX8.0.0.
NXOpen::CAE::Optimization::TBSStopConditionStopCondition ()
 Returns the stop condition to end the optimization
Created in NX8.0.0.

Detailed Description

Represents the solution to contain optimization setting
This is an abstract class, and cannot be created.



Member Enumeration Documentation

Define the status of optimization result.

Enumerator:
ResultStatusValid 

The result is valid.

ResultStatusOutOfDate 

The result is out-of-date.

ResultStatusInvalid 

The result is invalid.


Member Function Documentation

Represents the response constrain collection belonging to this optimization solution
Created in NX8.0.0.


Returns the parameters to control optimization
Created in NX8.0.0.



License requirements : None

Returns the design area that will be modified during optimization
Created in NX8.0.0.



License requirements : None

Represents the design variable collection belonging to this optimization solution
Created in NX8.0.0.


Deletes an optimization solution and the associated result file optional
Created in NX8.0.0.



License requirements : cae_opt_topo ("NX Topology Optimization") OR cae_opt_topobead ("NX Bead Optimization") OR cae_opt_toposhape ("NX Shape Optimization")

Parameters:
deleteResulttrue if you want associated result files to be deleted as well

Finds the TaggedObject with the given identifier as recorded in a journal.

In general, this method should not be used in handwritten code and exists to support record and playback of journals. An exception will be thrown if no object can be found with the given journal identifier.

Returns:

Created in NX8.0.0.

License requirements : None
Parameters:
journalIdentifierJournal identifier of the object

Returns the iteration number during the optimization.

Returns:

Created in NX8.0.0.

License requirements : None

Returns the post result file name and status.

Returns:

Created in NX8.0.0.

License requirements : None
Parameters:
iterationIDiterationid
postResultNamepostresultname

Returns the result file name and status for a specified smoothing setting.

Returns:

Created in NX8.0.0.

License requirements : None
Parameters:
smoothsmooth
smoothResultNamesmoothresultname

Returns the objective function of the optimization
Created in NX8.0.0.



License requirements : None

Returns the output control options of the optimization
Created in NX8.0.0.



License requirements : None

void NXOpen::CAE::Optimization::TBSOptimizationSolution::Rename ( const NXString name,
bool  renameResults 
)

Rename Solution and optionally rename associated results files
Created in NX8.0.0.



License requirements : None

Parameters:
namenew solution name
NOTE: The full Unicode character set is not supported for this parameter.
renameResultstrue if you what associated results files to be renamed as well

Represents the restrict area collection belonging to this optimization solution
Created in NX8.0.0.


Represents the smooth collection belonging to this optimization solution
Created in NX8.0.0.


Solves the optimization solution
Created in NX8.0.0.



License requirements : cae_opt_topo ("NX Topology Optimization") OR cae_opt_topobead ("NX Bead Optimization") OR cae_opt_toposhape ("NX Shape Optimization")

Returns the stop condition to end the optimization
Created in NX8.0.0.



License requirements : None


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