SubInsertBuilder Class

class NXOpen.Tooling.SubInsertBuilder

Bases: NXOpen.Builder

The SubInsert builder

To create a new instance of this class, use NXOpen.Tooling.SubInsertCollection.CreateSubInsertBuilder()

Default values.

Property Value
InputParm 0
Rename 0
SelFootType Box

New in version NX6.0.0.

Properties

Property Description
InputParm Returns or sets the parameter of foot
Rename Returns or sets the subinsert name
SelFootType Returns or sets the foot type which can be a box or a cylinder
SelectBotFace Returns the bottom face to position the sub-insert
SelectHead Returns the head of sub-insert
Tag Returns the Tag for this object.
Type Returns or sets the parent part type

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.
EditDatabase Edit datebase of foot
EditRegFile Edit register file of foot
GetCommittedObjects For builders that create more than one object, this method returns the objects that are created by commit.
GetObject Returns the object currently being edited by this builder.
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.

Enumerations

SubInsertBuilderShape Enumeration Represents the foot shape
SubInsertBuilderTypes Enumeration Represents the type of parent part

Property Detail

InputParm

SubInsertBuilder.InputParm

Returns or sets the parameter of foot

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

Getter Method

Signature InputParm

Returns:
Return type:float

New in version NX6.0.0.

License requirements: None.

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

Setter Method

Signature InputParm

Parameters:inputParm (float) –

New in version NX6.0.0.

License requirements: None.

Rename

SubInsertBuilder.Rename

Returns or sets the subinsert name

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

Getter Method

Signature Rename

Returns:
Return type:bool

New in version NX6.0.0.

License requirements: None.

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

Setter Method

Signature Rename

Parameters:rename (bool) –

New in version NX6.0.0.

License requirements: None.

SelFootType

SubInsertBuilder.SelFootType

Returns or sets the foot type which can be a box or a cylinder

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

Getter Method

Signature SelFootType

Returns:
Return type:NXOpen.Tooling.SubInsertBuilderShape

New in version NX6.0.0.

License requirements: None.

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

Setter Method

Signature SelFootType

Parameters:selFootType (NXOpen.Tooling.SubInsertBuilderShape) –

New in version NX6.0.0.

License requirements: None.

SelectBotFace

SubInsertBuilder.SelectBotFace

Returns the bottom face to position the sub-insert

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

Getter Method

Signature SelectBotFace

Returns:
Return type:NXOpen.SelectBodyList

New in version NX6.0.0.

License requirements: None.

SelectHead

SubInsertBuilder.SelectHead

Returns the head of sub-insert

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

Getter Method

Signature SelectHead

Returns:
Return type:NXOpen.SelectBodyList

New in version NX6.0.0.

License requirements: None.

Type

SubInsertBuilder.Type

Returns or sets the parent part type

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

Getter Method

Signature Type

Returns:
Return type:NXOpen.Tooling.SubInsertBuilderTypes

New in version NX8.0.0.

License requirements: None.

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

Setter Method

Signature Type

Parameters:type (NXOpen.Tooling.SubInsertBuilderTypes) –

New in version NX8.0.0.

License requirements: None.

Method Detail

EditDatabase

SubInsertBuilder.EditDatabase

Edit datebase of foot

Signature EditDatabase()

New in version NX6.0.0.

License requirements: None.

EditRegFile

SubInsertBuilder.EditRegFile

Edit register file of foot

Signature EditRegFile()

New in version NX6.0.0.

License requirements: None.

Validate

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