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

Represents element quality check settings of a specified solver language. More...

Inheritance diagram for NXOpen::CAE::ModelCheck::ElementQualitySetting:
NXOpen::TaggedObject

Public Types

enum  LimitValue { LimitValueWarningAndErrorLimit, LimitValueErrorLimitOnly }
 indicates how criteria value is defined More...
 

Public Member Functions

NXOpen::CAE::ModelCheck::ITestValueGetQualityValue (const NXString &descriptorName)
 Returns the test quality value with the specified descriptor name. More...
 
NXOpen::CAE::ModelCheck::ITestValueGetQualityValue (const char *descriptorName)
 Returns the test quality value with the specified descriptor name. More...
 
NXOpen::CAE::ModelCheck::QualityTestValueGetTestValueByIndex (int index)
 Returns the NXOpen::CAE::ModelCheck::QualityTestValue at the specified index in the setting. More...
 
NXOpen::CAE::ModelCheck::QualityTestValueGetTestValueByType (NXOpen::CAE::ModelCheck::TestValueTypes::TestType testType)
 Returns the NXOpen::CAE::ModelCheck::QualityTestValue of a specified NXOpen::CAE::ModelCheck::TestValueTypes::TestType. More...
 
NXOpen::CAE::ModelCheck::ElementQualitySetting::LimitValue LimitValueOption ()
 Returns the limit value option
Created in NX8.5.0. More...
 
NXString LocateTestDescriptorName (NXOpen::CAE::FEElement *element, NXOpen::CAE::ModelCheck::TestValueTypes::TestType testType, bool useElemSpecific)
 Returns the name of a quality test value, which is associated with an element for a specified test type. More...
 
void ResetToCustomerDefault ()
 Reset the quality check setting as customer default
Created in NX8.5.0. More...
 
void SetLimitValueOption (NXOpen::CAE::ModelCheck::ElementQualitySetting::LimitValue limitValueOption)
 Sets the limit value option
Created in NX8.5.0. More...
 
void SetUseElementSpecificValue (bool useElementSpecificValue)
 Sets an option indicating whether to use element specific quality value for testing
Created in NX8.5.0. More...
 
int TestValueCount ()
 Returns the count of NXOpen::CAE::ModelCheck::QualityTestValue in the setting
Created in NX8.5.0. More...
 
bool UseElementSpecificValue ()
 Returns an option indicating whether to use element specific quality value for testing
Created in NX8.5.0. More...
 
- Public Member Functions inherited from NXOpen::TaggedObject
tag_t Tag () const
 Returns the tag of this object. More...
 

Detailed Description

Represents element quality check settings of a specified solver language.

Each solve language has a NXOpen::CAE::ModelCheck::ElementQualitySetting .

To get a quality check criteria value of a specfied quality test for one element, you can call NXOpen::CAE::ModelCheck::ElementQualitySetting::LocateTestDescriptorName to get the test criteria value name, then call NXOpen::CAE::ModelCheck::ElementQualitySetting::GetQualityValue to get the criteria value object.


Not to support KF

Created in NX8.5.0.

Member Enumeration Documentation

indicates how criteria value is defined

Enumerator
LimitValueWarningAndErrorLimit 

Both warning and error criteria value could be defined.

LimitValueErrorLimitOnly 

Only error criteria value could be defined.

Member Function Documentation

NXOpen::CAE::ModelCheck::ITestValue* NXOpen::CAE::ModelCheck::ElementQualitySetting::GetQualityValue ( const NXString descriptorName)

Returns the test quality value with the specified descriptor name.

Returns

Created in NX8.5.0.

License requirements : None
Parameters
descriptorName
NOTE: The full Unicode character set is not supported for this parameter.
NXOpen::CAE::ModelCheck::ITestValue* NXOpen::CAE::ModelCheck::ElementQualitySetting::GetQualityValue ( const char *  descriptorName)

Returns the test quality value with the specified descriptor name.

Returns

Created in NX8.5.0.

License requirements : None
Parameters
descriptorName
NOTE: The full Unicode character set is not supported for this parameter.
NXOpen::CAE::ModelCheck::QualityTestValue* NXOpen::CAE::ModelCheck::ElementQualitySetting::GetTestValueByIndex ( int  index)

Returns the NXOpen::CAE::ModelCheck::QualityTestValue at the specified index in the setting.

Returns

Created in NX8.5.0.

License requirements : None
Parameters
indexindex
NXOpen::CAE::ModelCheck::QualityTestValue* NXOpen::CAE::ModelCheck::ElementQualitySetting::GetTestValueByType ( NXOpen::CAE::ModelCheck::TestValueTypes::TestType  testType)

Returns the NXOpen::CAE::ModelCheck::QualityTestValue of a specified NXOpen::CAE::ModelCheck::TestValueTypes::TestType.

Returns

Created in NX8.5.0.

License requirements : None
Parameters
testTypetesttype
NXOpen::CAE::ModelCheck::ElementQualitySetting::LimitValue NXOpen::CAE::ModelCheck::ElementQualitySetting::LimitValueOption ( )

Returns the limit value option
Created in NX8.5.0.



License requirements : None

NXString NXOpen::CAE::ModelCheck::ElementQualitySetting::LocateTestDescriptorName ( NXOpen::CAE::FEElement element,
NXOpen::CAE::ModelCheck::TestValueTypes::TestType  testType,
bool  useElemSpecific 
)

Returns the name of a quality test value, which is associated with an element for a specified test type.

Returns

Created in NX8.5.0.

License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")
Parameters
elementelement
testTypetesttype
useElemSpecificuseelemspecific
void NXOpen::CAE::ModelCheck::ElementQualitySetting::ResetToCustomerDefault ( )

Reset the quality check setting as customer default
Created in NX8.5.0.



License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")

void NXOpen::CAE::ModelCheck::ElementQualitySetting::SetLimitValueOption ( NXOpen::CAE::ModelCheck::ElementQualitySetting::LimitValue  limitValueOption)

Sets the limit value option
Created in NX8.5.0.



License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")

Parameters
limitValueOptionlimitvalueoption
void NXOpen::CAE::ModelCheck::ElementQualitySetting::SetUseElementSpecificValue ( bool  useElementSpecificValue)

Sets an option indicating whether to use element specific quality value for testing
Created in NX8.5.0.



License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")

Parameters
useElementSpecificValueuseelementspecificvalue
int NXOpen::CAE::ModelCheck::ElementQualitySetting::TestValueCount ( )

Returns the count of NXOpen::CAE::ModelCheck::QualityTestValue in the setting
Created in NX8.5.0.



License requirements : None

bool NXOpen::CAE::ModelCheck::ElementQualitySetting::UseElementSpecificValue ( )

Returns an option indicating whether to use element specific quality value for testing
Created in NX8.5.0.



License requirements : None


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