InspectionCurveFeatureBuilder Class

class NXOpen.CAM.InspectionCurveFeatureBuilder

Bases: NXOpen.CAM.OperationBuilder

Represents a CMM Inspection Curve Feature builder

To create a new instance of this class, use NXOpen.CAM.InspectionOperationCollection.CreateInspectionCurveFeatureBuilder()

New in version NX7.0.0.

Properties

Property Description
ApproachDirection Returns or sets the approach direction
ChannelName Returns or sets the channel’s name
CurvatureFactor Returns or sets the curvature factor
CycleEvent Returns the cycle event
CycleTable Returns the cycle
Description Returns or sets the description
EndDistance Returns or sets the end distance
EndOfPath Returns the end event builder
EndPercentage Returns or sets the end percentage
EndUdeSet Returns the end ude set
Geometry Returns the geometry builder
GougeChecking Returns or sets the gouge checking flag
HoleAxisType Returns or sets the Hole Axis Type
HoleDepth Returns the max depth distance builder
HoleDepthType Returns or sets the Hole Depth Type
IsPointDefinitionChanged Returns or sets the point data definition changed flag
LayoutAndLayer Returns the Layer and Layout
MaximumSpacing Returns or sets the maximum spacing
MinimumNumberOfPoints Returns or sets the minimum number of points
MinimumSpacing Returns or sets the minimum spacing
MotionOutputBuilder Returns the motion output builder
Name Returns or sets the name
Notes Returns the notes builder
OffsetDistance Returns the offset distance
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
PointDataDefinition Returns or sets the point data definition
PointSelector Returns the user specified point selector
PostToolPathExit Returns or sets the environment variable that points to the post tool path generation library which has the exit
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
SelectToolFlag Returns or sets the user selected tool
SelectedCurves Returns the selected curves
SelectedSurfaces Returns the underlying surfaces selector.
StartDistance Returns or sets the start distance
StartEndMode Returns or sets the start end mode
StartOfPath Returns the start event builder
StartPercentage Returns or sets the start percentage
StartUdeSet Returns the start ude set
Tag Returns the Tag for this object.
ToolChangeSetting Returns the tool change builder
ToolPathEditor Returns the Tool Path Editor Builder
ToolPathSplitParametersBuilder Returns the tool path split Parameters

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.
ErasePointDefinitionDisplay Erases display of point definition data
GetCommittedObjects For builders that create more than one object, this method returns the objects that are created by commit.
GetCustomizableItemBuilder Returns the customizable item builder for the given customizable item name
GetCustomizableItemNames Returns the names for all customizable item ids
GetHoleAxisValues Get the Hole Axis values
GetObject Returns the object currently being edited by this builder.
PreviewPointData Creates preview of point definition data
ReverseFeatureNormal Reverses the feature normal
ReverseOffsetDirection Reverses the offset direction
SetHoleAxisValues Set the Hole Axis values
SetSelectedSurfaces Sets the curve underlying selected surfaces
ShowResults Updates the model to reflect the result of an edit to the model for all builders that support showing results.
UpdateOffset Updates curve inspection feature characteristic parameters based on offset distance
UpdateParams Updates the feature parameters
Validate Validate whether the inputs to the component are sufficient for commit to be called.

Enumerations

InspectionCurveFeatureBuilderPointDataDefinitionType Enumeration The method used to define point data
InspectionCurveFeatureBuilderStartEndModeType Enumeration the method used to define the start and end points

Property Detail

ApproachDirection

InspectionCurveFeatureBuilder.ApproachDirection

Returns or sets the approach direction

-------------------------------------

Getter Method

Signature ApproachDirection

Returns:
Return type:NXOpen.Direction

New in version NX7.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature ApproachDirection

Parameters:approachDirection (NXOpen.Direction) –

New in version NX7.0.0.

License requirements: insp_programming (“INSPECTION PROGRAMMING”)

CurvatureFactor

InspectionCurveFeatureBuilder.CurvatureFactor

Returns or sets the curvature factor

-------------------------------------

Getter Method

Signature CurvatureFactor

Returns:
Return type:float

New in version NX8.5.1.

License requirements: None.

-------------------------------------

Setter Method

Signature CurvatureFactor

Parameters:curvatureFactor (float) –

New in version NX8.5.1.

