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

Represents a NXOpen::CAE::PreTestExciterConfig builder
To create a new instance of this class, use NXOpen::CAE::PreTestSolutionCollection::CreateExciterConfigBuilder
Default values. More...

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

Public Types

enum  MethodChoiceType { MethodChoiceTypeAutomaticNmif, MethodChoiceTypeManual }
 Selected method for the exciter selection. More...
 
enum  OffAxisAngleChoiceType { OffAxisAngleChoiceTypeNone, OffAxisAngleChoiceTypeAngle45, OffAxisAngleChoiceTypeAngle30 }
 Selected off axis angle for the exciter selection. More...
 

Public Member Functions

double DampingRatio ()
 Returns the damping ratio
Created in NX8.0.0. More...
 
NXOpen::CAE::PreTestExciterConfigBuilder::MethodChoiceType MethodChoice ()
 Returns the exciter selection method
Created in NX8.0.0. More...
 
NXString Name ()
 Returns the name
Created in NX8.0.0. More...
 
double NmifThreshold ()
 Returns the damping ratio
Created in NX8.0.0. More...
 
NXOpen::CAE::PreTestExciterConfigBuilder::OffAxisAngleChoiceType OffAxisAngleChoice ()
 Returns the off axis angle choice
Created in NX8.0.0. More...
 
void SetDampingRatio (double dampingRatio)
 Sets the damping ratio
Created in NX8.0.0. More...
 
void SetMethodChoice (NXOpen::CAE::PreTestExciterConfigBuilder::MethodChoiceType algorithmChoice)
 Sets the exciter selection method
Created in NX8.0.0. More...
 
void SetName (const NXString &title)
 Sets the name
Created in NX8.0.0. More...
 
void SetName (const char *title)
 Sets the name
Created in NX8.0.0. More...
 
void SetNmifThreshold (double nmifThreshold)
 Sets the damping ratio
Created in NX8.0.0. More...
 
void SetOffAxisAngleChoice (NXOpen::CAE::PreTestExciterConfigBuilder::OffAxisAngleChoiceType offAxisAngleChoice)
 Sets the off axis angle choice
Created in NX8.0.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::PreTestExciterConfig builder
To create a new instance of this class, use NXOpen::CAE::PreTestSolutionCollection::CreateExciterConfigBuilder
Default values.

Property Value

DampingRatio

1.0

MethodChoice

AutomaticNmif

NmifThreshold

0.3

OffAxisAngleChoice

None


Created in NX8.0.0.

Member Enumeration Documentation

Selected method for the exciter selection.

Enumerator
MethodChoiceTypeAutomaticNmif 

automatic nmif

MethodChoiceTypeManual 

manual

Selected off axis angle for the exciter selection.

Enumerator
OffAxisAngleChoiceTypeNone 

none

OffAxisAngleChoiceTypeAngle45 

angle45

OffAxisAngleChoiceTypeAngle30 

angle30

Member Function Documentation

double NXOpen::CAE::PreTestExciterConfigBuilder::DampingRatio ( )

Returns the damping ratio
Created in NX8.0.0.



License requirements : None

NXOpen::CAE::PreTestExciterConfigBuilder::MethodChoiceType NXOpen::CAE::PreTestExciterConfigBuilder::MethodChoice ( )

Returns the exciter selection method
Created in NX8.0.0.



License requirements : None

NXString NXOpen::CAE::PreTestExciterConfigBuilder::Name ( )

Returns the name
Created in NX8.0.0.



License requirements : None

double NXOpen::CAE::PreTestExciterConfigBuilder::NmifThreshold ( )

Returns the damping ratio
Created in NX8.0.0.



License requirements : None

NXOpen::CAE::PreTestExciterConfigBuilder::OffAxisAngleChoiceType NXOpen::CAE::PreTestExciterConfigBuilder::OffAxisAngleChoice ( )

Returns the off axis angle choice
Created in NX8.0.0.



License requirements : None

void NXOpen::CAE::PreTestExciterConfigBuilder::SetDampingRatio ( double  dampingRatio)

Sets the damping ratio
Created in NX8.0.0.



License requirements : nx_correl_base ("FE Correlation")

Parameters
dampingRatiodampingratio
void NXOpen::CAE::PreTestExciterConfigBuilder::SetMethodChoice ( NXOpen::CAE::PreTestExciterConfigBuilder::MethodChoiceType  algorithmChoice)

Sets the exciter selection method
Created in NX8.0.0.



License requirements : nx_correl_base ("FE Correlation")

Parameters
algorithmChoicealgorithmchoice
void NXOpen::CAE::PreTestExciterConfigBuilder::SetName ( const NXString title)

Sets the name
Created in NX8.0.0.



License requirements : nx_correl_base ("FE Correlation")

Parameters
titletitle
void NXOpen::CAE::PreTestExciterConfigBuilder::SetName ( const char *  title)

Sets the name
Created in NX8.0.0.



License requirements : nx_correl_base ("FE Correlation")

Parameters
titletitle
void NXOpen::CAE::PreTestExciterConfigBuilder::SetNmifThreshold ( double  nmifThreshold)

Sets the damping ratio
Created in NX8.0.0.



License requirements : nx_correl_base ("FE Correlation")

Parameters
nmifThresholdnmifthreshold
void NXOpen::CAE::PreTestExciterConfigBuilder::SetOffAxisAngleChoice ( NXOpen::CAE::PreTestExciterConfigBuilder::OffAxisAngleChoiceType  offAxisAngleChoice)

Sets the off axis angle choice
Created in NX8.0.0.



License requirements : nx_correl_base ("FE Correlation")

Parameters
offAxisAngleChoiceoffaxisanglechoice

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