ExamineGeometry Class¶
-
class
NXOpen.GeometricAnalysis.
ExamineGeometry
¶ Bases:
NXOpen.Builder
Represents the Examine Geometry class
To create a new instance of this class, use
NXOpen.GeometricAnalysis.AnalysisManager.CreateExamineGeometryObject()
New in version NX5.0.0.
Properties¶
Property | Description |
---|---|
CheckCriteriaAngle | Returns or sets the Check Criteria Angle |
CheckCriteriaDistance | Returns or sets the Check Criteria Distance |
ObjectsToExamine | Returns the Objects to examine |
Tag | Returns the Tag for this object. |
Methods¶
Method | Description |
---|---|
ClearAllChecks | Clear or unset all types of checks |
ClearCheck | Clear or unset a specified type of check |
Commit | Commits any edits that have been applied to the builder. |
Destroy | Deletes the builder, and cleans up any objects created by the builder. |
DisplayResultsAsInfo | Displays the results in the information window |
Examine | Examines the geometry. |
GetCommittedObjects | For builders that create more than one object, this method returns the objects that are created by commit. |
GetFailedObjects | Returns the objects that failed a given type of check. |
GetObject | Returns the object currently being edited by this builder. |
GetResults | Returns an array containing the number of objects that failed each check. |
HighlightResult | Highlights results of a specified type of check. |
SetAllChecks | Set all types of checks to examine |
SetCheck | Set a specified type of check for examine geometry |
ShowResults | Updates the model to reflect the result of an edit to the model for all builders that support showing results. |
UnhighlightAllResults | Unhighlight all results |
UnhighlightResult | Unhighlight results of a specified type of check |
Validate | Validate whether the inputs to the component are sufficient for commit to be called. |
Enumerations¶
ExamineGeometryCheck Enumeration | Types of checks |
Property Detail¶
CheckCriteriaAngle¶
-
ExamineGeometry.
CheckCriteriaAngle
¶ Returns or sets the Check Criteria Angle
-------------------------------------
Getter Method
Signature
CheckCriteriaAngle
Returns: Return type: float New in version NX5.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
CheckCriteriaAngle
Parameters: angle (float) – New in version NX5.0.0.
License requirements: None.
CheckCriteriaDistance¶
-
ExamineGeometry.
CheckCriteriaDistance
¶ Returns or sets the Check Criteria Distance
-------------------------------------
Getter Method
Signature
CheckCriteriaDistance
Returns: Return type: float New in version NX5.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
CheckCriteriaDistance
Parameters: distance (float) – New in version NX5.0.0.
License requirements: None.
ObjectsToExamine¶
-
ExamineGeometry.
ObjectsToExamine
¶ Returns the Objects to examine
-------------------------------------
Getter Method
Signature
ObjectsToExamine
Returns: Return type: NXOpen.SelectObjectList
New in version NX5.0.0.
License requirements: None.
Method Detail¶
ClearAllChecks¶
-
ExamineGeometry.
ClearAllChecks
¶ Clear or unset all types of checks
Signature
ClearAllChecks()
New in version NX5.0.0.
License requirements: None.
ClearCheck¶
-
ExamineGeometry.
ClearCheck
¶ Clear or unset a specified type of check
Signature
ClearCheck(check)
Parameters: check ( NXOpen.GeometricAnalysis.ExamineGeometryCheck
) – Type of CheckNew in version NX5.0.0.
License requirements: None.
DisplayResultsAsInfo¶
-
ExamineGeometry.
DisplayResultsAsInfo
¶ Displays the results in the information window
Signature
DisplayResultsAsInfo()
New in version NX5.0.0.
License requirements: None.
Examine¶
-
ExamineGeometry.
Examine
¶ Examines the geometry.
Before calling this method, use
NXOpen.GeometricAnalysis.ExamineGeometry.SetCheck()
andNXOpen.GeometricAnalysis.ExamineGeometry.ClearCheck()
to specify which checks to perform and useNXOpen.GeometricAnalysis.ExamineGeometry.ObjectsToExamine()
to specify which objects to examine. After calling this method, useNXOpen.GeometricAnalysis.ExamineGeometry.GetResults()
andNXOpen.GeometricAnalysis.ExamineGeometry.GetFailedObjects()
to get the results.Signature
Examine()
New in version NX5.0.0.
License requirements: None.
GetFailedObjects¶
-
ExamineGeometry.
GetFailedObjects
¶ Returns the objects that failed a given type of check.
You should call
NXOpen.GeometricAnalysis.ExamineGeometry.Examine()
before calling this method.Signature
GetFailedObjects(check)
Parameters: check ( NXOpen.GeometricAnalysis.ExamineGeometryCheck
) – Type of CheckReturns: Objects that failed above check during Examine Geometry :rtype: list of
NXOpen.NXObject
New in version NX5.0.0.
License requirements: None.
GetResults¶
-
ExamineGeometry.
GetResults
¶ Returns an array containing the number of objects that failed each check.
You should call
NXOpen.GeometricAnalysis.ExamineGeometry.Examine()
before calling this method. The array contains an entry for each check in theNXOpen.GeometricAnalysis.ExamineGeometryCheck
enumeration. The nth item in the array corresponds to the nth check in theNXOpen.GeometricAnalysis.ExamineGeometryCheck
enumeration. For example, the first item in the array is the number of objects that failed theGeometricAnalysis.ExamineGeometryCheck.ObjectTiny
check. The corresponding entry in the array will be as follows:- **-1</b> errors
- **0</b> Check not performed as check is not selected
- **-2</b> a type of
NXOpen.GeometricAnalysis.ExamineGeometryCheck
is selected, no objects relevant to that type
of
NXOpen.GeometricAnalysis.ExamineGeometryCheck
are selected. For example, no bodies are selected yet theGeometricAnalysis.ExamineGeometryCheck.BodyDataStructures
check is set or selected.- **-3</b>
NXOpen.GeometricAnalysis.ExamineGeometryCheck
not performed as other relevantNXOpen.GeometricAnalysis.ExamineGeometryCheck
failed. This occurs when
GeometricAnalysis.ExamineGeometryCheck.BodyConsistency
and/orGeometricAnalysis.ExamineGeometryCheck.BodyFaceIntersections
check is set along withGeometricAnalysis.ExamineGeometryCheck.BodyDataStructures
check. IfGeometricAnalysis.ExamineGeometryCheck.BodyDataStructures
check failed,GeometricAnalysis.ExamineGeometryCheck.BodyConsistency
and/orGeometricAnalysis.ExamineGeometryCheck.BodyFaceIntersections
will not be performed.Signature
GetResults()
Returns: Results of Examine Geometry Return type: list of int New in version NX5.0.0.
License requirements: None.
HighlightResult¶
-
ExamineGeometry.
HighlightResult
¶ Highlights results of a specified type of check.
If the highlighting fails for some of the entities, it returns True, otherwise False. Highlighting can fail when the entities are corrupt or missing the information needed to display properly. Remaining entities are highlighted when highlighting fails for some entities.
Signature
HighlightResult(check)
Parameters: check ( NXOpen.GeometricAnalysis.ExamineGeometryCheck
) – Type of CheckReturns: Return status of the method. If return values equals false, display was successful. if return value is true, display of some objects failed. :rtype: bool
New in version NX5.0.0.
License requirements: None.
SetAllChecks¶
-
ExamineGeometry.
SetAllChecks
¶ Set all types of checks to examine
Signature
SetAllChecks()
New in version NX5.0.0.
License requirements: None.
SetCheck¶
-
ExamineGeometry.
SetCheck
¶ Set a specified type of check for examine geometry
Signature
SetCheck(check)
Parameters: check ( NXOpen.GeometricAnalysis.ExamineGeometryCheck
) – Type of CheckNew in version NX5.0.0.
License requirements: None.
UnhighlightAllResults¶
-
ExamineGeometry.
UnhighlightAllResults
¶ Unhighlight all results
Signature
UnhighlightAllResults()
New in version NX5.0.0.
License requirements: None.
UnhighlightResult¶
-
ExamineGeometry.
UnhighlightResult
¶ Unhighlight results of a specified type of check
Signature
UnhighlightResult(check)
Parameters: check ( NXOpen.GeometricAnalysis.ExamineGeometryCheck
) – Type of CheckNew in version NX5.0.0.
License requirements: None.
Validate¶
-
ExamineGeometry.
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.