NXOpen .NET Reference Guide
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties
Public Types | Public Member Functions | Properties | List of all members
NXOpen.CAE.ModelCheck.ElementQualityCheckBuilder Class Reference

Represents a NXOpen.CAE.ModelCheck.ElementQualityCheckBuilder to perform quality checking on the candidate elements. More...

Inheritance diagram for NXOpen.CAE.ModelCheck.ElementQualityCheckBuilder:
NXOpen.Builder NXOpen.CAE.ModelCheck.ISelectionBuilder NXOpen.TaggedObject NXOpen.GeometricUtilities.IComponentBuilder NXOpen.Utilities.NXRemotableObject IMessageSink

Public Types

enum  OutputElements { None, Failed, Warning, FailedAndWarning }
 indicates how to create output group More...
 
enum  ReportFormat {
  None, Failed, Warning, FailedAndWarning,
  All
}
 indicates how to generate report More...
 

Public Member Functions

unsafe
NXOpen.CAE.ModelCheck.ElementQualityCheckResults 
ExecuteCheck ()
 Returns the results after performing element quality check on the target elements or meshes, and displays the warned and/or failed elements. More...
 
unsafe void WriteResultsToFile (string outputFile, NXOpen.CAE.ModelCheck.ElementQualityCheckResults eqcResults)
 Writes the element quality check results into a text file. More...
 
- Public Member Functions inherited from NXOpen.Builder
unsafe NXOpen.NXObject Commit ()
 Commits any edits that have been applied to the builder. More...
 
unsafe void Destroy ()
 Deletes the builder, and cleans up any objects created by the builder. More...
 
unsafe NXOpen.NXObject[] GetCommittedObjects ()
 For builders that create more than one object, this method returns the objects that are created by commit. More...
 
unsafe NXOpen.NXObject GetObject ()
 Returns the object currently being edited by this builder. More...
 
unsafe void ShowResults ()
 Updates the model to reflect the result of an edit to the model for all builders that support showing results. More...
 
unsafe bool Validate ()
 Validate whether the inputs to the component are sufficient for commit to be called. More...
 
- Public Member Functions inherited from NXOpen.TaggedObject
void PrintTestData (String variableName)
 <exclude> More...
 
void PrintTestData (String variableName, int lineNumber)
 <exclude> More...
 
override string ToString ()
 Returns a String that represents the current Object. More...
 
- Public Member Functions inherited from NXOpen.Utilities.NXRemotableObject
IMessageCtrl AsyncProcessMessage (IMessage msg, IMessageSink replySink)
 Asynchronously processes the given message. More...
 
IMessage SyncProcessMessage (IMessage msg)
 Synchronously processes the given message. More...
 

Properties

unsafe
NXOpen.CAE.ModelCheck.CheckScope 
CheckScopeOption [get, set]
 Returns or sets the check scope setting More...
 
unsafe
NXOpen.CAE.ModelCheck.ElementQualityCheckBuilder.ReportFormat 
ElementReportFormat [get, set]
 Returns or sets the report style More...
 
unsafe
NXOpen.CAE.ModelCheck.ElementQualityCheckBuilder.OutputElements 
ElementsOutputOption [get, set]
 Returns or sets the element output options More...
 
unsafe NXOpen.NXColor FailedElementsColor [get, set]
 Returns or sets the display color of failed elements More...
 
unsafe NXOpen.CAE.NumberFormat NumberFormat [get]
 Returns the number format option More...
 
unsafe
NXOpen.SelectTaggedObjectList 
SelectionList [get]
 Returns the selected objects to be checked. More...
 
unsafe bool ShowFailedElementsLabel [get, set]
 Returns or sets the value indicating whether to show label for those failed elements More...
 
unsafe NXOpen.NXColor WarningElementsColor [get, set]
 Returns or sets the display color of warning elements More...
 
- Properties inherited from NXOpen.CAE.ModelCheck.ISelectionBuilder
NXOpen.CAE.ModelCheck.CheckScope CheckScopeOption [get, set]
 Returns or sets the check scope setting More...
 

Additional Inherited Members

- Protected Member Functions inherited from NXOpen.TaggedObject
new void initialize ()
 <exclude> More...
 

Detailed Description

Represents a NXOpen.CAE.ModelCheck.ElementQualityCheckBuilder to perform quality checking on the candidate elements.

Set the properties of the NXOpen.CAE.ModelCheck.ElementQualitySetting instance for the current solver language in the CAE part to define the specific quality checks to perform.

Those elements with failed quality check results will be displayed according to the display setting NXOpen.CAE.ModelCheck.ElementQualityCheckBuilder.ShowFailedElementsLabel and NXOpen.CAE.ModelCheck.ElementQualityCheckBuilder.FailedElementsColor .

The report will be generated according to NXOpen.CAE.ModelCheck.ElementQualityCheckBuilder.ElementReportFormat

