GeneralInsertBuilder Class¶

class NXOpen.Tooling.GeneralInsertBuilder¶

Bases: NXOpen.Builder

General Insert Design Builder of PDW and EDW.

A Body is returned by this builder. To create a new instance of this class, use NXOpen.Tooling.ProgressiveDieManager.CreateGeneralInsertBuilder()

Default values.

Property	Value
BoxOffset.Value	0 (millimeters part), 0 (inches part)
Clearance.Value	0 (millimeters part), 0 (inches part)
GenerateType	BoundingBox
Height.Value	0 (millimeters part), 0 (inches part)
NegativeX.Value	0 (millimeters part), 0 (inches part)
NegativeY.Value	0 (millimeters part), 0 (inches part)
NegativeZ.Value	0 (millimeters part), 0 (inches part)
NormalRenameDialog	0
ParentPart	NoParent
PositiveX.Value	0 (millimeters part), 0 (inches part)
PositiveY.Value	0 (millimeters part), 0 (inches part)
PositiveZ.Value	0 (millimeters part), 0 (inches part)
Radius.Value	0 (millimeters part), 0 (inches part)
SettingWithoutFalseBody	0
StartPosition.Value	0 (millimeters part), 0 (inches part)

New in version NX10.0.0.

Properties¶

Property	Description
BoxOffset	Returns the box offset
Clearance	Returns the clearance
GenerateType	Returns or sets the generate type
Height	Returns the height
InsertToDelete	Returns the insert to delete
InsertToEdit	Returns the insert to edit
NegativeX	Returns the negative x
NegativeY	Returns the negative y
NegativeZ	Returns the negative z
NormalRenameDialog	Returns or sets the normal rename dialog
OrientationReferenceCSYS	Returns or sets the reference CSYS orientation
OuterProfile	Returns the outer profile
ParentPart	Returns or sets the parent part
ParentPartName	Returns or sets the parent part name of parent part
PositiveX	Returns the positive x
PositiveY	Returns the positive y
PositiveZ	Returns the positive z
Radius	Returns the radius
ReverseInsertDirection	Returns or sets the reverse insert direction
SelectFace	Returns the select face
SettingWithoutFalseBody	Returns or sets the setting without false body
StartPosition	Returns the start position
Tag	Returns the Tag for this object.
Type	Returns or sets the operation type of general insert.
UserDefinedExtrudeDirection	Returns or sets the user defined extrude direction
WizardType	Returns or sets the wizard type

Methods¶

Method	Description
AddFromSpreadsheetAttributeList	Move attribute from Attribute from Spreadsheet to Attribute of Object
Commit	Commits any edits that have been applied to the builder.
CreateDatum	Create datum on selected face
CreateUserDefinedInsert	Creates user defined insert.
DeleteAttribute	Remove attribute from Attribute of Object
Destroy	Deletes the builder, and cleans up any objects created by the builder.
GetAttributeTitleName	Returns the title name of Attribute Of Object Tree list
GetAttributeValueText	Returns the value text of Attribute Of Object Tree list
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.
NewAttribute	Create new attribute in Attribute of Object
SetAttributeTitleName	Sets the title name of Attribute Of Object Tree list
SetAttributeValueText	Sets the title name of Attribute Of Object Tree list
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¶

GeneralInsertBuilderGenerateMethod Enumeration	Specify the creation method of insert.
GeneralInsertBuilderParentOption Enumeration	Specify the part parent of insert part.
GeneralInsertBuilderTypes Enumeration	Specify the insert operation type.

Property Detail¶

BoxOffset¶

GeneralInsertBuilder.BoxOffset¶

Returns the box offset

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

Getter Method

Signature BoxOffset

Returns:
Return type:	`NXOpen.Expression`

New in version NX10.0.0.

License requirements: None.

Clearance¶

GeneralInsertBuilder.Clearance¶

Returns the clearance

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

Getter Method

Signature Clearance

Returns:
Return type:	`NXOpen.Expression`

New in version NX10.0.0.

License requirements: None.

GenerateType¶

GeneralInsertBuilder.GenerateType¶

Returns or sets the generate type

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

Getter Method

Signature GenerateType

Returns:
Return type:	`NXOpen.Tooling.GeneralInsertBuilderGenerateMethod`

New in version NX10.0.0.

License requirements: None.

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

Setter Method

Signature GenerateType

Parameters:	generateType (`NXOpen.Tooling.GeneralInsertBuilderGenerateMethod`) –

New in version NX10.0.0.

License requirements: prog_die_wizard (“UG/Progressive Die Wizard”)

Height¶

GeneralInsertBuilder.Height¶

Returns the height

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

Getter Method

Signature Height

Returns:
Return type:	`NXOpen.Expression`

New in version NX10.0.0.

License requirements: None.

InsertToDelete¶

GeneralInsertBuilder.InsertToDelete¶

Returns the insert to delete

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

Getter Method

Signature InsertToDelete