License requirements: insp_programming (“INSPECTION PROGRAMMING”)

EndDistance

InspectionCurveFeatureBuilder.EndDistance

Returns or sets the end distance

-------------------------------------

Getter Method

Signature EndDistance

Returns:
Return type:float

New in version NX8.5.1.

License requirements: None.

-------------------------------------

Setter Method

Signature EndDistance

Parameters:endDistance (float) –

New in version NX8.5.1.

License requirements: insp_programming (“INSPECTION PROGRAMMING”)

EndPercentage

InspectionCurveFeatureBuilder.EndPercentage

Returns or sets the end percentage

-------------------------------------

Getter Method

Signature EndPercentage

Returns:
Return type:float

New in version NX8.5.1.

License requirements: None.

-------------------------------------

Setter Method

Signature EndPercentage

Parameters:endPercentage (float) –

New in version NX8.5.1.

License requirements: insp_programming (“INSPECTION PROGRAMMING”)

IsPointDefinitionChanged

InspectionCurveFeatureBuilder.IsPointDefinitionChanged

Returns or sets the point data definition changed flag

-------------------------------------

Getter Method

Signature IsPointDefinitionChanged

Returns:
Return type:bool

New in version NX9.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature IsPointDefinitionChanged

Parameters:isChanged (bool) –

New in version NX9.0.0.

License requirements: insp_programming (“INSPECTION PROGRAMMING”)

MaximumSpacing

InspectionCurveFeatureBuilder.MaximumSpacing

Returns or sets the maximum spacing

-------------------------------------

Getter Method

Signature MaximumSpacing

Returns:
Return type:float

New in version NX8.5.1.

License requirements: None.

-------------------------------------

Setter Method

Signature MaximumSpacing

Parameters:maximumSpacing (float) –

New in version NX8.5.1.

License requirements: insp_programming (“INSPECTION PROGRAMMING”)

MinimumNumberOfPoints

InspectionCurveFeatureBuilder.MinimumNumberOfPoints

Returns or sets the minimum number of points

-------------------------------------

Getter Method

Signature MinimumNumberOfPoints

Returns:
Return type:int

New in version NX8.5.1.

License requirements: None.

-------------------------------------

Setter Method

Signature MinimumNumberOfPoints

Parameters:minimumNumberOfPoints (int) –

New in version NX8.5.1.

License requirements: insp_programming (“INSPECTION PROGRAMMING”)

MinimumSpacing

InspectionCurveFeatureBuilder.MinimumSpacing

Returns or sets the minimum spacing

-------------------------------------

Getter Method

Signature MinimumSpacing

Returns:
Return type:float

New in version NX8.5.1.

License requirements: None.

-------------------------------------

Setter Method

Signature MinimumSpacing

Parameters:minimumSpacing (float) –

New in version NX8.5.1.

License requirements: insp_programming (“INSPECTION PROGRAMMING”)

Name

InspectionCurveFeatureBuilder.Name

Returns or sets the name

-------------------------------------

Getter Method

Signature Name

Returns:
Return type:str

New in version NX7.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature Name

Parameters:name (str) –

New in version NX7.0.0.

License requirements: insp_programming (“INSPECTION PROGRAMMING”)

OffsetDistance

InspectionCurveFeatureBuilder.OffsetDistance

Returns the offset distance

-------------------------------------

Getter Method

Signature OffsetDistance

Returns:
Return type:NXOpen.CAM.InheritableDoubleBuilder

New in version NX9.0.0.

License requirements: None.

PointDataDefinition

InspectionCurveFeatureBuilder.PointDataDefinition

Returns or sets the point data definition

-------------------------------------

Getter Method

Signature PointDataDefinition

Returns:
Return type:NXOpen.CAM.InspectionCurveFeatureBuilderPointDataDefinitionType

New in version NX8.5.1.

License requirements: None.

-------------------------------------

Setter Method

Signature PointDataDefinition

Parameters:pointDataDefinition (NXOpen.CAM.InspectionCurveFeatureBuilderPointDataDefinitionType) –

New in version NX8.5.1.

License requirements: insp_programming (“INSPECTION PROGRAMMING”)

PointSelector

InspectionCurveFeatureBuilder.PointSelector

Returns the user specified point selector

-------------------------------------

