InspectionCparlnFeatureBuilder Class

class NXOpen.CAM.InspectionCparlnFeatureBuilder

Bases: NXOpen.CAM.OperationBuilder

Represents a CMM Inspection Cparln Feature Builder.

A Cparln is a bounded slot defined by closed ended parallel lines. To create a new instance of this class, use NXOpen.CAM.InspectionOperationCollection.CreateInspectionCparlnFeatureBuilder()

New in version NX7.0.0.

Properties

Property Description
ChannelName Returns or sets the channel’s name
CsysReferenceType Returns or sets the coordinate system reference type
CycleEvent Returns the cycle event
CycleTable Returns the cycle
Description Returns or sets the description
EndOfPath Returns the end event builder
EndType Returns or sets the end type of the bounded slot or tab (round or square)
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
InnerOuterType Returns or sets the inspection feature inner outer type (slot/tab)
LayoutAndLayer Returns the Layer and Layout
Length Returns or sets the length of the bounded slot or tab
LengthDirVector Returns or sets the length direction vector selector
LengthDirectionI Returns or sets the slot or tab length direction I component
LengthDirectionJ Returns or sets the slot or tab length direction J component
LengthDirectionK Returns or sets the slot or tab length direction K component
LocationPointX Returns or sets the location point X coordinate at the center of the face of the slot or tab
LocationPointY Returns or sets the location point Y coordinate at the center of the face of the slot or tab
LocationPointZ Returns or sets the location point Z coordinate at the center of the face of the slot or tab
MotionOutputBuilder Returns the motion output builder
Name Returns or sets the slot or tab feature name
NormalDirectionI Returns or sets the slot or tab normal direction I component
NormalDirectionJ Returns or sets the slot or tab normal direction J component
NormalDirectionK Returns or sets the slot or tab normal direction K component
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
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)
ReverseDirection Returns or sets the reverse direction button used to reverse the normal direction vector
SafeClearance Returns the safe clearance builder
SelectProjectionFaces Returns the selector for projection faces
SelectToolFlag Returns or sets the user selected tool
SelectedGeometry Returns the selected geometry, consisting of two parallel lines
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
ToolPathEditor Returns the Tool Path Editor Builder
ToolPathSplitParametersBuilder Returns the tool path split Parameters
Width Returns or sets the width of the bounded slot or tab

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.
FlipNormal Flips the cparln inspection feature normal vector
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.
ReverseOffsetDirection Reverses the offset direction
SetHoleAxisValues Set the Hole Axis values
ShowResults Updates the model to reflect the result of an edit to the model for all builders that support showing results.
UpdateEndType Updates cparln inspection feature characteristic parameters based on selected end type
UpdateOffset Updates the cparln inspection feature offset distance and associated values
UpdateParams Updates cparln inspection feature characteristic parameters based on selected geometry
Validate Validate whether the inputs to the component are sufficient for commit to be called.

Enumerations

InspectionCparlnFeatureBuilderEndTypes Enumeration The shape of the end of the bounded slot/tab (round or square)

Property Detail

CsysReferenceType

InspectionCparlnFeatureBuilder.CsysReferenceType

Returns or sets the coordinate system reference type

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

Getter Method

Signature CsysReferenceType

Returns:
Return type:NXOpen.CAM.CamInspectionOperationCsysreferencetypes

New in version NX7.0.0.

License requirements: None.

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

Setter Method

Signature CsysReferenceType

Parameters:csysReferenceType (NXOpen.CAM.CamInspectionOperationCsysreferencetypes) –

New in version NX7.0.0.

License requirements: insp_programming (“INSPECTION PROGRAMMING”)

EndType

InspectionCparlnFeatureBuilder.EndType

Returns or sets the end type of the bounded slot or tab (round or square)

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

Getter Method

Signature EndType

Returns:
Return type:NXOpen.CAM.InspectionCparlnFeatureBuilderEndTypes

New in version NX7.0.0.

License requirements: None.

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

Setter Method

Signature EndType

Parameters:endType (NXOpen.CAM.InspectionCparlnFeatureBuilderEndTypes) –

New in version NX7.0.0.

License requirements: insp_programming (“INSPECTION PROGRAMMING”)

InnerOuterType

InspectionCparlnFeatureBuilder.InnerOuterType

Returns or sets the inspection feature inner outer type (slot/tab)

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

