InspectionAlignmentAssistantBuilder Class

class NXOpen.CAM.InspectionAlignmentAssistantBuilder

Bases: NXOpen.CAM.OperationBuilder

Represents a CMM Inspection Alignment Assistant Builder, this builder’s Commit can produce more than one object, the GetCommittedObjects can be used to get the objects and the order of GetCommittedObject’s output array is not stable.

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

New in version NX10.0.3.

Properties

Property Description
AlignmentType Returns or sets the alignment type
ChannelName Returns or sets the channel’s name
CreateIterativeAlignment Returns or sets the flag indicating whether an iterative alignment will be created
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
IterativeMax Returns or sets the maximum number of iterations
IterativeRotation Returns or sets the iterative rotation convergence value
IterativeToggle Returns or sets the flag indicating whether an iterative alignment will be created
IterativeTranslation Returns or sets the iterative translation convergence value
IterativeType Returns or sets the iterative alignment type
LayoutAndLayer Returns the Layer and Layout
LocateSelection Returns the locate selection
MotionOutputBuilder Returns the motion output builder
Notes Returns the notes builder
OperationName Returns or sets the alignment assistant operation name
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
PrimaryDirection Returns or sets the primary direction
PrimaryOffsetGeometry Returns or sets the primary offset geometry
PrimarySelection Returns the primary selection
PrimaryState Returns or sets the primary state
PrimaryType Returns or sets the primary feature type
RPSXSelection Returns the RPS X selection
RPSYSelection Returns the RPS Y selection
RPSZSelection Returns the RPS Z selection
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
SecondaryDirection Returns or sets the secondary direction
SecondaryOffsetGeometry Returns or sets the secondary offset geometry
SecondarySelection Returns the secondary selection
SecondaryState Returns or sets the secondary state
SecondaryType Returns or sets the secondary feature type
SelectToolFlag Returns or sets the user selected tool
StartOfPath Returns the start event builder
StartUdeSet Returns the start ude set
Tag Returns the Tag for this object.
TertiaryDirection Returns or sets the tertiary direction
TertiaryOffsetGeometry Returns or sets the tertiary offset geometry
TertiarySelection Returns the tertiary selection
TertiaryState Returns or sets the tertiary state
TertiaryType Returns or sets the tertiary feature type
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.
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.
Validate Validate whether the inputs to the component are sufficient for commit to be called.

Property Detail

AlignmentType

InspectionAlignmentAssistantBuilder.AlignmentType

Returns or sets the alignment type

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

Getter Method

Signature AlignmentType

Returns:
Return type:NXOpen.CAM.InspectionAlignmentAssistantBuilderAlignType

New in version NX10.0.3.

License requirements: None.

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

Setter Method

Signature AlignmentType

Parameters:alignmentType (NXOpen.CAM.InspectionAlignmentAssistantBuilderAlignType) –

New in version NX10.0.3.

License requirements: insp_programming (“INSPECTION PROGRAMMING”)

CreateIterativeAlignment

InspectionAlignmentAssistantBuilder.CreateIterativeAlignment

Returns or sets the flag indicating whether an iterative alignment will be created

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

Getter Method

Signature CreateIterativeAlignment

Returns:
Return type:bool

New in version NX11.0.1.

License requirements: None.

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

Setter Method

Signature CreateIterativeAlignment

Parameters:createIterativeAlignment (bool) –

New in version NX11.0.1.

License requirements: insp_programming (“INSPECTION PROGRAMMING”)

IterativeMax

InspectionAlignmentAssistantBuilder.IterativeMax

Returns or sets the maximum number of iterations

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

Getter Method

Signature IterativeMax

Returns:
Return type:int

New in version NX10.0.3.

License requirements: None.

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

Setter Method

Signature IterativeMax

Parameters:iterativeMax (int) –

New in version NX10.0.3.

License requirements: insp_programming (“INSPECTION PROGRAMMING”)

IterativeRotation

InspectionAlignmentAssistantBuilder.IterativeRotation

Returns or sets the iterative rotation convergence value

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

Getter Method

Signature IterativeRotation

Returns:
Return type:float

New in version NX10.0.3.

License requirements: None.

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

Setter Method

Signature IterativeRotation

Parameters:iterativeRotation (float) –

New in version NX10.0.3.

License requirements: insp_programming (“INSPECTION PROGRAMMING”)

IterativeToggle

InspectionAlignmentAssistantBuilder.IterativeToggle

Returns or sets the flag indicating whether an iterative alignment will be created

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

Getter Method

Signature IterativeToggle

Returns:
Return type:bool

New in version NX10.0.3.

Deprecated since version NX11.0.1: Use CreateIterativeAlignment() instead to get iterative flag.

License requirements: None.

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

Setter Method

Signature IterativeToggle

Parameters:iterativeToggle (bool) –

New in version NX10.0.3.

Deprecated since version NX11.0.1: Use CreateIterativeAlignment() instead to set iterative flag.

License requirements: insp_programming (“INSPECTION PROGRAMMING”)

IterativeTranslation

InspectionAlignmentAssistantBuilder.IterativeTranslation

