ElementQualityCheckBuilder Class¶
-
class
NXOpen.CAE.ModelCheck.
ElementQualityCheckBuilder
¶ Bases:
NXOpen.Builder
,NXOpen.CAE.ModelCheck.ISelectionBuilder
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`()
andNXOpen.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()
andNXOpen.CAE.ModelCheck.ElementQualityCheckBuilder.ExecuteCheck()
.Builder.Commit()
performs the check, displays the failed elements and generates the report in a listing window. ButNXOpen.CAE.ModelCheck.ElementQualityCheckBuilder
just performs the check and returns the check resultNXOpen.CAE.ModelCheck.ElementQualityCheckResults
To create a new instance of this class, use
NXOpen.CAE.ModelCheckManager.CreateElementQualityCheckBuilder()
New in version NX8.5.0.
Properties¶
Property | Description |
---|---|
CheckScopeOption | Returns or sets the check scope setting |
ElementReportFormat | Returns or sets the report style |
ElementsOutputOption | Returns or sets the element output options |
FailedElementsColor | Returns or sets the display color of failed elements |
NumberFormat | Returns the number format option |
SelectionList | Returns the selected objects to be checked. |
ShowFailedElementsLabel | Returns or sets the value indicating whether to show label for those failed elements |
Tag | Returns the Tag for this object. |
WarningElementsColor | Returns or sets the display color of warning elements |
Methods¶
Method | Description |
---|---|
Commit | Commits any edits that have been applied to the builder. |
Destroy | Deletes the builder, and cleans up any objects created by the builder. |
ExecuteCheck | Execute element quality checking for NXOpen.CAE.ModelCheck.ElementQualityCheckBuilder.SelectionList() and returns the check results. |
GetCommittedObjects | For builders that create more than one object, this method returns the objects that are created by commit. |
GetObject | Returns the object currently being edited by this builder. |
ShowResults | Updates the model to reflect the result of an edit to the model for all builders that support showing results. |
Validate | Validate whether the inputs to the component are sufficient for commit to be called. |
Enumerations¶
ElementQualityCheckBuilderOutputElements Enumeration | indicates how to create output group |
ElementQualityCheckBuilderReportFormat Enumeration | indicates how to generate report |
Property Detail¶
CheckScopeOption¶
-
ElementQualityCheckBuilder.
CheckScopeOption
¶ Returns or sets the check scope setting
-------------------------------------
Getter Method
Signature
CheckScopeOption
Returns: Return type: NXOpen.CAE.ModelCheck.CheckScope
New in version NX11.0.1.
License requirements: None.
-------------------------------------
Setter Method
Signature
CheckScopeOption
Parameters: scope ( NXOpen.CAE.ModelCheck.CheckScope
) –New in version NX11.0.1.
License requirements: None.
ElementReportFormat¶
-
ElementQualityCheckBuilder.
ElementReportFormat
¶ Returns or sets the report style
-------------------------------------
Getter Method
Signature
ElementReportFormat
Returns: Return type: NXOpen.CAE.ModelCheck.ElementQualityCheckBuilderReportFormat
New in version NX8.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ElementReportFormat
Parameters: reportElements ( NXOpen.CAE.ModelCheck.ElementQualityCheckBuilderReportFormat
) –New in version NX8.5.0.
License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)
ElementsOutputOption¶
-
ElementQualityCheckBuilder.
ElementsOutputOption
¶ Returns or sets the element output options
-------------------------------------
Getter Method
Signature
ElementsOutputOption
Returns: Return type: NXOpen.CAE.ModelCheck.ElementQualityCheckBuilderOutputElements
New in version NX8.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ElementsOutputOption
Parameters: outputElements ( NXOpen.CAE.ModelCheck.ElementQualityCheckBuilderOutputElements
) –New in version NX8.5.0.
License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)
FailedElementsColor¶
-
ElementQualityCheckBuilder.
FailedElementsColor
¶ Returns or sets the display color of failed elements
-------------------------------------
Getter Method
Signature
FailedElementsColor
Returns: Return type: Id New in version NX8.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
FailedElementsColor
Parameters: color (Id) – New in version NX8.5.0.
License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)
NumberFormat¶
-
ElementQualityCheckBuilder.
NumberFormat
¶ Returns the number format option
-------------------------------------
Getter Method
Signature
NumberFormat
Returns: Return type: NXOpen.CAE.NumberFormat
New in version NX11.0.2.
License requirements: None.
SelectionList¶
-
ElementQualityCheckBuilder.
SelectionList
¶ Returns the selected objects to be checked.
The objects must be
NXOpen.CAE.Mesh
orNXOpen.CAE.FEElement
-------------------------------------
Getter Method
Signature
SelectionList
Returns: Return type: NXOpen.SelectTaggedObjectList
New in version NX8.5.0.
License requirements: None.
ShowFailedElementsLabel¶
-
ElementQualityCheckBuilder.
ShowFailedElementsLabel
¶ Returns or sets the value indicating whether to show label for those failed elements
-------------------------------------
Getter Method
Signature
ShowFailedElementsLabel
Returns: Return type: bool New in version NX8.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ShowFailedElementsLabel
Parameters: showFailedElementsLabel (bool) – New in version NX8.5.0.
License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)
WarningElementsColor¶
-
ElementQualityCheckBuilder.
WarningElementsColor
¶ Returns or sets the display color of warning elements
-------------------------------------
Getter Method
Signature
WarningElementsColor
Returns: Return type: Id New in version NX8.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
WarningElementsColor
Parameters: color (Id) – New in version NX8.5.0.
License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)
Method Detail¶
ExecuteCheck¶
-
ElementQualityCheckBuilder.
ExecuteCheck
¶ Execute element quality checking for
NXOpen.CAE.ModelCheck.ElementQualityCheckBuilder.SelectionList()
and returns the check results.You could also use
Builder.Commit()
to do the checking.Builder.Commit()
only executes the checking, displaying failed elements and generating report, but does not return the resultsSignature
ExecuteCheck()
Returns: Return type: NXOpen.CAE.ModelCheck.ElementQualityCheckResults
New in version NX8.5.0.
License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)
Validate¶
-
ElementQualityCheckBuilder.
Validate
¶ Validate whether the inputs to the component are sufficient for commit to be called.
If the component is not in a state to commit then an exception is thrown. For example, if the component requires you to set some property, this method will throw an exception if you haven’t set it. This method throws a not-yet-implemented NXException for some components.
Signature
Validate()
Returns: Was self validation successful Return type: bool New in version NX3.0.1.
License requirements: None.