Properties¶
| Property | Description |
|---|---|
| ChangeApproachRetract | Returns or sets a flag to indicate whether to change approach and retract distances to avoid collisions |
| ChangeProbeAngles | Returns or sets a flag to indicate whether to change probe angles to avoid collisions |
| ChangeProbeTip | Returns or sets a flag to indicate whether to change probe tip to avoid collisions |
| ClearanceDistance | Returns or sets the transition clearance distance |
| DeleteMeasurementPoints | Returns or sets a flag to indicate whether to delete measurement points to avoid collisions |
| FacetTolerance | Returns or sets the tolerance used for faceting the components |
| FinishAtSafePlane | Returns or sets a flag to indicate whether to finish at safe plane after last path |
| ListOutput | Returns or sets a flag to indicate whether to generate a report |
| MaxAngularIncrement | Returns or sets the max angular increment |
| MaxLengthIncrement | Returns or sets the max length increment |
| MoveMeasurementPoints | Returns or sets a flag to indicate whether to move measurement points to avoid collisions |
| NewSensors | Returns or sets a flag to indicate whether to create new sensors |
| ProbeRotationsAtSafePlane | Returns or sets a flag to indicate whether to do probe rotations at safe plane |
| SafePlane | Returns or sets the safe plane |
| StartFromSafePlane | Returns or sets a flag to indicate whether to start from safe plane before first path |
| TableRotationsAtSafePlane | Returns or sets a flag to indicate whether to do table rotations at safe plane |
| Tag | Returns the Tag for this object. |
| ToolChangesAtSafePlane | Returns or sets a flag to indicate whether to do tool changes at safe plane |
| TransitionsBetweenPaths | Returns or sets a flag to indicate whether to generate transition points between paths |
| TransitionsWithinPaths | Returns or sets a flag to indicate whether to generate transition points within paths |
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. |
| DoCollisionAvoidance | Updates selected paths. |
| 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. |
| GetSelectedOps | Returns the selected operations. |
| SetSelectedOps | Sets the selected operations. |
| ShowResults | Updates the model to reflect the result of an edit to the model for all builders that support showing results. |
| UpdateSimDisplayOptions | Updates the Sim Display Options to match changes made in the Collision Avoidance Dialog |
| Validate | Validate whether the inputs to the component are sufficient for commit to be called. |
Property Detail¶
ChangeApproachRetract¶
-
InspectionCollisionAvoidanceBuilder.ChangeApproachRetract¶ Returns or sets a flag to indicate whether to change approach and retract distances to avoid collisions
-------------------------------------Getter Method
Signature
ChangeApproachRetract()Returns: Return type: bool New in version NX8.0.1.
License requirements: None.
-------------------------------------Setter Method
Signature
ChangeApproachRetract(change)Parameters: change (bool) – New in version NX8.0.1.
License requirements: insp_programming (“INSPECTION PROGRAMMING”)
ChangeProbeAngles¶
-
InspectionCollisionAvoidanceBuilder.ChangeProbeAngles¶ Returns or sets a flag to indicate whether to change probe angles to avoid collisions
-------------------------------------Getter Method
Signature
ChangeProbeAngles()Returns: Return type: bool New in version NX8.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
ChangeProbeAngles(change)Parameters: change (bool) – New in version NX8.0.0.
License requirements: insp_programming (“INSPECTION PROGRAMMING”)
ChangeProbeTip¶
-
InspectionCollisionAvoidanceBuilder.ChangeProbeTip¶ Returns or sets a flag to indicate whether to change probe tip to avoid collisions
-------------------------------------Getter Method
Signature
ChangeProbeTip()Returns: Return type: bool New in version NX8.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
ChangeProbeTip(change)Parameters: change (bool) – New in version NX8.0.0.
License requirements: insp_programming (“INSPECTION PROGRAMMING”)
ClearanceDistance¶
-
InspectionCollisionAvoidanceBuilder.ClearanceDistance¶ Returns or sets the transition clearance distance
-------------------------------------Getter Method
Signature
ClearanceDistance()Returns: Return type: float New in version NX8.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
ClearanceDistance(clearanceDistance)Parameters: clearanceDistance (float) – New in version NX8.0.0.
License requirements: insp_programming (“INSPECTION PROGRAMMING”)
DeleteMeasurementPoints¶
-
InspectionCollisionAvoidanceBuilder.DeleteMeasurementPoints¶ Returns or sets a flag to indicate whether to delete measurement points to avoid collisions
-------------------------------------Getter Method
Signature
DeleteMeasurementPoints()Returns: Return type: bool New in version NX9.0.1.
License requirements: None.
-------------------------------------Setter Method
Signature
DeleteMeasurementPoints(deletePoints)Parameters: deletePoints (bool) – New in version NX9.0.1.
License requirements: insp_programming (“INSPECTION PROGRAMMING”)
FacetTolerance¶
-
InspectionCollisionAvoidanceBuilder.FacetTolerance¶ Returns or sets the tolerance used for faceting the components
-------------------------------------Getter Method
Signature
FacetTolerance()Returns: Return type: float New in version NX8.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
FacetTolerance(facetTolerance)Parameters: facetTolerance (float) – New in version NX8.0.0.
License requirements: insp_programming (“INSPECTION PROGRAMMING”)
FinishAtSafePlane¶
-
InspectionCollisionAvoidanceBuilder.FinishAtSafePlane¶ Returns or sets a flag to indicate whether to finish at safe plane after last path
-------------------------------------Getter Method
Signature
FinishAtSafePlane()Returns: Return type: bool New in version NX8.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
FinishAtSafePlane(createPoints)Parameters: createPoints (bool) – New in version NX8.0.0.
License requirements: insp_programming (“INSPECTION PROGRAMMING”)
ListOutput¶
-
InspectionCollisionAvoidanceBuilder.ListOutput¶ Returns or sets a flag to indicate whether to generate a report
-------------------------------------Getter Method
Signature
ListOutput()Returns: Return type: bool New in version NX8.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
ListOutput(list)Parameters: list (bool) – New in version NX8.0.0.
License requirements: insp_programming (“INSPECTION PROGRAMMING”)
MaxAngularIncrement¶
-
InspectionCollisionAvoidanceBuilder.MaxAngularIncrement¶ Returns or sets the max angular increment
-------------------------------------Getter Method
Signature
MaxAngularIncrement()Returns: Return type: float New in version NX8.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
MaxAngularIncrement(maxAngularIncrement)Parameters: maxAngularIncrement (float) – New in version NX8.0.0.
License requirements: insp_programming (“INSPECTION PROGRAMMING”)
MaxLengthIncrement¶
-
InspectionCollisionAvoidanceBuilder.MaxLengthIncrement¶ Returns or sets the max length increment
-------------------------------------Getter Method
Signature
MaxLengthIncrement()Returns: Return type: float New in version NX8.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
MaxLengthIncrement(maxLengthIncrement)Parameters: maxLengthIncrement (float) – New in version NX8.0.0.
License requirements: insp_programming (“INSPECTION PROGRAMMING”)
MoveMeasurementPoints¶
-
InspectionCollisionAvoidanceBuilder.MoveMeasurementPoints¶ Returns or sets a flag to indicate whether to move measurement points to avoid collisions
-------------------------------------Getter Method
Signature
MoveMeasurementPoints()Returns: Return type: bool New in version NX9.0.1.
License requirements: None.
-------------------------------------Setter Method
Signature
MoveMeasurementPoints(movePoints)Parameters: movePoints (bool) – New in version NX9.0.1.
License requirements: insp_programming (“INSPECTION PROGRAMMING”)
NewSensors¶
-
InspectionCollisionAvoidanceBuilder.NewSensors¶ Returns or sets a flag to indicate whether to create new sensors
-------------------------------------Getter Method
Signature
NewSensors()Returns: Return type: bool New in version NX8.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
NewSensors(newSensors)Parameters: newSensors (bool) – New in version NX8.0.0.
License requirements: insp_programming (“INSPECTION PROGRAMMING”)
ProbeRotationsAtSafePlane¶
-
InspectionCollisionAvoidanceBuilder.ProbeRotationsAtSafePlane¶ Returns or sets a flag to indicate whether to do probe rotations at safe plane
-------------------------------------Getter Method
Signature
ProbeRotationsAtSafePlane()Returns: Return type: bool New in version NX8.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
ProbeRotationsAtSafePlane(useSafePlane)Parameters: useSafePlane (bool) – New in version NX8.0.0.
License requirements: insp_programming (“INSPECTION PROGRAMMING”)
SafePlane¶
-
InspectionCollisionAvoidanceBuilder.SafePlane¶ Returns or sets the safe plane
-------------------------------------Getter Method
Signature
SafePlane()Returns: Return type: NXOpen.NXObjectNew in version NX8.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
SafePlane(plane)Parameters: plane ( NXOpen.NXObject) –New in version NX8.0.0.
License requirements: insp_programming (“INSPECTION PROGRAMMING”)
StartFromSafePlane¶
-
InspectionCollisionAvoidanceBuilder.StartFromSafePlane¶ Returns or sets a flag to indicate whether to start from safe plane before first path
-------------------------------------Getter Method
Signature
StartFromSafePlane()Returns: Return type: bool New in version NX8.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
StartFromSafePlane(createPoints)Parameters: createPoints (bool) – New in version NX8.0.0.
License requirements: insp_programming (“INSPECTION PROGRAMMING”)
TableRotationsAtSafePlane¶
-
InspectionCollisionAvoidanceBuilder.TableRotationsAtSafePlane¶ Returns or sets a flag to indicate whether to do table rotations at safe plane
-------------------------------------Getter Method
Signature
TableRotationsAtSafePlane()Returns: Return type: bool New in version NX8.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
TableRotationsAtSafePlane(useSafePlane)Parameters: useSafePlane (bool) – New in version NX8.0.0.
License requirements: insp_programming (“INSPECTION PROGRAMMING”)
ToolChangesAtSafePlane¶
-
InspectionCollisionAvoidanceBuilder.ToolChangesAtSafePlane¶ Returns or sets a flag to indicate whether to do tool changes at safe plane
-------------------------------------Getter Method
Signature
ToolChangesAtSafePlane()Returns: Return type: bool New in version NX8.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
ToolChangesAtSafePlane(useSafePlane)Parameters: useSafePlane (bool) – New in version NX8.0.0.
License requirements: insp_programming (“INSPECTION PROGRAMMING”)
TransitionsBetweenPaths¶
-
InspectionCollisionAvoidanceBuilder.TransitionsBetweenPaths¶ Returns or sets a flag to indicate whether to generate transition points between paths
-------------------------------------Getter Method
Signature
TransitionsBetweenPaths()Returns: Return type: bool New in version NX8.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
TransitionsBetweenPaths(createPoints)Parameters: createPoints (bool) – New in version NX8.0.0.
License requirements: insp_programming (“INSPECTION PROGRAMMING”)
TransitionsWithinPaths¶
-
InspectionCollisionAvoidanceBuilder.TransitionsWithinPaths¶ Returns or sets a flag to indicate whether to generate transition points within paths
-------------------------------------Getter Method
Signature
TransitionsWithinPaths()Returns: Return type: bool New in version NX8.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
TransitionsWithinPaths(createPoints)Parameters: createPoints (bool) – New in version NX8.0.0.
License requirements: insp_programming (“INSPECTION PROGRAMMING”)
Method Detail¶
GetSelectedOps¶
-
InspectionCollisionAvoidanceBuilder.GetSelectedOps¶ Returns the selected operations.
Signature
GetSelectedOps()Returns: Selected operation names Return type: list of str New in version NX8.0.0.
License requirements: None.
SetSelectedOps¶
-
InspectionCollisionAvoidanceBuilder.SetSelectedOps¶ Sets the selected operations.
Signature
SetSelectedOps(selectedOps)Parameters: selectedOps (list of str) – Selected operation names New in version NX8.0.0.
License requirements: insp_programming (“INSPECTION PROGRAMMING”)
UpdateSimDisplayOptions¶
-
InspectionCollisionAvoidanceBuilder.UpdateSimDisplayOptions¶ Updates the Sim Display Options to match changes made in the Collision Avoidance Dialog
Signature
UpdateSimDisplayOptions()New in version NX9.0.1.
License requirements: insp_programming (“INSPECTION PROGRAMMING”)
Validate¶
-
InspectionCollisionAvoidanceBuilder.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.