InspectionPathBuilder Class¶
-
class
NXOpen.CAM.
InspectionPathBuilder
¶ Bases:
NXOpen.CAM.OperationBuilder
Represents the builder for a CMM Inspection path.
To create a new instance of this class, use
NXOpen.CAM.InspectionOperationCollection.CreateInspectionPathBuilder
New in version NX7.0.0.
Properties¶
Property | Description |
---|---|
ChannelName | Returns or sets the channel’s name |
CreateEntryPoint | Returns or sets a flag to indicate if an entry point is required |
CreateExitPoint | Returns or sets a flag to indicate if an exit point is required |
CycleEvent | Returns the cycle event |
CycleTable | Returns the cycle |
Description | Returns or sets the description |
EndOfPath | Returns the end event builder |
EndUdeSet | Returns the end ude set |
FeatureOpName | Returns or sets the inspection feature operation name |
Geometry | Returns the geometry builder |
GougeChecking | Returns or sets the gouge checking flag |
HeightAboveFeature | Returns the height above feature for entry and exit points |
HoleAxisType | Returns or sets the Hole Axis Type |
HoleDepth | Returns the max depth distance builder |
HoleDepthType | Returns or sets the Hole Depth Type |
InspectionMode | Returns or sets the inspection mode setting |
LayoutAndLayer | Returns the Layer and Layout |
MotionOutputBuilder | Returns the motion output builder |
Notes | Returns the notes builder |
NumPoints | Returns the number of points in the path |
OptimizationBasedOn | Returns or sets the optimization based on in operation |
OptimizationDistanceMethod | Returns or sets the optimization distance method in operation |
OptimizationLevel | Returns or sets the optimization level in operation |
OptimizationMethod | Returns or sets the optim method |
PathDisplayOptions | Returns the path display options builder |
PathOpName | Returns or sets the inspection path operation name |
ProjectLastPointToSafePlane | Returns or sets a flag to indicate if last point is created in safe plane |
ProjectStartPointToSafePlane | Returns or sets a flag to indicate if start point is created in safe plane |
ReferenceFeatureAutoName | Returns or sets the automatic reference feature name |
ReferenceFeatureModeBuilder | Returns the reference feature mode builder |
ReferenceFeatureName | Returns or sets the reference feature name |
ReferenceFeatureOffsetDistanceBuilder | Returns the reference feature offset distance builder |
ReferenceFeaturePointCountBuilder | Returns the reference feature point count builder |
ReferenceFeatureZoneRadiusBuilder | Returns the reference feature zone radius builder |
RetractDistance | Returns the Retract Distance builder (inheritable double) |
RetractDistanceOnToolAxisChange | Returns the Retract Distance on Tool Axis Change builder (inheritable double) |
SafeClearance | Returns the safe clearance builder |
SafePlaneXform | Returns or sets the safe plane |
SelectFeature | Returns the selector for the inspection feature |
SelectReferenceFeature | Returns the selector for the reference feature |
SelectToolFlag | Returns or sets the user selected tool |
SequenceOptimization | Returns or sets the path point sequence optimization setting |
StartOfPath | Returns the start event builder |
StartUdeSet | Returns the start ude set |
Tag | Returns the Tag for this object. |
ToolChangeSetting | Returns the tool change builder |
ToolPathSplitParametersBuilder | Returns the tool path split Parameters |
UseEntryAvoidance | Returns or sets a flag to indicate if collision avoidance is required at entry |
UseExitAvoidance | Returns or sets a flag to indicate if collision avoidance is required at exit |
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. |
EditEntryExitPoints | Edit entry or exit point |
EditStartEndPoints | Edit first or last point in safe plane |
FlipApproachDirection | Flips the approach direction vector |
GenerateReferenceFeature | Generate the reference feature @return |
GetApproachDirection | Gets the approach direction vector values @return the approach direction values |
GetCommittedObjects | For builders that create more than one object, this method returns the objects that are created by commit. |
GetHoleAxisValues | Get the Hole Axis values @return the Hole Axis values |
GetObject | Returns the object currently being edited by this builder. |
GetReferenceFeatureModeValue | Get the reference feature mode @return |
GetReferenceFeatureOffsetDistanceValue | Get the reference feature offset distance @return |
GetReferenceFeaturePointCountValue | Get the reference feature point count @return |
GetReferenceFeatureZoneRadiusValue | Get the reference feature zone radius @return |
ReGenerateEntryExit | ReGenerate entry or exit point @return |
ReGenerateInSafePlane | ReGenerate first or last point in safe plane @return |
RemoveReferenceFeature | Remove the reference feature @return |
SetApproachDirection | Sets the approach direction vector values |
SetHoleAxisValues | Set the Hole Axis values |
SetReferenceFeatureModeValue | Set the reference feature mode |
SetReferenceFeatureOffsetDistanceValue | Set the reference feature offset distance |
SetReferenceFeaturePointCountValue | Set the reference feature point count |
SetReferenceFeatureZoneRadiusValue | Set the reference feature zone radius |
ShowResults | Updates the model to reflect the result of an edit to the model for all builders that support showing results. |
UpdateParameters | Update Inspection path based on selected feature. |
UpdatePath | Update path |
UpdateReferenceParameters | Update relative measurement geometry based on selected reference feature. |
UpdateSensors | Update sensor definitions |
Validate | Validate whether the inputs to the component are sufficient for commit to be called. |
Enumerations¶
InspectionPathBuilderEntryExitType Enumeration | the entry/exit flag |
InspectionPathBuilderFirstLastType Enumeration | the first/last flag |
InspectionPathBuilderInspectModeType Enumeration | the inspection mode |
InspectionPathBuilderSequenceType Enumeration | the path point sequence optimization method |
Property Detail¶
CreateEntryPoint¶
-
InspectionPathBuilder.
CreateEntryPoint
¶ Returns or sets a flag to indicate if an entry point is required
-------------------------------------
Getter Method
Signature
CreateEntryPoint()
Returns: Return type: bool New in version NX7.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
CreateEntryPoint(createPoint)
Parameters: createPoint (bool) – New in version NX7.0.0.
License requirements: insp_programming (“INSPECTION PROGRAMMING”)
CreateExitPoint¶
-
InspectionPathBuilder.
CreateExitPoint
¶ Returns or sets a flag to indicate if an exit point is required
-------------------------------------
Getter Method
Signature
CreateExitPoint()
Returns: Return type: bool New in version NX7.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
CreateExitPoint(createPoint)
Parameters: createPoint (bool) – New in version NX7.0.0.
License requirements: insp_programming (“INSPECTION PROGRAMMING”)
FeatureOpName¶
-
InspectionPathBuilder.
FeatureOpName
¶ Returns or sets the inspection feature operation name
-------------------------------------
Getter Method
Signature
FeatureOpName()
Returns: Return type: str New in version NX7.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
FeatureOpName(featureOpName)
Parameters: featureOpName (str) – New in version NX7.0.0.
License requirements: insp_programming (“INSPECTION PROGRAMMING”)
HeightAboveFeature¶
-
InspectionPathBuilder.
HeightAboveFeature
¶ Returns the height above feature for entry and exit points
-------------------------------------
Getter Method
Signature
HeightAboveFeature()
Returns: Return type: NXOpen.CAM.InheritableDoubleBuilder
New in version NX7.0.0.
License requirements: None.
InspectionMode¶
-
InspectionPathBuilder.
InspectionMode
¶ Returns or sets the inspection mode setting
-------------------------------------
Getter Method
Signature
InspectionMode()
Returns: Return type: NXOpen.CAM.InspectionPathBuilderInspectModeType
New in version NX7.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
InspectionMode(inspectMode)
Parameters: inspectMode ( NXOpen.CAM.InspectionPathBuilderInspectModeType
) –New in version NX7.0.0.
License requirements: insp_programming (“INSPECTION PROGRAMMING”)
NumPoints¶
-
InspectionPathBuilder.
NumPoints
¶ Returns the number of points in the path
-------------------------------------
Getter Method
Signature
NumPoints()
Returns: Return type: NXOpen.CAM.InheritableIntBuilder
New in version NX7.0.0.
License requirements: None.
PathOpName¶
-
InspectionPathBuilder.
PathOpName
¶ Returns or sets the inspection path operation name
-------------------------------------
Getter Method
Signature
PathOpName()
Returns: Return type: str New in version NX7.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
PathOpName(pathOpName)
Parameters: pathOpName (str) – New in version NX7.0.0.
License requirements: insp_programming (“INSPECTION PROGRAMMING”)
ProjectLastPointToSafePlane¶
-
InspectionPathBuilder.
ProjectLastPointToSafePlane
¶ Returns or sets a flag to indicate if last point is created in safe plane
-------------------------------------
Getter Method
Signature
ProjectLastPointToSafePlane()
Returns: Return type: bool New in version NX7.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ProjectLastPointToSafePlane(projectPoint)
Parameters: projectPoint (bool) – New in version NX7.0.0.
License requirements: insp_programming (“INSPECTION PROGRAMMING”)
ProjectStartPointToSafePlane¶
-
InspectionPathBuilder.
ProjectStartPointToSafePlane
¶ Returns or sets a flag to indicate if start point is created in safe plane
-------------------------------------
Getter Method
Signature
ProjectStartPointToSafePlane()
Returns: Return type: bool New in version NX7.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ProjectStartPointToSafePlane(projectPoint)
Parameters: projectPoint (bool) – New in version NX7.0.0.
License requirements: insp_programming (“INSPECTION PROGRAMMING”)
ReferenceFeatureAutoName¶
-
InspectionPathBuilder.
ReferenceFeatureAutoName
¶ Returns or sets the automatic reference feature name
-------------------------------------
Getter Method
Signature
ReferenceFeatureAutoName()
Returns: Return type: str New in version NX9.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ReferenceFeatureAutoName(featureName)
Parameters: featureName (str) – New in version NX9.0.0.
License requirements: insp_programming (“INSPECTION PROGRAMMING”)
ReferenceFeatureModeBuilder¶
-
InspectionPathBuilder.
ReferenceFeatureModeBuilder
¶ Returns the reference feature mode builder
-------------------------------------
Getter Method
Signature
ReferenceFeatureModeBuilder()
Returns: Return type: NXOpen.CAM.InspectionReferenceFeatureModeBuilder
New in version NX9.0.2.
License requirements: None.
ReferenceFeatureName¶
-
InspectionPathBuilder.
ReferenceFeatureName
¶ Returns or sets the reference feature name
-------------------------------------
Getter Method
Signature
ReferenceFeatureName()
Returns: Return type: str New in version NX9.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ReferenceFeatureName(featureName)
Parameters: featureName (str) – New in version NX9.0.0.
License requirements: insp_programming (“INSPECTION PROGRAMMING”)
ReferenceFeatureOffsetDistanceBuilder¶
-
InspectionPathBuilder.
ReferenceFeatureOffsetDistanceBuilder
¶ Returns the reference feature offset distance builder
-------------------------------------
Getter Method
Signature
ReferenceFeatureOffsetDistanceBuilder()
Returns: Return type: NXOpen.CAM.InheritableDoubleBuilder
New in version NX9.0.2.
License requirements: None.
ReferenceFeaturePointCountBuilder¶
-
InspectionPathBuilder.
ReferenceFeaturePointCountBuilder
¶ Returns the reference feature point count builder
-------------------------------------
Getter Method
Signature
ReferenceFeaturePointCountBuilder()
Returns: Return type: NXOpen.CAM.InheritableIntBuilder
New in version NX9.0.2.
License requirements: None.
ReferenceFeatureZoneRadiusBuilder¶
-
InspectionPathBuilder.
ReferenceFeatureZoneRadiusBuilder
¶ Returns the reference feature zone radius builder
-------------------------------------
Getter Method
Signature
ReferenceFeatureZoneRadiusBuilder()
Returns: Return type: NXOpen.CAM.InheritableDoubleBuilder
New in version NX9.0.2.
License requirements: None.
SafePlaneXform¶
-
InspectionPathBuilder.
SafePlaneXform
¶ Returns or sets the safe plane
-------------------------------------
Getter Method
Signature
SafePlaneXform()
Returns: Return type: NXOpen.NXObject
New in version NX7.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
SafePlaneXform(planeXform)
Parameters: planeXform ( NXOpen.NXObject
) –New in version NX7.0.0.
License requirements: insp_programming (“INSPECTION PROGRAMMING”)
SelectFeature¶
-
InspectionPathBuilder.
SelectFeature
¶ Returns the selector for the inspection feature
-------------------------------------
Getter Method
Signature
SelectFeature()
Returns: Return type: NXOpen.SelectNXObjectList
New in version NX7.0.0.
License requirements: None.
SelectReferenceFeature¶
-
InspectionPathBuilder.
SelectReferenceFeature
¶ Returns the selector for the reference feature
-------------------------------------
Getter Method
Signature
SelectReferenceFeature()
Returns: Return type: NXOpen.SelectNXObjectList
New in version NX9.0.0.
License requirements: None.
SequenceOptimization¶
-
InspectionPathBuilder.
SequenceOptimization
¶ Returns or sets the path point sequence optimization setting
-------------------------------------
Getter Method
Signature
SequenceOptimization()
Returns: Return type: NXOpen.CAM.InspectionPathBuilderSequenceType
New in version NX7.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
SequenceOptimization(sequenceOpt)
Parameters: sequenceOpt ( NXOpen.CAM.InspectionPathBuilderSequenceType
) –New in version NX7.0.0.
License requirements: insp_programming (“INSPECTION PROGRAMMING”)
UseEntryAvoidance¶
-
InspectionPathBuilder.
UseEntryAvoidance
¶ Returns or sets a flag to indicate if collision avoidance is required at entry
-------------------------------------
Getter Method
Signature
UseEntryAvoidance()
Returns: Return type: bool New in version NX7.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
UseEntryAvoidance(useAvoidance)
Parameters: useAvoidance (bool) – New in version NX7.0.0.
License requirements: insp_programming (“INSPECTION PROGRAMMING”)
UseExitAvoidance¶
-
InspectionPathBuilder.
UseExitAvoidance
¶ Returns or sets a flag to indicate if collision avoidance is required at exit
-------------------------------------
Getter Method
Signature
UseExitAvoidance()
Returns: Return type: bool New in version NX7.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
UseExitAvoidance(useAvoidance)
Parameters: useAvoidance (bool) – New in version NX7.0.0.
License requirements: insp_programming (“INSPECTION PROGRAMMING”)
Method Detail¶
EditEntryExitPoints¶
-
InspectionPathBuilder.
EditEntryExitPoints
¶ Edit entry or exit point
Signature
EditEntryExitPoints(regenerate)
Parameters: regenerate (bool) – New in version NX8.0.0.
License requirements: insp_programming (“INSPECTION PROGRAMMING”)
EditStartEndPoints¶
-
InspectionPathBuilder.
EditStartEndPoints
¶ Edit first or last point in safe plane
Signature
EditStartEndPoints(regenerate)
Parameters: regenerate (bool) – New in version NX8.0.0.
License requirements: insp_programming (“INSPECTION PROGRAMMING”)
FlipApproachDirection¶
-
InspectionPathBuilder.
FlipApproachDirection
¶ Flips the approach direction vector
Signature
FlipApproachDirection()
New in version NX7.0.0.
License requirements: insp_programming (“INSPECTION PROGRAMMING”)
GenerateReferenceFeature¶
-
InspectionPathBuilder.
GenerateReferenceFeature
¶ Generate the reference feature
Signature
GenerateReferenceFeature()
Returns: Return type: int New in version NX9.0.0.
License requirements: insp_programming (“INSPECTION PROGRAMMING”)
GetApproachDirection¶
-
InspectionPathBuilder.
GetApproachDirection
¶ Gets the approach direction vector values
Signature
GetApproachDirection()
Returns: the approach direction values Return type: list of float New in version NX7.0.0.
License requirements: None.
GetReferenceFeatureModeValue¶
-
InspectionPathBuilder.
GetReferenceFeatureModeValue
¶ Get the reference feature mode
Signature
GetReferenceFeatureModeValue()
Returns: Return type: NXOpen.CAM.InspectionMethodBuilderReferenceFeatureModeTypes
New in version NX9.0.0.
License requirements: None.
GetReferenceFeatureOffsetDistanceValue¶
-
InspectionPathBuilder.
GetReferenceFeatureOffsetDistanceValue
¶ Get the reference feature offset distance
Signature
GetReferenceFeatureOffsetDistanceValue()
Returns: Return type: float New in version NX9.0.0.
License requirements: None.
GetReferenceFeaturePointCountValue¶
-
InspectionPathBuilder.
GetReferenceFeaturePointCountValue
¶ Get the reference feature point count
Signature
GetReferenceFeaturePointCountValue()
Returns: Return type: int New in version NX9.0.0.
License requirements: None.
GetReferenceFeatureZoneRadiusValue¶
-
InspectionPathBuilder.
GetReferenceFeatureZoneRadiusValue
¶ Get the reference feature zone radius
Signature
GetReferenceFeatureZoneRadiusValue()
Returns: Return type: float New in version NX9.0.0.
License requirements: None.
ReGenerateEntryExit¶
-
InspectionPathBuilder.
ReGenerateEntryExit
¶ ReGenerate entry or exit point
Signature
ReGenerateEntryExit(entryExit)
Parameters: entryExit ( NXOpen.CAM.InspectionPathBuilderEntryExitType
) – Type of point to recreateReturns: Return type: bool New in version NX7.5.1.
License requirements: insp_programming (“INSPECTION PROGRAMMING”)
ReGenerateInSafePlane¶
-
InspectionPathBuilder.
ReGenerateInSafePlane
¶ ReGenerate first or last point in safe plane
Signature
ReGenerateInSafePlane(firstLast)
Parameters: firstLast ( NXOpen.CAM.InspectionPathBuilderFirstLastType
) – Type of point to recreateReturns: Return type: bool New in version NX7.5.1.
License requirements: insp_programming (“INSPECTION PROGRAMMING”)
RemoveReferenceFeature¶
-
InspectionPathBuilder.
RemoveReferenceFeature
¶ Remove the reference feature
Signature
RemoveReferenceFeature()
Returns: Return type: int New in version NX9.0.0.
License requirements: insp_programming (“INSPECTION PROGRAMMING”)
SetApproachDirection¶
-
InspectionPathBuilder.
SetApproachDirection
¶ Sets the approach direction vector values
Signature
SetApproachDirection(direction)
Parameters: direction (list of float) – the approach direction values New in version NX7.0.0.
License requirements: insp_programming (“INSPECTION PROGRAMMING”)
SetReferenceFeatureModeValue¶
-
InspectionPathBuilder.
SetReferenceFeatureModeValue
¶ Set the reference feature mode
Signature
SetReferenceFeatureModeValue(mode)
Parameters: mode ( NXOpen.CAM.InspectionMethodBuilderReferenceFeatureModeTypes
) –New in version NX9.0.0.
License requirements: insp_programming (“INSPECTION PROGRAMMING”)
SetReferenceFeatureOffsetDistanceValue¶
-
InspectionPathBuilder.
SetReferenceFeatureOffsetDistanceValue
¶ Set the reference feature offset distance
Signature
SetReferenceFeatureOffsetDistanceValue(distance)
Parameters: distance (float) – New in version NX9.0.0.
License requirements: insp_programming (“INSPECTION PROGRAMMING”)
SetReferenceFeaturePointCountValue¶
-
InspectionPathBuilder.
SetReferenceFeaturePointCountValue
¶ Set the reference feature point count
Signature
SetReferenceFeaturePointCountValue(count)
Parameters: count (int) – New in version NX9.0.0.
License requirements: insp_programming (“INSPECTION PROGRAMMING”)
SetReferenceFeatureZoneRadiusValue¶
-
InspectionPathBuilder.
SetReferenceFeatureZoneRadiusValue
¶ Set the reference feature zone radius
Signature
SetReferenceFeatureZoneRadiusValue(radius)
Parameters: radius (float) – New in version NX9.0.0.
License requirements: insp_programming (“INSPECTION PROGRAMMING”)
UpdateParameters¶
-
InspectionPathBuilder.
UpdateParameters
¶ Update Inspection path based on selected feature.
Signature
UpdateParameters()
New in version NX7.5.1.
License requirements: insp_programming (“INSPECTION PROGRAMMING”)
UpdatePath¶
-
InspectionPathBuilder.
UpdatePath
¶ Update path
Signature
UpdatePath()
New in version NX9.0.2.
License requirements: insp_programming (“INSPECTION PROGRAMMING”)
UpdateReferenceParameters¶
-
InspectionPathBuilder.
UpdateReferenceParameters
¶ Update relative measurement geometry based on selected reference feature.
Signature
UpdateReferenceParameters(featOpTag)
Parameters: featOpTag ( NXOpen.NXObject
) –New in version NX9.0.0.
License requirements: insp_programming (“INSPECTION PROGRAMMING”)
UpdateSensors¶
-
InspectionPathBuilder.
UpdateSensors
¶ Update sensor definitions
Signature
UpdateSensors(setup, parentProgramGroup, parentMethodGroup, parentToolGroup, parentGeometryGroup, typeName)
Parameters: - setup (
NXOpen.CAM.InspectionSetup
) – the setup - parentProgramGroup (
NXOpen.CAM.InspectionGroup
) – the parent program group - parentMethodGroup (
NXOpen.CAM.InspectionGroup
) – the parent method group - parentToolGroup (
NXOpen.CAM.InspectionGroup
) – the parent tool group - parentGeometryGroup (
NXOpen.CAM.InspectionGroup
) – the parent geometry group - typeName (str) – the name of the template type NOTE: The full Unicode character set is not supported for this parameter.
New in version NX7.5.1.
License requirements: insp_programming (“INSPECTION PROGRAMMING”)
- setup (
Validate¶
-
InspectionPathBuilder.
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.