InspectionParplnFeatureBuilder Class

class NXOpen.CAM.InspectionParplnFeatureBuilder

Bases: NXOpen.CAM.OperationBuilder

Represents a CMM Inspection Parpln Feature Builder.

A Parpln is an unbounded slot or tab defined by two parallel planes. To create a new instance of this class, use NXOpen.CAM.InspectionOperationCollection.CreateInspectionParplnFeatureBuilder()

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
EndUdeSet	Returns the end ude set
ExtentType	Returns or sets the extent type of the slot/tab (bounded or unbounded)
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
MotionOutputBuilder	Returns the motion output builder
Name	Returns or sets the name of the parpln feature
Notes	Returns the notes builder
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)
SafeClearance	Returns the safe clearance builder
SelectToolFlag	Returns or sets the user selected tool
SelectedSide1	Returns the first selected side of the parpln slot/tab
SelectedSide2	Returns the second selected side of the parpln slot/tab
Side1NormalVectorI	Returns or sets the I component of the normal vector of the plane on the first side of the parpln
Side1NormalVectorJ	Returns or sets the J component of the normal vector of the plane on the first side of the parpln
Side1NormalVectorK	Returns or sets the K component of the normal vector of the plane on the first side of the parpln
Side1PointX	Returns or sets the X coordinate of the center of the plane on the first side of the parpln
Side1PointY	Returns or sets the Y coordinate of the center of the plane on the first side of the parpln
Side1PointZ	Returns or sets the Z coordinate of the center of the plane on the first side of the parpln
Side2NormalVectorI	Returns or sets the I component of the normal vector of the plane on the second side of the parpln
Side2NormalVectorJ	Returns or sets the J component of the normal vector of the plane on the second side of the parpln
Side2NormalVectorK	Returns or sets the K component of the normal vector of the plane on the second side of the parpln
Side2PointX	Returns or sets the X coordinate of the center of the plane on the second side of the parpln
Side2PointY	Returns or sets the Y coordinate of the center of the plane on the second side of the parpln
Side2PointZ	Returns or sets the Z coordinate of the center of the plane on the second side of the parpln
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 parpln slot/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.
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.
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.
UpdateParams	Updates parpln inspection feature characteristic parameters based on selected geometry
Validate	Validate whether the inputs to the component are sufficient for commit to be called.

Property Detail

CsysReferenceType

InspectionParplnFeatureBuilder.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”)

ExtentType

InspectionParplnFeatureBuilder.ExtentType

Returns or sets the extent type of the slot/tab (bounded or unbounded)

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

Getter Method

Signature ExtentType

Returns: Return type:NXOpen.CAM.CamInspectionOperationExtenttypes

New in version NX7.0.0.

License requirements: None.

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

Setter Method

Signature ExtentType

Parameters:extentType (NXOpen.CAM.CamInspectionOperationExtenttypes) –

New in version NX7.0.0.

License requirements: insp_programming (“INSPECTION PROGRAMMING”)

InnerOuterType

InspectionParplnFeatureBuilder.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”)

Name

InspectionParplnFeatureBuilder.Name

Returns or sets the name of the parpln feature

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

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”)

SelectedSide1

InspectionParplnFeatureBuilder.SelectedSide1

Returns the first selected side of the parpln slot/tab

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

Getter Method

Signature SelectedSide1

Returns: Return type:NXOpen.SelectNXObjectList

New in version NX7.0.0.

License requirements: None.

SelectedSide2

InspectionParplnFeatureBuilder.SelectedSide2

Returns the second selected side of the parpln slot/tab

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

Getter Method

Signature SelectedSide2

Returns: Return type:NXOpen.SelectNXObjectList

New in version NX7.0.0.

License requirements: None.

Side1NormalVectorI

InspectionParplnFeatureBuilder.Side1NormalVectorI

Returns or sets the I component of the normal vector of the plane on the first side of the parpln

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

Getter Method

Signature Side1NormalVectorI

Returns: Return type:float

New in version NX7.0.0.

License requirements: None.

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

Setter Method

Signature Side1NormalVectorI

Parameters:side1NormalVectorI (float) –

New in version NX7.0.0.

License requirements: insp_programming (“INSPECTION PROGRAMMING”)

Side1NormalVectorJ

InspectionParplnFeatureBuilder.Side1NormalVectorJ

Returns or sets the J component of the normal vector of the plane on the first side of the parpln

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

Getter Method

Signature Side1NormalVectorJ

Returns: Return type:float

New in version NX7.0.0.

License requirements: None.

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

Setter Method

Signature Side1NormalVectorJ

Parameters:side1NormalVectorJ (float) –

New in version NX7.0.0.

License requirements: insp_programming (“INSPECTION PROGRAMMING”)

Side1NormalVectorK

InspectionParplnFeatureBuilder.Side1NormalVectorK

Returns or sets the K component of the normal vector of the plane on the first side of the parpln

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

Getter Method

Signature Side1NormalVectorK