You can do element quality check by Builder.Commit and NXOpen.CAE.ModelCheck.ElementQualityCheckBuilder.ExecuteCheck . Builder.Commit performs the check, displays the failed elements and generates the report in a listing window. But NXOpen.CAE.ModelCheck.ElementQualityCheckBuilder just performs the check and returns the check result NXOpen.CAE.ModelCheck.ElementQualityCheckResults

To create a new instance of this class, use NXOpen.CAE.ModelCheckManager.CreateElementQualityCheckBuilder

Created in NX8.5.0

Member Enumeration Documentation

indicates how to create output group

Enumerator
None 

Output nothing

Failed 

Creates OUTPUT group with failed elements

Warning 

Creates OUTPUT group with warning elements

FailedAndWarning 

Creates OUTPUT group with both warning and failed elements

indicates how to generate report

Enumerator
None 

Does not generate report

Failed 

Only lists check results for elements with error results in the report

Warning 

Only lists check results for elements with warning results in the report

FailedAndWarning 

Lists check results for elements with both error and warning results in the report

All 

Lists check results for all elements

Member Function Documentation

unsafe NXOpen.CAE.ModelCheck.ElementQualityCheckResults NXOpen.CAE.ModelCheck.ElementQualityCheckBuilder.ExecuteCheck ( )
inline

Returns the results after performing element quality check on the target elements or meshes, and displays the warned and/or failed elements.

  1. The target elements or meshes are set by calling NXOpen.CAE.ModelCheck.ElementQualityCheckBuilder.SelectionList
  2. You could also use Builder.Commit to do the check, the differences are that Builder.Commit generates the report to listing window but does not return the results.

Created in NX8.5.0

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

Returns
unsafe void NXOpen.CAE.ModelCheck.ElementQualityCheckBuilder.WriteResultsToFile ( string  outputFile,
NXOpen.CAE.ModelCheck.ElementQualityCheckResults  eqcResults 
)
inline

Writes the element quality check results into a text file.

  1. The text file is overriden with the element quality check results if it already exists.
  2. NXOpen.CAE.ModelCheck.ElementQualityCheckResults are generated by calling NXOpen.CAE.ModelCheck.ElementQualityCheckBuilder.ExecuteCheck .
  3. The settings of NXOpen.CAE.NumberFormat can be changed after calling NXOpen.CAE.ModelCheck.ElementQualityCheckBuilder.NumberFormat .
  4. The report format can be changed with NXOpen.CAE.ModelCheck.ElementQualityCheckBuilder.ElementReportFormat .

Created in NX1847.0.0

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

Parameters
outputFile
eqcResults

Property Documentation

unsafe NXOpen.CAE.ModelCheck.CheckScope NXOpen.CAE.ModelCheck.ElementQualityCheckBuilder.CheckScopeOption
getset

Returns or sets the check scope setting

Created in NX11.0.1

License requirements to get this property: None.

License requirements to set this property: None.

unsafe NXOpen.CAE.ModelCheck.ElementQualityCheckBuilder.ReportFormat NXOpen.CAE.ModelCheck.ElementQualityCheckBuilder.ElementReportFormat
getset

Returns or sets the report style

Created in NX8.5.0

License requirements to get this property: None.

License requirements to set this property: nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")

unsafe NXOpen.CAE.ModelCheck.ElementQualityCheckBuilder.OutputElements NXOpen.CAE.ModelCheck.ElementQualityCheckBuilder.ElementsOutputOption
getset

Returns or sets the element output options

Created in NX8.5.0

License requirements to get this property: None.

License requirements to set this property: nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")

unsafe NXOpen.NXColor NXOpen.CAE.ModelCheck.ElementQualityCheckBuilder.FailedElementsColor
getset

Returns or sets the display color of failed elements

Created in NX8.5.0

License requirements to get this property: None.

License requirements to set this property: nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")

unsafe NXOpen.CAE.NumberFormat NXOpen.CAE.ModelCheck.ElementQualityCheckBuilder.NumberFormat
get

Returns the number format option

Created in NX11.0.2

License requirements: None.

unsafe NXOpen.SelectTaggedObjectList NXOpen.CAE.ModelCheck.ElementQualityCheckBuilder.SelectionList
get

Returns the selected objects to be checked.

The objects must be NXOpen.CAE.Mesh or NXOpen.CAE.FEElement

Created in NX8.5.0

License requirements: None.

unsafe bool NXOpen.CAE.ModelCheck.ElementQualityCheckBuilder.ShowFailedElementsLabel
getset

Returns or sets the value indicating whether to show label for those failed elements

Created in NX8.5.0

License requirements to get this property: None.

License requirements to set this property: nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")

unsafe NXOpen.NXColor NXOpen.CAE.ModelCheck.ElementQualityCheckBuilder.WarningElementsColor
getset

Returns or sets the display color of warning elements

Created in NX8.5.0

License requirements to get this property: None.

License requirements to set this property: nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")


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