InstantiateTemplateBulkBuilder Class¶
-
class
NXOpen.AME.
InstantiateTemplateBulkBuilder
¶ Bases:
NXOpen.AME.MultipleObjectsBuilder
JA class for the insert Eng object dialog
To create a new instance of this class, use
NXOpen.AME.AMEManager.CreateInstantiateTemplateBulkBuilder()
Default values.
Property Value InsertSettings.AspectPlacement false InsertSettings.CopiesPerParent 1 ShowInAutomation false ShowInFunction false ShowInLocation false ShowInProduct false New in version NX12.0.0.
Properties¶
Property | Description |
---|---|
AspectDetails | Returns the aspect details ui block |
CopyDocumentStructure | Returns or sets the copy document structure flag to decide whether to copy document structure |
FragmentLocation | Returns or sets the co-ordinate of fragment placement location |
InsertSettings | Returns the aspect placement toggle setting |
PlacementValue | Returns or sets the placement type |
ReuseLibraryItem | Returns the reuse library selection item |
SelectedFragmentTag | Returns or sets the tag of selected fragment object |
SelectedObjects | Returns the select object |
ShowInAutomation | Returns or sets the show in automation |
ShowInFunction | Returns or sets the show in function |
ShowInLocation | Returns or sets the show in location |
ShowInProduct | Returns or sets the show in product |
Tag | Returns the Tag for this object. |
TemplateInstance | Returns the created instance |
UnloadTemplate | Returns or sets the unload template flag to indicate if template should be unloaded after instantiation |
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. |
GetNewObjects | Get the commited Aspect |
GetObject | Returns the object currently being edited by this builder. |
GetProjectFromPartFileName | Get Project from part file |
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¶
InstantiateTemplateBulkBuilderPlacementType Enumeration | Choices for placement type, can be Place in Navigator or Place on Page |
Property Detail¶
AspectDetails¶
-
InstantiateTemplateBulkBuilder.
AspectDetails
¶ Returns the aspect details ui block
-------------------------------------
Getter Method
Signature
AspectDetails
Returns: Return type: NXOpen.AME.AspectDetailsBuilder
New in version NX12.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
CopyDocumentStructure¶
-
InstantiateTemplateBulkBuilder.
CopyDocumentStructure
¶ Returns or sets the copy document structure flag to decide whether to copy document structure
-------------------------------------
Getter Method
Signature
CopyDocumentStructure
Returns: Return type: bool New in version NX12.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
-------------------------------------
Setter Method
Signature
CopyDocumentStructure
Parameters: copyDocumentStructure (bool) – New in version NX12.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
FragmentLocation¶
-
InstantiateTemplateBulkBuilder.
FragmentLocation
¶ Returns or sets the co-ordinate of fragment placement location
-------------------------------------
Getter Method
Signature
FragmentLocation
Returns: Return type: NXOpen.Point2d
New in version NX12.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
-------------------------------------
Setter Method
Signature
FragmentLocation
Parameters: fragmentLocation ( NXOpen.Point2d
) –New in version NX12.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
InsertSettings¶
-
InstantiateTemplateBulkBuilder.
InsertSettings
¶ Returns the aspect placement toggle setting
-------------------------------------
Getter Method
Signature
InsertSettings
Returns: Return type: NXOpen.AME.InsertSettingsBuilder
New in version NX12.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
PlacementValue¶
-
InstantiateTemplateBulkBuilder.
PlacementValue
¶ Returns or sets the placement type
-------------------------------------
Getter Method
Signature
PlacementValue
Returns: Return type: NXOpen.AME.InstantiateTemplateBulkBuilderPlacementType
New in version NX12.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
-------------------------------------
Setter Method
Signature
PlacementValue
Parameters: placementType ( NXOpen.AME.InstantiateTemplateBulkBuilderPlacementType
) –New in version NX12.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
ReuseLibraryItem¶
-
InstantiateTemplateBulkBuilder.
ReuseLibraryItem
¶ Returns the reuse library selection item
-------------------------------------
Getter Method
Signature
ReuseLibraryItem
Returns: Return type: NXOpen.Tooling.SelectReuseLibraryItemBuilder
New in version NX12.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
SelectedFragmentTag¶
-
InstantiateTemplateBulkBuilder.
SelectedFragmentTag
¶ Returns or sets the tag of selected fragment object
-------------------------------------
Getter Method
Signature
SelectedFragmentTag
Returns: Return type: NXOpen.AME.FragmentObject
New in version NX12.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
-------------------------------------
Setter Method
Signature
SelectedFragmentTag
Parameters: selectedFragmentTag ( NXOpen.AME.FragmentObject
) –New in version NX12.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
SelectedObjects¶
-
InstantiateTemplateBulkBuilder.
SelectedObjects
¶ Returns the select object
-------------------------------------
Getter Method
Signature
SelectedObjects
Returns: Return type: NXOpen.AME.SelectAMEBaseNodeList
New in version NX12.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
ShowInAutomation¶
-
InstantiateTemplateBulkBuilder.
ShowInAutomation
¶ Returns or sets the show in automation
-------------------------------------
Getter Method
Signature
ShowInAutomation
Returns: Return type: bool New in version NX12.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
-------------------------------------
Setter Method
Signature
ShowInAutomation
Parameters: showInAutomation (bool) – New in version NX12.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
ShowInFunction¶
-
InstantiateTemplateBulkBuilder.
ShowInFunction
¶ Returns or sets the show in function
-------------------------------------
Getter Method
Signature
ShowInFunction
Returns: Return type: bool New in version NX12.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
-------------------------------------
Setter Method
Signature
ShowInFunction
Parameters: showInFunction (bool) – New in version NX12.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
ShowInLocation¶
-
InstantiateTemplateBulkBuilder.
ShowInLocation
¶ Returns or sets the show in location
-------------------------------------
Getter Method
Signature
ShowInLocation
Returns: Return type: bool New in version NX12.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
-------------------------------------
Setter Method
Signature
ShowInLocation
Parameters: showInLocation (bool) – New in version NX12.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
ShowInProduct¶
-
InstantiateTemplateBulkBuilder.
ShowInProduct
¶ Returns or sets the show in product
-------------------------------------
Getter Method
Signature
ShowInProduct
Returns: Return type: bool New in version NX12.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
-------------------------------------
Setter Method
Signature
ShowInProduct
Parameters: showInProduct (bool) – New in version NX12.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
TemplateInstance¶
-
InstantiateTemplateBulkBuilder.
TemplateInstance
¶ Returns the created instance
-------------------------------------
Getter Method
Signature
TemplateInstance
Returns: Return type: NXOpen.NXObject
New in version NX12.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
UnloadTemplate¶
-
InstantiateTemplateBulkBuilder.
UnloadTemplate
¶ Returns or sets the unload template flag to indicate if template should be unloaded after instantiation
-------------------------------------
Getter Method
Signature
UnloadTemplate
Returns: Return type: bool New in version NX12.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
-------------------------------------
Setter Method
Signature
UnloadTemplate
Parameters: unloadTemplate (bool) – New in version NX12.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
Method Detail¶
GetProjectFromPartFileName¶
-
InstantiateTemplateBulkBuilder.
GetProjectFromPartFileName
¶ Get Project from part file
Signature
GetProjectFromPartFileName()
Returns: Return type: NXOpen.AME.Project
New in version NX12.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
Validate¶
-
InstantiateTemplateBulkBuilder.
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.