InspectionCircleFeatureBuilder Class

class NXOpen.CAM.InspectionCircleFeatureBuilder

Bases: NXOpen.CAM.OperationBuilder

Represents a CMM Inspection Circle Feature builder

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

New in version NX7.0.0.

Properties

Property	Description
CenterPointX	Returns or sets the circle center point X coordinate
CenterPointY	Returns or sets the circle center point Y coordinate
CenterPointZ	Returns or sets the circle center point Z coordinate
ChannelName	Returns or sets the channel’s name
CsysRefType	Returns or sets the coordinate system reference type
CycleEvent	Returns the cycle event
CycleTable	Returns the cycle
CylinderCircleFitModeBuilder	Returns the Cylinder Circle Fitting Mode Builder
Description	Returns or sets the description
Diameter	Returns or sets the circle diameter
EndOfPath	Returns the end event builder
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 (hole/pin)
LayoutAndLayer	Returns the Layer and Layout
MotionOutputBuilder	Returns the motion output builder
Name	Returns or sets the circle inspection feature name
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
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 flip the normal vector of the circle
SafeClearance	Returns the safe clearance builder
SelectProjectionFaces	Returns the button used to select faces to project the circle to
SelectToolFlag	Returns or sets the user selected tool
SelectedCircle	Returns the selected circle
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 circle 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.
UpdateOffset	Updates the circle inspection feature offset distance and associated values
UpdateParams	Updates circle 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

CenterPointX

InspectionCircleFeatureBuilder.CenterPointX

Returns or sets the circle center point X coordinate

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

Getter Method

Signature CenterPointX

Returns: Return type:float

New in version NX7.0.0.

License requirements: None.

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

Setter Method

Signature CenterPointX

Parameters:centerPointX (float) –

New in version NX7.0.0.

License requirements: insp_programming (“INSPECTION PROGRAMMING”)

CenterPointY

InspectionCircleFeatureBuilder.CenterPointY

Returns or sets the circle center point Y coordinate

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

Getter Method

Signature CenterPointY

Returns: Return type:float

New in version NX7.0.0.

License requirements: None.

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

Setter Method

Signature CenterPointY

Parameters:centerPointY (float) –

New in version NX7.0.0.

License requirements: insp_programming (“INSPECTION PROGRAMMING”)

CenterPointZ

InspectionCircleFeatureBuilder.CenterPointZ

Returns or sets the circle center point Z coordinate

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

Getter Method

Signature CenterPointZ

Returns: Return type:float

New in version NX7.0.0.

License requirements: None.

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

Setter Method

Signature CenterPointZ

Parameters:centerPointZ (float) –

New in version NX7.0.0.

License requirements: insp_programming (“INSPECTION PROGRAMMING”)

CsysRefType

InspectionCircleFeatureBuilder.CsysRefType

Returns or sets the coordinate system reference type

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

Getter Method

Signature CsysRefType

Returns: Return type:NXOpen.CAM.CamInspectionOperationCsysreferencetypes

New in version NX7.0.0.

License requirements: None.

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

Setter Method

Signature CsysRefType

Parameters:csysRefType (NXOpen.CAM.CamInspectionOperationCsysreferencetypes) –

New in version NX7.0.0.

License requirements: insp_programming (“INSPECTION PROGRAMMING”)

CylinderCircleFitModeBuilder

InspectionCircleFeatureBuilder.CylinderCircleFitModeBuilder

Returns the Cylinder Circle Fitting Mode Builder

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

Getter Method

Signature CylinderCircleFitModeBuilder

Returns: Return type:NXOpen.CAM.InspectionCylinderCircleFitModeBuilder

New in version NX9.0.0.

License requirements: None.

Diameter

InspectionCircleFeatureBuilder.Diameter

Returns or sets the circle diameter

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

Getter Method

Signature Diameter

Returns: Return type:float

New in version NX7.0.0.

License requirements: None.

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

Setter Method

Signature Diameter

Parameters:diameter (float) –

New in version NX7.0.0.

License requirements: insp_programming (“INSPECTION PROGRAMMING”)

InnerOuterType

InspectionCircleFeatureBuilder.InnerOuterType

Returns or sets the inspection feature inner/outer type (hole/pin)

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

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

InspectionCircleFeatureBuilder.Name

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

NormalVectorI

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

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

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

OffsetDistance

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

InspectionCircleFeatureBuilder.ReverseDirection

Returns or sets the reverse direction button used to flip the normal vector of the circle

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

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

InspectionCircleFeatureBuilder.SelectProjectionFaces

Returns the button used to select faces to project the circle to

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

Getter Method

Signature SelectProjectionFaces

Returns: Return type:NXOpen.SelectNXObject

New in version NX7.0.0.

License requirements: None.

SelectedCircle

InspectionCircleFeatureBuilder.SelectedCircle

Returns the selected circle

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

Getter Method

Signature SelectedCircle

Returns: Return type:NXOpen.SelectNXObjectList

New in version NX7.0.0.

License requirements: None.

Method Detail

FlipNormal

InspectionCircleFeatureBuilder.FlipNormal

Flips the circle inspection feature normal vector

Signature FlipNormal()

New in version NX7.0.0.

License requirements: insp_programming (“INSPECTION PROGRAMMING”)

ReverseOffsetDirection

InspectionCircleFeatureBuilder.ReverseOffsetDirection

Reverses the offset direction

Signature ReverseOffsetDirection()

New in version NX9.0.0.

License requirements: insp_programming (“INSPECTION PROGRAMMING”)

UpdateOffset

InspectionCircleFeatureBuilder.UpdateOffset

Updates the circle inspection feature offset distance and associated values

Signature UpdateOffset()

New in version NX9.0.0.

License requirements: insp_programming (“INSPECTION PROGRAMMING”)

UpdateParams

InspectionCircleFeatureBuilder.UpdateParams

Updates circle inspection feature characteristic parameters based on selected geometry

Signature UpdateParams()

New in version NX7.0.0.

License requirements: insp_programming (“INSPECTION PROGRAMMING”)

Validate

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