InspectionPlaneFeatureBuilder Class

class NXOpen.CAM.InspectionPlaneFeatureBuilder

Bases: NXOpen.CAM.OperationBuilder

Represents a CMM Inspection Plane Feature builder

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

New in version NX7.0.0.

Properties

Property	Description
BasePointX	Returns or sets the base point or plane center X coordinate
BasePointY	Returns or sets the base point or plane center Y coordinate
BasePointZ	Returns or sets the base point or plane center Z coordinate
ChannelName	Returns or sets the channel’s name
CsysReferenceType	Returns or sets the csys 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
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
LayoutAndLayer	Returns the Layer and Layout
MotionOutputBuilder	Returns the motion output builder
Name	Returns or sets the plane inspection feature name
NormalVector	Returns or sets the normal vector
NormalVectorI	Returns or sets the normal vector I component
NormalVectorJ	Returns or sets the normal vector J component
NormalVectorK	Returns or sets the normal vector K component
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)
ReverseFaceNormal	Returns or sets the reverse face normal flag
SafeClearance	Returns the safe clearance builder
SelectToolFlag	Returns or sets the user selected tool
SelectedPlane	Returns the selected plane
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

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 plane 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.
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.
UpdateNormalVector	Updates plane inspection feature normal vector based on selected vector
UpdateParams	Updates plane 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

BasePointX

InspectionPlaneFeatureBuilder.BasePointX

Returns or sets the base point or plane center X coordinate

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

Getter Method

Signature BasePointX

Returns: Return type:float

New in version NX7.0.0.

License requirements: None.

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

Setter Method

Signature BasePointX

Parameters:basePointX (float) –

New in version NX7.0.0.

License requirements: insp_programming (“INSPECTION PROGRAMMING”)

BasePointY

InspectionPlaneFeatureBuilder.BasePointY

Returns or sets the base point or plane center Y coordinate

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

Getter Method

Signature BasePointY

Returns: Return type:float

New in version NX7.0.0.

License requirements: None.

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

Setter Method

Signature BasePointY

Parameters:basePointY (float) –

New in version NX7.0.0.

License requirements: insp_programming (“INSPECTION PROGRAMMING”)

BasePointZ

InspectionPlaneFeatureBuilder.BasePointZ

Returns or sets the base point or plane center Z coordinate

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

Getter Method

Signature BasePointZ

Returns: Return type:float

New in version NX7.0.0.

License requirements: None.

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

Setter Method

Signature BasePointZ

Parameters:basePointZ (float) –

New in version NX7.0.0.

License requirements: insp_programming (“INSPECTION PROGRAMMING”)

CsysReferenceType

InspectionPlaneFeatureBuilder.CsysReferenceType

Returns or sets the csys 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

InspectionPlaneFeatureBuilder.ExtentType

Returns or sets the extent type

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

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

Name

InspectionPlaneFeatureBuilder.Name

Returns or sets the plane inspection 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”)

NormalVector

InspectionPlaneFeatureBuilder.NormalVector

Returns or sets the normal vector

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

Getter Method

Signature NormalVector

Returns: Return type:NXOpen.Direction

New in version NX7.0.0.

License requirements: None.

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

Setter Method

Signature NormalVector

Parameters:normalVector (NXOpen.Direction) –

New in version NX7.0.0.

License requirements: insp_programming (“INSPECTION PROGRAMMING”)

NormalVectorI

InspectionPlaneFeatureBuilder.NormalVectorI

Returns or sets the normal vector I component

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

Getter Method

Signature NormalVectorI

Returns: Return type:float

New in version NX7.0.0.

License requirements: None.

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

Setter Method

Signature NormalVectorI

Parameters:normalVectorI (float) –

New in version NX7.0.0.

License requirements: insp_programming (“INSPECTION PROGRAMMING”)

NormalVectorJ

InspectionPlaneFeatureBuilder.NormalVectorJ

Returns or sets the normal vector J component

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

Getter Method

Signature NormalVectorJ

Returns: Return type:float

New in version NX7.0.0.

License requirements: None.

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

Setter Method

Signature NormalVectorJ

Parameters:normalVectorJ (float) –

New in version NX7.0.0.

License requirements: insp_programming (“INSPECTION PROGRAMMING”)

NormalVectorK

InspectionPlaneFeatureBuilder.NormalVectorK

Returns or sets the normal vector K component

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

Getter Method

Signature NormalVectorK

Returns: Return type:float

New in version NX7.0.0.

License requirements: None.

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

Setter Method

Signature NormalVectorK

Parameters:normalVectorK (float) –

New in version NX7.0.0.

License requirements: insp_programming (“INSPECTION PROGRAMMING”)

ReverseFaceNormal

InspectionPlaneFeatureBuilder.ReverseFaceNormal

Returns or sets the reverse face normal flag

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

Getter Method

Signature ReverseFaceNormal

Returns: Return type:bool

New in version NX7.0.0.

License requirements: None.

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

Setter Method

Signature ReverseFaceNormal

Parameters:reverseFaceNormal (bool) –

New in version NX7.0.0.

License requirements: insp_programming (“INSPECTION PROGRAMMING”)

SelectedPlane

InspectionPlaneFeatureBuilder.SelectedPlane

Returns the selected plane

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

Getter Method

Signature SelectedPlane

Returns: Return type:NXOpen.SelectNXObjectList

New in version NX7.0.0.

License requirements: None.

Method Detail

FlipNormal

InspectionPlaneFeatureBuilder.FlipNormal

Flips the plane inspection feature normal vector

Signature FlipNormal()

New in version NX7.0.0.

License requirements: insp_programming (“INSPECTION PROGRAMMING”)

UpdateNormalVector

InspectionPlaneFeatureBuilder.UpdateNormalVector

Updates plane inspection feature normal vector based on selected vector

Signature UpdateNormalVector(vector)

Parameters:vector (NXOpen.Vector3d) – New normal

New in version NX7.0.0.

License requirements: insp_programming (“INSPECTION PROGRAMMING”)

UpdateParams

InspectionPlaneFeatureBuilder.UpdateParams

Updates plane inspection feature characteristic parameters based on selected geometry

Signature UpdateParams()

New in version NX7.0.0.

License requirements: insp_programming (“INSPECTION PROGRAMMING”)

Validate

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