InspectionCylinderFeatureBuilder Class

class NXOpen.CAM.InspectionCylinderFeatureBuilder

Bases: NXOpen.CAM.OperationBuilder

Represents a CMM Inspection Cylinder Feature builder

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

New in version NX7.0.0.

Properties

Property	Description
AxisDirectionI	Returns or sets the axis direction vector I component
AxisDirectionJ	Returns or sets the axis direction vector J component
AxisDirectionK	Returns or sets the axis direction vector K component
AxisExtrapolationModeBuilder	Returns the Axis Extrapolation Mode Builder
AxisVector	Returns or sets the cylinders axis vector
BasePointX	Returns or sets the base point X coordinate
BasePointY	Returns or sets the base point Y coordinate
BasePointZ	Returns or sets the base point Z coordinate
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
CylinderCircleFitModeBuilder	Returns the Cylinder Circle Fitting Mode Builder
Description	Returns or sets the description
Diameter	Returns or sets the cylinder diameter
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
InnerOuterType	Returns or sets the inspection feature inner/outer type (hole/pin)
LayoutAndLayer	Returns the Layer and Layout
Length	Returns or sets the length of the cylinder
MotionOutputBuilder	Returns the motion output builder
Name	Returns or sets the name
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
SelectedCylinder	Returns the selected cylinder
SelectedGeometry	Returns the selected cylinder geometry
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.
FlipAxisDirection	Flips the cylinder inspection feature axis direction 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.
UpdateAxisDirection	Updates cylinder inspection feature axis direction vector based on selected vector
UpdateParams	Updates cylinder 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

AxisDirectionI

InspectionCylinderFeatureBuilder.AxisDirectionI

Returns or sets the axis direction vector I component

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

Getter Method

Signature AxisDirectionI

Returns: Return type:float

New in version NX7.0.0.

License requirements: None.

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

Setter Method

Signature AxisDirectionI

Parameters:axisDirectionI (float) –

New in version NX7.0.0.

License requirements: insp_programming (“INSPECTION PROGRAMMING”)

AxisDirectionJ

InspectionCylinderFeatureBuilder.AxisDirectionJ

Returns or sets the axis direction vector J component

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

Getter Method

Signature AxisDirectionJ

Returns: Return type:float

New in version NX7.0.0.

License requirements: None.

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

Setter Method

Signature AxisDirectionJ

Parameters:axisDirectionJ (float) –

New in version NX7.0.0.

License requirements: insp_programming (“INSPECTION PROGRAMMING”)

AxisDirectionK

InspectionCylinderFeatureBuilder.AxisDirectionK

Returns or sets the axis direction vector K component

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

Getter Method

Signature AxisDirectionK

Returns: Return type:float

New in version NX7.0.0.

License requirements: None.

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

Setter Method

Signature AxisDirectionK

Parameters:axisDirectionK (float) –

New in version NX7.0.0.

License requirements: insp_programming (“INSPECTION PROGRAMMING”)

AxisExtrapolationModeBuilder

InspectionCylinderFeatureBuilder.AxisExtrapolationModeBuilder

Returns the Axis Extrapolation Mode Builder

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

Getter Method

Signature AxisExtrapolationModeBuilder

Returns: Return type:NXOpen.CAM.InspectionAxisExtrapolationModeBuilder

New in version NX9.0.0.

License requirements: None.

AxisVector

InspectionCylinderFeatureBuilder.AxisVector

Returns or sets the cylinders axis vector

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

Getter Method

Signature AxisVector

Returns: Return type:NXOpen.Direction

New in version NX7.0.0.

License requirements: None.

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

Setter Method

Signature AxisVector

Parameters:axisVector (NXOpen.Direction) –

New in version NX7.0.0.

License requirements: insp_programming (“INSPECTION PROGRAMMING”)

BasePointX

InspectionCylinderFeatureBuilder.BasePointX

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

InspectionCylinderFeatureBuilder.BasePointY

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

InspectionCylinderFeatureBuilder.BasePointZ

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

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

CylinderCircleFitModeBuilder

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

InspectionCylinderFeatureBuilder.Diameter

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

ExtentType

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

InnerOuterType

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

Length

InspectionCylinderFeatureBuilder.Length

Returns or sets the length of the cylinder

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

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

Name

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

SelectedCylinder

InspectionCylinderFeatureBuilder.SelectedCylinder

Returns the selected cylinder

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

Getter Method

Signature SelectedCylinder

Returns: Return type:NXOpen.SelectNXObject

New in version NX7.0.0.

License requirements: None.

SelectedGeometry

InspectionCylinderFeatureBuilder.SelectedGeometry

Returns the selected cylinder geometry

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

Getter Method

Signature SelectedGeometry

Returns: Return type:NXOpen.SelectNXObjectList

New in version NX9.0.2.

License requirements: None.

Method Detail

FlipAxisDirection

InspectionCylinderFeatureBuilder.FlipAxisDirection

Flips the cylinder inspection feature axis direction vector

Signature FlipAxisDirection()

New in version NX7.0.0.

License requirements: insp_programming (“INSPECTION PROGRAMMING”)

UpdateAxisDirection

InspectionCylinderFeatureBuilder.UpdateAxisDirection

Updates cylinder inspection feature axis direction vector based on selected vector

Signature UpdateAxisDirection(vector)

Parameters:vector (NXOpen.Vector3d) –

New in version NX7.0.0.

License requirements: insp_programming (“INSPECTION PROGRAMMING”)

UpdateParams

InspectionCylinderFeatureBuilder.UpdateParams

Updates cylinder inspection feature characteristic parameters based on selected geometry

Signature UpdateParams()

New in version NX7.0.0.

License requirements: insp_programming (“INSPECTION PROGRAMMING”)

Validate

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