Returns: Return type:float

New in version NX7.0.0.

License requirements: None.

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

Setter Method

Signature Side1NormalVectorK

Parameters:side1NormalVectorK (float) –

New in version NX7.0.0.

License requirements: insp_programming (“INSPECTION PROGRAMMING”)

Side1PointX

InspectionParplnFeatureBuilder.Side1PointX

Returns or sets the X coordinate of the center of the plane on the first side of the parpln

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

Getter Method

Signature Side1PointX

Returns: Return type:float

New in version NX7.0.0.

License requirements: None.

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

Setter Method

Signature Side1PointX

Parameters:side1PointX (float) –

New in version NX7.0.0.

License requirements: insp_programming (“INSPECTION PROGRAMMING”)

Side1PointY

InspectionParplnFeatureBuilder.Side1PointY

Returns or sets the Y coordinate of the center of the plane on the first side of the parpln

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

Getter Method

Signature Side1PointY

Returns: Return type:float

New in version NX7.0.0.

License requirements: None.

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

Setter Method

Signature Side1PointY

Parameters:side1PointY (float) –

New in version NX7.0.0.

License requirements: insp_programming (“INSPECTION PROGRAMMING”)

Side1PointZ

InspectionParplnFeatureBuilder.Side1PointZ

Returns or sets the Z coordinate of the center of the plane on the first side of the parpln

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

Getter Method

Signature Side1PointZ

Returns: Return type:float

New in version NX7.0.0.

License requirements: None.

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

Setter Method

Signature Side1PointZ

Parameters:side1PointZ (float) –

New in version NX7.0.0.

License requirements: insp_programming (“INSPECTION PROGRAMMING”)

Side2NormalVectorI

InspectionParplnFeatureBuilder.Side2NormalVectorI

Returns or sets the I component of the normal vector of the plane on the second side of the parpln

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

Getter Method

Signature Side2NormalVectorI

Returns: Return type:float

New in version NX7.0.0.

License requirements: None.

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

Setter Method

Signature Side2NormalVectorI

Parameters:side2NormalVectorI (float) –

New in version NX7.0.0.

License requirements: insp_programming (“INSPECTION PROGRAMMING”)

Side2NormalVectorJ

InspectionParplnFeatureBuilder.Side2NormalVectorJ

Returns or sets the J component of the normal vector of the plane on the second side of the parpln

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

Getter Method

Signature Side2NormalVectorJ

Returns: Return type:float

New in version NX7.0.0.

License requirements: None.

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

Setter Method

Signature Side2NormalVectorJ

Parameters:side2NormalVectorJ (float) –

New in version NX7.0.0.

License requirements: insp_programming (“INSPECTION PROGRAMMING”)

Side2NormalVectorK

InspectionParplnFeatureBuilder.Side2NormalVectorK

Returns or sets the K component of the normal vector of the plane on the second side of the parpln

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

Getter Method

Signature Side2NormalVectorK

Returns: Return type:float

New in version NX7.0.0.

License requirements: None.

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

Setter Method

Signature Side2NormalVectorK

Parameters:side2NormalVectorK (float) –

New in version NX7.0.0.

License requirements: insp_programming (“INSPECTION PROGRAMMING”)

Side2PointX

InspectionParplnFeatureBuilder.Side2PointX

Returns or sets the X coordinate of the center of the plane on the second side of the parpln

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

Getter Method

Signature Side2PointX

Returns: Return type:float

New in version NX7.0.0.

License requirements: None.

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

Setter Method

Signature Side2PointX

Parameters:side2PointX (float) –

New in version NX7.0.0.

License requirements: insp_programming (“INSPECTION PROGRAMMING”)

Side2PointY

InspectionParplnFeatureBuilder.Side2PointY

Returns or sets the Y coordinate of the center of the plane on the second side of the parpln

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

Getter Method

Signature Side2PointY

Returns: Return type:float

New in version NX7.0.0.

License requirements: None.

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

Setter Method

Signature Side2PointY

Parameters:side2PointY (float) –

New in version NX7.0.0.

License requirements: insp_programming (“INSPECTION PROGRAMMING”)

Side2PointZ

InspectionParplnFeatureBuilder.Side2PointZ

Returns or sets the Z coordinate of the center of the plane on the second side of the parpln

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

Getter Method

Signature Side2PointZ

Returns: Return type:float

New in version NX7.0.0.

License requirements: None.

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

Setter Method

Signature Side2PointZ

Parameters:side2PointZ (float) –

New in version NX7.0.0.

License requirements: insp_programming (“INSPECTION PROGRAMMING”)

Width

InspectionParplnFeatureBuilder.Width

Returns or sets the width of the parpln slot/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

UpdateParams

InspectionParplnFeatureBuilder.UpdateParams

Updates parpln inspection feature characteristic parameters based on selected geometry

Signature UpdateParams()

New in version NX7.0.0.

License requirements: insp_programming (“INSPECTION PROGRAMMING”)

Validate

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