Getter Method

Signature InnerOuterType

Returns:
Return type:NXOpen.CAM.CamInspectionOperationInneroutertypes

New in version NX7.0.0.

License requirements: None.

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

Setter Method

Signature InnerOuterType

Parameters:innerOuterType (NXOpen.CAM.CamInspectionOperationInneroutertypes) –

New in version NX7.0.0.

License requirements: insp_programming (“INSPECTION PROGRAMMING”)

Length

InspectionCparlnFeatureBuilder.Length

Returns or sets the length of the bounded slot or tab

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

Getter Method

Signature Length

Returns:
Return type:float

New in version NX7.0.0.

License requirements: None.

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

Setter Method

Signature Length

Parameters:length (float) –

New in version NX7.0.0.

License requirements: insp_programming (“INSPECTION PROGRAMMING”)

LengthDirVector

InspectionCparlnFeatureBuilder.LengthDirVector

Returns or sets the length direction vector selector

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

Getter Method

Signature LengthDirVector

Returns:
Return type:NXOpen.Direction

New in version NX7.0.0.

License requirements: None.

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

Setter Method

Signature LengthDirVector

Parameters:lengthDirVector (NXOpen.Direction) –

New in version NX7.0.0.

License requirements: insp_programming (“INSPECTION PROGRAMMING”)

LengthDirectionI

InspectionCparlnFeatureBuilder.LengthDirectionI

Returns or sets the slot or tab length direction I component

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

Getter Method

Signature LengthDirectionI

Returns:
Return type:float

New in version NX7.0.0.

License requirements: None.

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

Setter Method

Signature LengthDirectionI

Parameters:lengthDirectionI (float) –

New in version NX7.0.0.

License requirements: insp_programming (“INSPECTION PROGRAMMING”)

LengthDirectionJ

InspectionCparlnFeatureBuilder.LengthDirectionJ

Returns or sets the slot or tab length direction J component

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

Getter Method

Signature LengthDirectionJ

Returns:
Return type:float

New in version NX7.0.0.

License requirements: None.

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

Setter Method

Signature LengthDirectionJ

Parameters:lengthDirectionJ (float) –

New in version NX7.0.0.

License requirements: insp_programming (“INSPECTION PROGRAMMING”)

LengthDirectionK

InspectionCparlnFeatureBuilder.LengthDirectionK

Returns or sets the slot or tab length direction K component

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

Getter Method

Signature LengthDirectionK

Returns:
Return type:float

New in version NX7.0.0.

License requirements: None.

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

Setter Method

Signature LengthDirectionK

Parameters:lengthDirectionK (float) –

New in version NX7.0.0.

License requirements: insp_programming (“INSPECTION PROGRAMMING”)

LocationPointX

InspectionCparlnFeatureBuilder.LocationPointX

Returns or sets the location point X coordinate at the center of the face of the slot or tab

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

Getter Method

Signature LocationPointX

Returns:
Return type:float

New in version NX7.0.0.

License requirements: None.

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

Setter Method

Signature LocationPointX

Parameters:locationPointX (float) –

New in version NX7.0.0.

License requirements: insp_programming (“INSPECTION PROGRAMMING”)

LocationPointY

InspectionCparlnFeatureBuilder.LocationPointY

Returns or sets the location point Y coordinate at the center of the face of the slot or tab

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

Getter Method

Signature LocationPointY

Returns:
Return type:float

New in version NX7.0.0.

License requirements: None.

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

Setter Method

Signature LocationPointY

Parameters:locationPointY (float) –

New in version NX7.0.0.

License requirements: insp_programming (“INSPECTION PROGRAMMING”)

LocationPointZ

InspectionCparlnFeatureBuilder.LocationPointZ

Returns or sets the location point Z coordinate at the center of the face of the slot or tab

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

Getter Method

Signature LocationPointZ

Returns:
Return type:float

New in version NX7.0.0.

License requirements: None.

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

Setter Method

Signature LocationPointZ

Parameters:locationPointZ (float) –

New in version NX7.0.0.

License requirements: insp_programming (“INSPECTION PROGRAMMING”)

Name

InspectionCparlnFeatureBuilder.Name

Returns or sets the slot or tab feature 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”)

NormalDirectionI

InspectionCparlnFeatureBuilder.NormalDirectionI

Returns or sets the slot or tab normal direction I component

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

Getter Method

