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

Inheritance diagram for NXOpen::CAE::ModelCheck::ElementQualityCheckBuilder:

Public Types
enum	OutputElements { OutputElementsNone, OutputElementsFailed, OutputElementsWarning, OutputElementsFailedAndWarning }
	indicates how to create output group More...

enum	ReportFormat { ReportFormatNone, ReportFormatFailed, ReportFormatWarning, ReportFormatFailedAndWarning, ReportFormatAll }
	indicates how to generate report More...

Public Member Functions
NXOpen::CAE::ModelCheck::ElementQualityCheckBuilder::ReportFormat	ElementReportFormat ()
	Returns the report style Created in NX8.5.0.

NXOpen::CAE::ModelCheck::ElementQualityCheckBuilder::OutputElements	ElementsOutputOption ()
	Returns the element output options Created in NX8.5.0.

NXOpen::CAE::ModelCheck::ElementQualityCheckResults *	ExecuteCheck ()
	Execute element quality checking for CAE::ModelCheck::ElementQualityCheckBuilder::SelectionList and CAE::ModelCheck::ElementQualityCheckBuilder::SetSelectionList and returns the check results.You could also use Builder::Commit to do the checking.

NXOpen::NXColor *	FailedElementsColor ()
	Returns the display color of failed elements Created in NX8.5.0.

NXOpen::SelectTaggedObjectList *	SelectionList ()
	Returns the selected objects to be checked.

void	SetElementReportFormat (NXOpen::CAE::ModelCheck::ElementQualityCheckBuilder::ReportFormat reportElements)
	Sets the report style Created in NX8.5.0.

void	SetElementsOutputOption (NXOpen::CAE::ModelCheck::ElementQualityCheckBuilder::OutputElements outputElements)
	Sets the element output options Created in NX8.5.0.

void	SetFailedElementsColor (NXOpen::NXColor *color)
	Sets the display color of failed elements Created in NX8.5.0.

void	SetShowFailedElementsLabel (bool showFailedElementsLabel)
	Sets the value indicating whether to show label for those failed elements Created in NX8.5.0.

void	SetWarningElementsColor (NXOpen::NXColor *color)
	Sets the display color of warning elements Created in NX8.5.0.

bool	ShowFailedElementsLabel ()
	Returns the value indicating whether to show label for those failed elements Created in NX8.5.0.

NXOpen::NXColor *	WarningElementsColor ()
	Returns the display color of warning elements Created in NX8.5.0.

Public Member Functions inherited from NXOpen::Builder
NXOpen::NXObject *	Commit ()
	Commits any edits that have been applied to the builder.

void	Destroy ()
	Deletes the builder, and cleans up any objects created by the builder.

std::vector< NXOpen::NXObject * >	GetCommittedObjects ()
	For builders that create more than one object, this method returns the objects that are created by commit.

NXOpen::NXObject *	GetObject ()
	Returns the object currently being edited by this builder.

void	ShowResults ()
	Updates the model to reflect the result of an edit to the model for all builders that support showing results.

virtual bool	Validate ()
	Validate whether the inputs to the component are sufficient for commit to be called.

Public Member Functions inherited from NXOpen::TaggedObject
tag_t	GetTag () const
	<b>Deprecated</b>:<br> Use Tag instead.

tag_t	Tag () const
	Returns the tag of this object.

Detailed Description

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

Set the properties of the 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 CAE::ModelCheck::ElementQualityCheckBuilder::ShowFailedElementsLabel and CAE::ModelCheck::ElementQualityCheckBuilder::SetShowFailedElementsLabel and CAE::ModelCheck::ElementQualityCheckBuilder::FailedElementsColor and CAE::ModelCheck::ElementQualityCheckBuilder::SetFailedElementsColor .

The report will be generated according to CAE::ModelCheck::ElementQualityCheckBuilder::ElementReportFormat and CAE::ModelCheck::ElementQualityCheckBuilder::SetElementReportFormat

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

Created in NX8.5.0.

Member Enumeration Documentation

enum NXOpen::CAE::ModelCheck::ElementQualityCheckBuilder::OutputElements

indicates how to create output group

Enumerator:

OutputElementsNone	Output nothing.
OutputElementsFailed	Creates OUTPUT group with failed elements.
OutputElementsWarning	Creates OUTPUT group with warning elements.
OutputElementsFailedAndWarning	Creates OUTPUT group with both warning and failed elements.

enum NXOpen::CAE::ModelCheck::ElementQualityCheckBuilder::ReportFormat

indicates how to generate report

Enumerator:

ReportFormatNone	Does not generate report.
ReportFormatFailed	Only lists check results for elements with error results in the report.
ReportFormatWarning	Only lists check results for elements with warning results in the report.
ReportFormatFailedAndWarning	Lists check results for elements with both error and warning results in the report.
ReportFormatAll	Lists check results for all elements.

Member Function Documentation

NXOpen::CAE::ModelCheck::ElementQualityCheckBuilder::ReportFormat NXOpen::CAE::ModelCheck::ElementQualityCheckBuilder::ElementReportFormat ( )

Returns the report style
Created in NX8.5.0.

License requirements : None

NXOpen::CAE::ModelCheck::ElementQualityCheckBuilder::OutputElements NXOpen::CAE::ModelCheck::ElementQualityCheckBuilder::ElementsOutputOption ( )

Returns the element output options
Created in NX8.5.0.

License requirements : None

NXOpen::CAE::ModelCheck::ElementQualityCheckResults* NXOpen::CAE::ModelCheck::ElementQualityCheckBuilder::ExecuteCheck ( )

Execute element quality checking for CAE::ModelCheck::ElementQualityCheckBuilder::SelectionList and CAE::ModelCheck::ElementQualityCheckBuilder::SetSelectionList 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

Returns: Created in NX8.5.0.

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

NXOpen::NXColor* NXOpen::CAE::ModelCheck::ElementQualityCheckBuilder::FailedElementsColor ( )

Returns the display color of failed elements
Created in NX8.5.0.

License requirements : None

NXOpen::SelectTaggedObjectList* NXOpen::CAE::ModelCheck::ElementQualityCheckBuilder::SelectionList ( )

Returns the selected objects to be checked.

The objects must be CAE::Mesh or CAE::FEElement
Created in NX8.5.0.

License requirements : None

void NXOpen::CAE::ModelCheck::ElementQualityCheckBuilder::SetElementReportFormat ( NXOpen::CAE::ModelCheck::ElementQualityCheckBuilder::ReportFormat reportElements )

Sets the report style
Created in NX8.5.0.