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

Represents the output result control options of the optimization
Created in NX8.0.0. More...

Inheritance diagram for NXOpen::CAE::Optimization::TBSOutputControlOptions:
NXOpen::TaggedObject

Public Types

enum  Op2Option { Op2OptionNone, Op2OptionFirstLast, Op2OptionAll }
 Defines the op2 output option. More...
 

Public Member Functions

NXString CustomScratchDirectory ()
 Returns the custom cratch directory for solving
Created in NX8.0.0. More...
 
bool HasCustomScratchDirectory ()
 Returns whether to use a custom cratch directory or not when solving
Created in NX8.0.0. More...
 
bool IsJobRunInForeground ()
 Returns whether to run optimization job in foreground or not when solving
Created in NX8.0.0. More...
 
NXOpen::CAE::Optimization::TBSOutputControlOptions::Op2Option Op2OutputOption ()
 Returns the op2 output control option
Created in NX8.0.0. More...
 
void SetCustomScratchDirectory (const NXString &customScrathDir)
 Sets the custom cratch directory for solving
Created in NX8.0.0. More...
 
void SetCustomScratchDirectory (const char *customScrathDir)
 Sets the custom cratch directory for solving
Created in NX8.0.0. More...
 
void SetHasCustomScratchDirectory (bool hasCustomScrathDir)
 Sets whether to use a custom cratch directory or not when solving
Created in NX8.0.0. More...
 
void SetJobRunInForeground (bool isJobRunInForeground)
 Sets whether to run optimization job in foreground or not when solving
Created in NX8.0.0. More...
 
void SetOp2OutputOption (NXOpen::CAE::Optimization::TBSOutputControlOptions::Op2Option op2Option)
 Sets the op2 output control option
Created in NX8.0.0. More...
 
- Public Member Functions inherited from NXOpen::TaggedObject
tag_t Tag () const
 Returns the tag of this object. More...
 

Detailed Description

Represents the output result control options of the optimization
Created in NX8.0.0.


Member Enumeration Documentation

Defines the op2 output option.

Enumerator
Op2OptionNone 

Donot output op2 result.

Op2OptionFirstLast 

Output op2 results of first and last iteration.

Op2OptionAll 

Output op2 results of all iterations.

Member Function Documentation

NXString NXOpen::CAE::Optimization::TBSOutputControlOptions::CustomScratchDirectory ( )

Returns the custom cratch directory for solving
Created in NX8.0.0.



License requirements : None

bool NXOpen::CAE::Optimization::TBSOutputControlOptions::HasCustomScratchDirectory ( )

Returns whether to use a custom cratch directory or not when solving
Created in NX8.0.0.



License requirements : None

bool NXOpen::CAE::Optimization::TBSOutputControlOptions::IsJobRunInForeground ( )

Returns whether to run optimization job in foreground or not when solving
Created in NX8.0.0.



License requirements : None

NXOpen::CAE::Optimization::TBSOutputControlOptions::Op2Option NXOpen::CAE::Optimization::TBSOutputControlOptions::Op2OutputOption ( )

Returns the op2 output control option
Created in NX8.0.0.



License requirements : None

void NXOpen::CAE::Optimization::TBSOutputControlOptions::SetCustomScratchDirectory ( const NXString customScrathDir)

Sets the custom cratch directory for solving
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
customScrathDircustomscrathdir
void NXOpen::CAE::Optimization::TBSOutputControlOptions::SetCustomScratchDirectory ( const char *  customScrathDir)

Sets the custom cratch directory for solving
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
customScrathDircustomscrathdir
void NXOpen::CAE::Optimization::TBSOutputControlOptions::SetHasCustomScratchDirectory ( bool  hasCustomScrathDir)

Sets whether to use a custom cratch directory or not when solving
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
hasCustomScrathDirhascustomscrathdir
void NXOpen::CAE::Optimization::TBSOutputControlOptions::SetJobRunInForeground ( bool  isJobRunInForeground)

Sets whether to run optimization job in foreground or not when solving
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
isJobRunInForegroundisjobruninforeground
void NXOpen::CAE::Optimization::TBSOutputControlOptions::SetOp2OutputOption ( NXOpen::CAE::Optimization::TBSOutputControlOptions::Op2Option  op2Option)

Sets the op2 output control option
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
op2Optionop2option

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