Returns:
Return type:	`NXOpen.Assemblies.SelectComponentList`

New in version NX10.0.0.

License requirements: prog_die_wizard (“UG/Progressive Die Wizard”)

InsertToEdit¶

GeneralInsertBuilder.InsertToEdit¶

Returns the insert to edit

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

Getter Method

Signature InsertToEdit

Returns:
Return type:	`NXOpen.Assemblies.SelectComponent`

New in version NX10.0.0.

License requirements: None.

NegativeX¶

GeneralInsertBuilder.NegativeX¶

Returns the negative x

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

Getter Method

Signature NegativeX

Returns:
Return type:	`NXOpen.Expression`

New in version NX10.0.0.

License requirements: None.

NegativeY¶

GeneralInsertBuilder.NegativeY¶

Returns the negative y

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

Getter Method

Signature NegativeY

Returns:
Return type:	`NXOpen.Expression`

New in version NX10.0.0.

License requirements: None.

NegativeZ¶

GeneralInsertBuilder.NegativeZ¶

Returns the negative z

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

Getter Method

Signature NegativeZ

Returns:
Return type:	`NXOpen.Expression`

New in version NX10.0.0.

License requirements: None.

NormalRenameDialog¶

GeneralInsertBuilder.NormalRenameDialog¶

Returns or sets the normal rename dialog

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

Getter Method

Signature NormalRenameDialog

Returns:
Return type:	bool

New in version NX10.0.0.

License requirements: None.

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

Setter Method

Signature NormalRenameDialog

Parameters:	normalRenameDialog (bool) –

New in version NX10.0.0.

License requirements: prog_die_wizard (“UG/Progressive Die Wizard”)

OrientationReferenceCSYS¶

GeneralInsertBuilder.OrientationReferenceCSYS¶

Returns or sets the reference CSYS orientation

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

Getter Method

Signature OrientationReferenceCSYS

Returns:
Return type:	`NXOpen.Matrix3x3`

New in version NX11.0.0.

License requirements: None.

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

Setter Method

Signature OrientationReferenceCSYS

Parameters:	matrix (`NXOpen.Matrix3x3`) –

New in version NX11.0.0.

License requirements: prog_die_wizard (“UG/Progressive Die Wizard”)

OuterProfile¶

GeneralInsertBuilder.OuterProfile¶

Returns the outer profile

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

Getter Method

Signature OuterProfile

Returns:
Return type:	`NXOpen.Section`

New in version NX10.0.0.

License requirements: None.

ParentPart¶

GeneralInsertBuilder.ParentPart¶

Returns or sets the parent part

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

Getter Method

Signature ParentPart

Returns:
Return type:	`NXOpen.Tooling.GeneralInsertBuilderParentOption`

New in version NX10.0.0.

License requirements: None.

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

Setter Method

Signature ParentPart

Parameters:	parentPart (`NXOpen.Tooling.GeneralInsertBuilderParentOption`) –

New in version NX10.0.0.

License requirements: prog_die_wizard (“UG/Progressive Die Wizard”)

ParentPartName¶

GeneralInsertBuilder.ParentPartName¶

Returns or sets the parent part name of parent part

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

Getter Method

Signature ParentPartName

Returns:
Return type:	str

New in version NX10.0.0.

License requirements: None.

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

Setter Method

Signature ParentPartName

Parameters:	parentPartName (str) –

New in version NX10.0.0.

License requirements: prog_die_wizard (“UG/Progressive Die Wizard”)

PositiveX¶

GeneralInsertBuilder.PositiveX¶

Returns the positive x

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

Getter Method

Signature PositiveX

Returns:
Return type:	`NXOpen.Expression`

New in version NX10.0.0.

License requirements: None.

PositiveY¶

GeneralInsertBuilder.PositiveY¶

Returns the positive y

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

Getter Method

Signature PositiveY

Returns:
Return type:	`NXOpen.Expression`

New in version NX10.0.0.

License requirements: None.

PositiveZ¶

GeneralInsertBuilder.PositiveZ¶

Returns the positive z

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

Getter Method

Signature PositiveZ

Returns:
Return type:	`NXOpen.Expression`

New in version NX10.0.0.

License requirements: None.

Radius¶

GeneralInsertBuilder.Radius¶

Returns the radius

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

Getter Method

Signature Radius

Returns:
Return type:	`NXOpen.Expression`

New in version NX10.0.0.

License requirements: None.

ReverseInsertDirection¶

GeneralInsertBuilder.ReverseInsertDirection¶

Returns or sets the reverse insert direction

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

Getter Method

Signature ReverseInsertDirection

Returns:
Return type:	bool

New in version NX10.0.0.

License requirements: None.

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

Setter Method

Signature ReverseInsertDirection

Parameters:	reverseInsertDirection (bool) –

New in version NX10.0.0.

License requirements: prog_die_wizard (“UG/Progressive Die Wizard”)

SelectFace¶