Returns or sets the iterative translation convergence value

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

Getter Method

Signature IterativeTranslation

Returns:
Return type:float

New in version NX10.0.3.

License requirements: None.

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

Setter Method

Signature IterativeTranslation

Parameters:iterativeTranslation (float) –

New in version NX10.0.3.

License requirements: insp_programming (“INSPECTION PROGRAMMING”)

IterativeType

InspectionAlignmentAssistantBuilder.IterativeType

Returns or sets the iterative alignment type

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

Getter Method

Signature IterativeType

Returns:
Return type:NXOpen.CAM.InspectionAlignmentAssistantBuilderIterativeTypes

New in version NX10.0.3.

License requirements: None.

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

Setter Method

Signature IterativeType

Parameters:iterativeType (NXOpen.CAM.InspectionAlignmentAssistantBuilderIterativeTypes) –

New in version NX10.0.3.

License requirements: insp_programming (“INSPECTION PROGRAMMING”)

LocateSelection

InspectionAlignmentAssistantBuilder.LocateSelection

Returns the locate selection

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

Getter Method

Signature LocateSelection

Returns:
Return type:NXOpen.SelectNXObjectList

New in version NX11.0.2.

License requirements: None.

OperationName

InspectionAlignmentAssistantBuilder.OperationName

Returns or sets the alignment assistant operation name

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

Getter Method

Signature OperationName

Returns:
Return type:str

New in version NX10.0.3.

License requirements: None.

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

Setter Method

Signature OperationName

Parameters:operationName (str) –

New in version NX10.0.3.

License requirements: insp_programming (“INSPECTION PROGRAMMING”)

PrimaryDirection

InspectionAlignmentAssistantBuilder.PrimaryDirection

Returns or sets the primary direction

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

Getter Method

Signature PrimaryDirection

Returns:
Return type:NXOpen.CAM.InspectionAlignmentAssistantBuilderDirection

New in version NX10.0.3.

License requirements: None.

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

Setter Method

Signature PrimaryDirection

Parameters:primaryDirection (NXOpen.CAM.InspectionAlignmentAssistantBuilderDirection) –

New in version NX10.0.3.

License requirements: insp_programming (“INSPECTION PROGRAMMING”)

PrimaryOffsetGeometry

InspectionAlignmentAssistantBuilder.PrimaryOffsetGeometry

Returns or sets the primary offset geometry

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

Getter Method

Signature PrimaryOffsetGeometry

Returns:
Return type:NXOpen.NXObject

New in version NX10.0.3.

License requirements: None.

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

Setter Method

Signature PrimaryOffsetGeometry

Parameters:primaryOffset (NXOpen.NXObject) –

New in version NX10.0.3.

License requirements: insp_programming (“INSPECTION PROGRAMMING”)

PrimarySelection

InspectionAlignmentAssistantBuilder.PrimarySelection

Returns the primary selection

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

Getter Method

Signature PrimarySelection

Returns:
Return type:NXOpen.SelectNXObjectList

New in version NX10.0.3.

License requirements: None.

PrimaryState

InspectionAlignmentAssistantBuilder.PrimaryState

Returns or sets the primary state

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

Getter Method

Signature PrimaryState

Returns:
Return type:NXOpen.CAM.InspectionAlignmentAssistantBuilderState

New in version NX10.0.3.

License requirements: None.

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

Setter Method

Signature PrimaryState

Parameters:primaryState (NXOpen.CAM.InspectionAlignmentAssistantBuilderState) –

New in version NX10.0.3.

License requirements: insp_programming (“INSPECTION PROGRAMMING”)

PrimaryType

InspectionAlignmentAssistantBuilder.PrimaryType

Returns or sets the primary feature type

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

Getter Method

Signature PrimaryType

Returns:
Return type:NXOpen.CAM.InspectionAlignmentAssistantBuilderFeatureType

New in version NX10.0.3.

License requirements: None.

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

Setter Method

Signature PrimaryType

Parameters:primaryType (NXOpen.CAM.InspectionAlignmentAssistantBuilderFeatureType) –

New in version NX10.0.3.

License requirements: insp_programming (“INSPECTION PROGRAMMING”)

RPSXSelection

InspectionAlignmentAssistantBuilder.RPSXSelection

Returns the RPS X selection

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

Getter Method

Signature RPSXSelection

Returns:
Return type:NXOpen.SelectNXObjectList

New in version NX11.0.2.

License requirements: None.

RPSYSelection

InspectionAlignmentAssistantBuilder.RPSYSelection

Returns the RPS Y selection

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

Getter Method

Signature RPSYSelection

Returns:
Return type:NXOpen.SelectNXObjectList

New in version NX11.0.2.

License requirements: None.

RPSZSelection

InspectionAlignmentAssistantBuilder.RPSZSelection

Returns the RPS Z selection

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

Getter Method

Signature RPSZSelection

Returns:
Return type:NXOpen.SelectNXObjectList

New in version NX11.0.2.

License requirements: None.

SecondaryDirection

InspectionAlignmentAssistantBuilder.SecondaryDirection

