InsertObjectBuilder Class

class NXOpen.AME.InsertObjectBuilder

Bases: NXOpen.Builder

JA class for Insert Object dialog

To create a new instance of this class, use NXOpen.AME.AMEManager.CreateInsertObjectBuilder()

New in version NX12.0.0.

Properties

Property Description
BaseDefAttributeHolder Returns the base definition attribute holder
NameIndex Returns the name, index and description
SelectedBaseDefinition Returns the selection base definition
Tag Returns the Tag for this object.

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.
GetObject Returns the object currently being edited by this builder.
GetUniqueNameUnderParent Gets unique name under parent
SetDefaultsOnBaseDefinitionAttributeHolder Set default properties on base def attr holder
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

BaseDefAttributeHolder

InsertObjectBuilder.BaseDefAttributeHolder

Returns the base definition attribute holder

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

Getter Method

Signature BaseDefAttributeHolder

Returns:
Return type:NXOpen.AME.BaseDefinitionAttributeHolder

New in version NX12.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

NameIndex

InsertObjectBuilder.NameIndex

Returns the name, index and description

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

Getter Method

Signature NameIndex

Returns:
Return type:NXOpen.AME.ObjectNameIndexBuilder

New in version NX12.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

SelectedBaseDefinition

InsertObjectBuilder.SelectedBaseDefinition

Returns the selection base definition

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

Getter Method

Signature SelectedBaseDefinition

Returns:
Return type:NXOpen.AME.SelectionBaseDefinitionBuilder

New in version NX12.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

Method Detail

GetUniqueNameUnderParent

InsertObjectBuilder.GetUniqueNameUnderParent

Gets unique name under parent

Signature GetUniqueNameUnderParent(nameBase)

Parameters:nameBase (str) –
Returns:
Return type:str

New in version NX12.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

SetDefaultsOnBaseDefinitionAttributeHolder

InsertObjectBuilder.SetDefaultsOnBaseDefinitionAttributeHolder

Set default properties on base def attr holder

Signature SetDefaultsOnBaseDefinitionAttributeHolder()

New in version NX12.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

Validate

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