Getter Method

Signature PointSelector

Returns:
Return type:NXOpen.SelectPointList

New in version NX8.5.1.

License requirements: None.

SelectedCurves

InspectionCurveFeatureBuilder.SelectedCurves

Returns the selected curves

-------------------------------------

Getter Method

Signature SelectedCurves

Returns:
Return type:NXOpen.SelectNXObjectList

New in version NX7.0.0.

License requirements: None.

SelectedSurfaces

InspectionCurveFeatureBuilder.SelectedSurfaces

Returns the underlying surfaces selector.

-------------------------------------

Getter Method

Signature SelectedSurfaces

Returns:
Return type:NXOpen.SelectNXObjectList

New in version NX7.0.0.

License requirements: None.

StartDistance

InspectionCurveFeatureBuilder.StartDistance

Returns or sets the start distance

-------------------------------------

Getter Method

Signature StartDistance

Returns:
Return type:float

New in version NX8.5.1.

License requirements: None.

-------------------------------------

Setter Method

Signature StartDistance

Parameters:startDistance (float) –

New in version NX8.5.1.

License requirements: insp_programming (“INSPECTION PROGRAMMING”)

StartEndMode

InspectionCurveFeatureBuilder.StartEndMode

Returns or sets the start end mode

-------------------------------------

Getter Method

Signature StartEndMode

Returns:
Return type:NXOpen.CAM.InspectionCurveFeatureBuilderStartEndModeType

New in version NX8.5.1.

License requirements: None.

-------------------------------------

Setter Method

Signature StartEndMode

Parameters:startEndMode (NXOpen.CAM.InspectionCurveFeatureBuilderStartEndModeType) –

New in version NX8.5.1.

License requirements: insp_programming (“INSPECTION PROGRAMMING”)

StartPercentage

InspectionCurveFeatureBuilder.StartPercentage

Returns or sets the start percentage

-------------------------------------

Getter Method

Signature StartPercentage

Returns:
Return type:float

New in version NX8.5.1.

License requirements: None.

-------------------------------------

Setter Method

Signature StartPercentage

Parameters:startPercentage (float) –

New in version NX8.5.1.

License requirements: insp_programming (“INSPECTION PROGRAMMING”)

Method Detail

ErasePointDefinitionDisplay

InspectionCurveFeatureBuilder.ErasePointDefinitionDisplay

Erases display of point definition data

Signature ErasePointDefinitionDisplay()

New in version NX9.0.0.

License requirements: insp_programming (“INSPECTION PROGRAMMING”)

PreviewPointData

InspectionCurveFeatureBuilder.PreviewPointData

Creates preview of point definition data

Signature PreviewPointData(showExisting)

Parameters:showExisting (bool) –

New in version NX9.0.0.

License requirements: insp_programming (“INSPECTION PROGRAMMING”)

ReverseFeatureNormal

InspectionCurveFeatureBuilder.ReverseFeatureNormal

Reverses the feature normal

Signature ReverseFeatureNormal()

New in version NX9.0.0.

License requirements: insp_programming (“INSPECTION PROGRAMMING”)

ReverseOffsetDirection

InspectionCurveFeatureBuilder.ReverseOffsetDirection

Reverses the offset direction

Signature ReverseOffsetDirection()

New in version NX9.0.0.

License requirements: insp_programming (“INSPECTION PROGRAMMING”)

SetSelectedSurfaces

InspectionCurveFeatureBuilder.SetSelectedSurfaces

Sets the curve underlying selected surfaces

Signature SetSelectedSurfaces(selectedSurfaces)

Parameters:selectedSurfaces (list of NXOpen.Face) – Array of selected surfaces

New in version NX9.0.0.

License requirements: insp_programming (“INSPECTION PROGRAMMING”)

UpdateOffset

InspectionCurveFeatureBuilder.UpdateOffset

Updates curve inspection feature characteristic parameters based on offset distance

Signature UpdateOffset()

New in version NX9.0.0.

License requirements: insp_programming (“INSPECTION PROGRAMMING”)

UpdateParams

InspectionCurveFeatureBuilder.UpdateParams

Updates the feature parameters

Signature UpdateParams()

New in version NX9.0.0.

License requirements: insp_programming (“INSPECTION PROGRAMMING”)

Validate

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