Returns or sets the secondary direction

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

Getter Method

Signature SecondaryDirection

Returns:
Return type:NXOpen.CAM.InspectionAlignmentAssistantBuilderDirection

New in version NX10.0.3.

License requirements: None.

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

Setter Method

Signature SecondaryDirection

Parameters:secondaryDirection (NXOpen.CAM.InspectionAlignmentAssistantBuilderDirection) –

New in version NX10.0.3.

License requirements: insp_programming (“INSPECTION PROGRAMMING”)

SecondaryOffsetGeometry

InspectionAlignmentAssistantBuilder.SecondaryOffsetGeometry

Returns or sets the secondary offset geometry

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

Getter Method

Signature SecondaryOffsetGeometry

Returns:
Return type:NXOpen.NXObject

New in version NX10.0.3.

License requirements: None.

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

Setter Method

Signature SecondaryOffsetGeometry

Parameters:secondaryOffset (NXOpen.NXObject) –

New in version NX10.0.3.

License requirements: insp_programming (“INSPECTION PROGRAMMING”)

SecondarySelection

InspectionAlignmentAssistantBuilder.SecondarySelection

Returns the secondary selection

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

Getter Method

Signature SecondarySelection

Returns:
Return type:NXOpen.SelectNXObjectList

New in version NX10.0.3.

License requirements: None.

SecondaryState

InspectionAlignmentAssistantBuilder.SecondaryState

Returns or sets the secondary state

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

Getter Method

Signature SecondaryState

Returns:
Return type:NXOpen.CAM.InspectionAlignmentAssistantBuilderState

New in version NX10.0.3.

License requirements: None.

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

Setter Method

Signature SecondaryState

Parameters:secondaryState (NXOpen.CAM.InspectionAlignmentAssistantBuilderState) –

New in version NX10.0.3.

License requirements: insp_programming (“INSPECTION PROGRAMMING”)

SecondaryType

InspectionAlignmentAssistantBuilder.SecondaryType

Returns or sets the secondary feature type

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

Getter Method

Signature SecondaryType

Returns:
Return type:NXOpen.CAM.InspectionAlignmentAssistantBuilderFeatureType

New in version NX10.0.3.

License requirements: None.

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

Setter Method

Signature SecondaryType

Parameters:secondaryType (NXOpen.CAM.InspectionAlignmentAssistantBuilderFeatureType) –

New in version NX10.0.3.

License requirements: insp_programming (“INSPECTION PROGRAMMING”)

TertiaryDirection

InspectionAlignmentAssistantBuilder.TertiaryDirection

Returns or sets the tertiary direction

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

Getter Method

Signature TertiaryDirection

Returns:
Return type:NXOpen.CAM.InspectionAlignmentAssistantBuilderDirection

New in version NX10.0.3.

License requirements: None.

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

Setter Method

Signature TertiaryDirection

Parameters:tertiaryDirection (NXOpen.CAM.InspectionAlignmentAssistantBuilderDirection) –

New in version NX10.0.3.

License requirements: insp_programming (“INSPECTION PROGRAMMING”)

TertiaryOffsetGeometry

InspectionAlignmentAssistantBuilder.TertiaryOffsetGeometry

Returns or sets the tertiary offset geometry

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

Getter Method

Signature TertiaryOffsetGeometry

Returns:
Return type:NXOpen.NXObject

New in version NX10.0.3.

License requirements: None.

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

Setter Method

Signature TertiaryOffsetGeometry

Parameters:tertiaryOffset (NXOpen.NXObject) –

New in version NX10.0.3.

License requirements: insp_programming (“INSPECTION PROGRAMMING”)

TertiarySelection

InspectionAlignmentAssistantBuilder.TertiarySelection

Returns the tertiary selection

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

Getter Method

Signature TertiarySelection

Returns:
Return type:NXOpen.SelectNXObjectList

New in version NX10.0.3.

License requirements: None.

TertiaryState

InspectionAlignmentAssistantBuilder.TertiaryState

Returns or sets the tertiary state

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

Getter Method

Signature TertiaryState

Returns:
Return type:NXOpen.CAM.InspectionAlignmentAssistantBuilderState

New in version NX10.0.3.

License requirements: None.

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

Setter Method

Signature TertiaryState

Parameters:tertiaryState (NXOpen.CAM.InspectionAlignmentAssistantBuilderState) –

New in version NX10.0.3.

License requirements: insp_programming (“INSPECTION PROGRAMMING”)

TertiaryType

InspectionAlignmentAssistantBuilder.TertiaryType

Returns or sets the tertiary feature type

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

Getter Method

Signature TertiaryType

Returns:
Return type:NXOpen.CAM.InspectionAlignmentAssistantBuilderFeatureType

New in version NX10.0.3.

License requirements: None.

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

Setter Method

Signature TertiaryType

Parameters:tertiaryType (NXOpen.CAM.InspectionAlignmentAssistantBuilderFeatureType) –

New in version NX10.0.3.

License requirements: insp_programming (“INSPECTION PROGRAMMING”)

Method Detail

Validate

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