GeneralInsertBuilder.SelectFace¶

Returns the select face

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

Getter Method

Signature SelectFace

Returns:
Return type:	`NXOpen.SelectFaceList`

New in version NX10.0.0.

License requirements: None.

SettingWithoutFalseBody¶

GeneralInsertBuilder.SettingWithoutFalseBody¶

Returns or sets the setting without false body

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

Getter Method

Signature SettingWithoutFalseBody

Returns:
Return type:	bool

New in version NX10.0.0.

License requirements: None.

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

Setter Method

Signature SettingWithoutFalseBody

Parameters:	settingWithoutFalseBody (bool) –

New in version NX10.0.0.

License requirements: prog_die_wizard (“UG/Progressive Die Wizard”)

StartPosition¶

GeneralInsertBuilder.StartPosition¶

Returns the start position

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

Getter Method

Signature StartPosition

Returns:
Return type:	`NXOpen.Expression`

New in version NX10.0.0.

License requirements: None.

Type¶

GeneralInsertBuilder.Type¶

Returns or sets the operation type of general insert.

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

Getter Method

Signature Type

Returns:
Return type:	`NXOpen.Tooling.GeneralInsertBuilderTypes`

New in version NX10.0.0.

License requirements: None.

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

Setter Method

Signature Type

Parameters:	type (`NXOpen.Tooling.GeneralInsertBuilderTypes`) –

New in version NX10.0.0.

License requirements: prog_die_wizard (“UG/Progressive Die Wizard”)

UserDefinedExtrudeDirection¶

GeneralInsertBuilder.UserDefinedExtrudeDirection¶

Returns or sets the user defined extrude direction

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

Getter Method

Signature UserDefinedExtrudeDirection

Returns:
Return type:	`NXOpen.Vector3d`

New in version NX11.0.1.

License requirements: None.

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

Setter Method

Signature UserDefinedExtrudeDirection

Parameters:	direction (`NXOpen.Vector3d`) –

New in version NX11.0.1.

License requirements: prog_die_wizard (“UG/Progressive Die Wizard”)

WizardType¶

GeneralInsertBuilder.WizardType¶

Returns or sets the wizard type

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

Getter Method

Signature WizardType

Returns:
Return type:	int

New in version NX10.0.0.

License requirements: None.

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

Setter Method

Signature WizardType

Parameters:	wizardType (int) –

New in version NX10.0.0.

License requirements: prog_die_wizard (“UG/Progressive Die Wizard”)

Method Detail¶

AddFromSpreadsheetAttributeList¶

GeneralInsertBuilder.AddFromSpreadsheetAttributeList¶

Move attribute from Attribute from Spreadsheet to Attribute of Object

Signature AddFromSpreadsheetAttributeList()

New in version NX10.0.0.

License requirements: None.

CreateDatum¶

GeneralInsertBuilder.CreateDatum¶

Create datum on selected face

Signature CreateDatum()

New in version NX10.0.0.

License requirements: None.

CreateUserDefinedInsert¶

GeneralInsertBuilder.CreateUserDefinedInsert¶

Creates user defined insert.

The refset defines the insert which is TRUE or FALSE body

Signature CreateUserDefinedInsert(refset)

Parameters:	refset (str) –

New in version NX10.0.0.

License requirements: None.

DeleteAttribute¶

GeneralInsertBuilder.DeleteAttribute¶

Remove attribute from Attribute of Object

Signature DeleteAttribute()

New in version NX10.0.0.

License requirements: None.

GetAttributeTitleName¶

GeneralInsertBuilder.GetAttributeTitleName¶

Returns the title name of Attribute Of Object Tree list

Signature GetAttributeTitleName()

Returns:	the list of title
Return type:	list of str

New in version NX10.0.0.

License requirements: None.

GetAttributeValueText¶

GeneralInsertBuilder.GetAttributeValueText¶

Returns the value text of Attribute Of Object Tree list

Signature GetAttributeValueText()

Returns:	the list of title
Return type:	list of str

New in version NX10.0.0.

License requirements: None.

NewAttribute¶

GeneralInsertBuilder.NewAttribute¶

Create new attribute in Attribute of Object

Signature NewAttribute()

New in version NX10.0.0.

License requirements: None.

SetAttributeTitleName¶

GeneralInsertBuilder.SetAttributeTitleName¶

Sets the title name of Attribute Of Object Tree list

Signature SetAttributeTitleName(titleName)

Parameters:	titleName (list of str) – the list of title

New in version NX10.0.0.

License requirements: prog_die_wizard (“UG/Progressive Die Wizard”)

SetAttributeValueText¶

GeneralInsertBuilder.SetAttributeValueText¶

Sets the title name of Attribute Of Object Tree list

Signature SetAttributeValueText(valueText)

Parameters:	valueText (list of str) – the list of title

New in version NX10.0.0.

License requirements: prog_die_wizard (“UG/Progressive Die Wizard”)

Validate¶

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