InspectionTorusFeatureBuilder Class

class NXOpen.CAM.InspectionTorusFeatureBuilder

Bases: NXOpen.CAM.OperationBuilder

Represents a CMM Inspection Torus Feature builder

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

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
CenterPointX Returns or sets the torus center point x coordinate
CenterPointY Returns or sets the torus center point y coordinate
CenterPointZ Returns or sets the torus center point 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
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 inner outer type
LayoutAndLayer Returns the Layer and Layout
MajorRadius Returns or sets the major radius of the torus
MinorRadius Returns or sets the minor radius of the torus
MotionOutputBuilder Returns the motion output builder
Name Returns or sets the torus feature 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)
ReverseDirection Returns or sets the reverse direction
SafeClearance Returns the safe clearance builder
SelectToolFlag Returns or sets the user selected tool
SelectedTorus Returns the selected torus
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 torus 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.
UpdateParams Updates torus 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

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

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

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

CenterPointX

InspectionTorusFeatureBuilder.CenterPointX

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

InspectionTorusFeatureBuilder.CenterPointY

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

InspectionTorusFeatureBuilder.CenterPointZ

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

CsysReferenceType

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

InnerOuterType

InspectionTorusFeatureBuilder.InnerOuterType

Returns or sets the inner outer type

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

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

MajorRadius

InspectionTorusFeatureBuilder.MajorRadius

Returns or sets the major radius of the torus

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

Getter Method

Signature MajorRadius

Returns:
Return type:float

New in version NX7.0.0.

License requirements: None.

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

Setter Method

Signature MajorRadius

Parameters:majorRadius (float) –

New in version NX7.0.0.

License requirements: insp_programming (“INSPECTION PROGRAMMING”)

MinorRadius

InspectionTorusFeatureBuilder.MinorRadius

Returns or sets the minor radius of the torus

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

Getter Method

Signature MinorRadius

Returns:
Return type:float

New in version NX7.0.0.

License requirements: None.

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

Setter Method

Signature MinorRadius

Parameters:minorRadius (float) –

New in version NX7.0.0.

License requirements: insp_programming (“INSPECTION PROGRAMMING”)

Name

InspectionTorusFeatureBuilder.Name

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

ReverseDirection

InspectionTorusFeatureBuilder.ReverseDirection

Returns or sets the reverse direction

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

Getter Method

Signature ReverseDirection

Returns:True if the axis vector has been reversed
Return type:bool

New in version NX7.0.0.

License requirements: None.

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

Setter Method

Signature ReverseDirection

Parameters:reverseDirection (bool) – True if the axis vector should be reversed

New in version NX7.0.0.

License requirements: insp_programming (“INSPECTION PROGRAMMING”)

SelectedTorus

InspectionTorusFeatureBuilder.SelectedTorus

Returns the selected torus

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

Getter Method

Signature SelectedTorus

Returns:
Return type:NXOpen.SelectNXObject

New in version NX7.0.0.

License requirements: None.

Method Detail

FlipAxisDirection

InspectionTorusFeatureBuilder.FlipAxisDirection

Flips the torus inspection feature axis direction vector

Signature FlipAxisDirection()

New in version NX7.0.0.

License requirements: insp_programming (“INSPECTION PROGRAMMING”)

UpdateParams

InspectionTorusFeatureBuilder.UpdateParams

Updates torus inspection feature characteristic parameters based on selected geometry

Signature UpdateParams()

New in version NX7.0.0.

License requirements: insp_programming (“INSPECTION PROGRAMMING”)

Validate

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