Signature NormalDirectionI

Returns:
Return type:float

New in version NX7.0.0.

License requirements: None.

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

Setter Method

Signature NormalDirectionI

Parameters:normalDirectionI (float) –

New in version NX7.0.0.

License requirements: insp_programming (“INSPECTION PROGRAMMING”)

NormalDirectionJ

InspectionCparlnFeatureBuilder.NormalDirectionJ

Returns or sets the slot or tab normal direction J component

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

Getter Method

Signature NormalDirectionJ

Returns:
Return type:float

New in version NX7.0.0.

License requirements: None.

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

Setter Method

Signature NormalDirectionJ

Parameters:normalDirectionJ (float) –

New in version NX7.0.0.

License requirements: insp_programming (“INSPECTION PROGRAMMING”)

NormalDirectionK

InspectionCparlnFeatureBuilder.NormalDirectionK

Returns or sets the slot or tab normal direction K component

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

Getter Method

Signature NormalDirectionK

Returns:
Return type:float

New in version NX7.0.0.

License requirements: None.

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

Setter Method

Signature NormalDirectionK

Parameters:normalDirectionK (float) –

New in version NX7.0.0.

License requirements: insp_programming (“INSPECTION PROGRAMMING”)

OffsetDistance

InspectionCparlnFeatureBuilder.OffsetDistance

Returns the offset distance

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

Getter Method

Signature OffsetDistance

Returns:
Return type:NXOpen.CAM.InheritableDoubleBuilder

New in version NX9.0.0.

License requirements: None.

ReverseDirection

InspectionCparlnFeatureBuilder.ReverseDirection

Returns or sets the reverse direction button used to reverse the normal direction vector

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

Getter Method

Signature ReverseDirection

Returns:
Return type:bool

New in version NX7.0.0.

License requirements: None.

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

Setter Method

Signature ReverseDirection

Parameters:reverseDirection (bool) –

New in version NX7.0.0.

License requirements: insp_programming (“INSPECTION PROGRAMMING”)

SelectProjectionFaces

InspectionCparlnFeatureBuilder.SelectProjectionFaces

Returns the selector for projection faces

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

Getter Method

Signature SelectProjectionFaces

Returns:
Return type:NXOpen.SelectFace

New in version NX7.0.0.

License requirements: None.

SelectedGeometry

InspectionCparlnFeatureBuilder.SelectedGeometry

Returns the selected geometry, consisting of two parallel lines

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

Getter Method

Signature SelectedGeometry

Returns:
Return type:NXOpen.SelectNXObjectList

New in version NX7.0.0.

License requirements: None.

Width

InspectionCparlnFeatureBuilder.Width

Returns or sets the width of the bounded slot or tab

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

Getter Method

Signature Width

Returns:
Return type:float

New in version NX7.0.0.

License requirements: None.

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

Setter Method

Signature Width

Parameters:width (float) –

New in version NX7.0.0.

License requirements: insp_programming (“INSPECTION PROGRAMMING”)

Method Detail

FlipNormal

InspectionCparlnFeatureBuilder.FlipNormal

Flips the cparln inspection feature normal vector

Signature FlipNormal()

New in version NX7.0.0.

License requirements: insp_programming (“INSPECTION PROGRAMMING”)

ReverseOffsetDirection

InspectionCparlnFeatureBuilder.ReverseOffsetDirection

Reverses the offset direction

Signature ReverseOffsetDirection()

New in version NX9.0.0.

License requirements: insp_programming (“INSPECTION PROGRAMMING”)

UpdateEndType

InspectionCparlnFeatureBuilder.UpdateEndType

Updates cparln inspection feature characteristic parameters based on selected end type

Signature UpdateEndType()

New in version NX9.0.0.

License requirements: insp_programming (“INSPECTION PROGRAMMING”)

UpdateOffset

InspectionCparlnFeatureBuilder.UpdateOffset

Updates the cparln inspection feature offset distance and associated values

Signature UpdateOffset()

New in version NX9.0.0.

License requirements: insp_programming (“INSPECTION PROGRAMMING”)

UpdateParams

InspectionCparlnFeatureBuilder.UpdateParams

Updates cparln inspection feature characteristic parameters based on selected geometry

Signature UpdateParams()

New in version NX7.0.0.

License requirements: insp_programming (“INSPECTION PROGRAMMING”)

Validate

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