ElementQualityCheckBuilder Class¶

class NXOpen.CAE.ModelCheck.ElementQualityCheckBuilder¶

Bases: NXOpen.Builder

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()

New in version NX8.5.0.

Properties¶

Property	Description
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
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¶

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(reportElements)

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(outputElements)

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(color)

Parameters:	color (Id) –

New in version NX8.5.0.

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

SelectionList¶

ElementQualityCheckBuilder.SelectionList¶

Returns the selected objects to be checked.

The objects must be NXOpen.CAE.Mesh or NXOpen.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(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(color)

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 results

Signature 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.