ProductSelectionBuilder Class

class NXOpen.AME.ProductSelectionBuilder

Bases: NXOpen.Builder

JA class for Product Selection dialog

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

Default values.

Property	Value
ProductType	SameEngineeringObjectDefinition

New in version NX11.0.0.

Properties

Property	Description
BreakUnLockedTemplate	Returns or sets the option to exchange product by breaking unlocked template
ExchangePLCRelevantProduct	Returns or sets the option to exchange plc relevant product
ExchangeProductForNotLockedTemplate	Returns or sets the option to exchange product for device which are not members of locked template
PlaceInProductAspect	Returns or sets the option to create product aspect for device if not available
ProductType	Returns or sets the product type for product selection
RemovePLCRelevantProduct	Returns or sets the option to remove plc relevant product
SelectClassification	Returns the selected classification
SelectedDevices	Returns the selected devices
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.
SetAuxiliaryProducts	Set auxiliary product details
SetSelectedProduct	Set selected product
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

ProductSelectionBuilderType Enumeration

the product type for product selection

Property Detail

BreakUnLockedTemplate

ProductSelectionBuilder.BreakUnLockedTemplate

Returns or sets the option to exchange product by breaking unlocked template

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

Getter Method

Signature BreakUnLockedTemplate

Returns: Return type:bool

New in version NX12.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

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

Setter Method

Signature BreakUnLockedTemplate

Parameters:breakUnLockedTemplate (bool) –

New in version NX12.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

ExchangePLCRelevantProduct

ProductSelectionBuilder.ExchangePLCRelevantProduct

Returns or sets the option to exchange plc relevant product

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

Getter Method

Signature ExchangePLCRelevantProduct

Returns: Return type:bool

New in version NX12.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

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

Setter Method

Signature ExchangePLCRelevantProduct

Parameters:exchangePLCRelevantProduct (bool) –

New in version NX12.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

ExchangeProductForNotLockedTemplate

ProductSelectionBuilder.ExchangeProductForNotLockedTemplate

Returns or sets the option to exchange product for device which are not members of locked template

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

Getter Method

Signature ExchangeProductForNotLockedTemplate

Returns: Return type:bool

New in version NX12.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

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

Setter Method

Signature ExchangeProductForNotLockedTemplate

Parameters:exchangeProductForNotLockedTemplate (bool) –

New in version NX12.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

PlaceInProductAspect

ProductSelectionBuilder.PlaceInProductAspect

Returns or sets the option to create product aspect for device if not available

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

Getter Method

Signature PlaceInProductAspect

Returns: Return type:bool

New in version NX12.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

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

Setter Method

Signature PlaceInProductAspect

Parameters:placeInProductAspect (bool) –

New in version NX12.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

ProductType

ProductSelectionBuilder.ProductType

Returns or sets the product type for product selection

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

Getter Method

Signature ProductType

Returns: Return type:NXOpen.AME.ProductSelectionBuilderType

New in version NX11.0.0.

License requirements: None.

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

Setter Method

Signature ProductType

Parameters:productType (NXOpen.AME.ProductSelectionBuilderType) –

New in version NX11.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

RemovePLCRelevantProduct

ProductSelectionBuilder.RemovePLCRelevantProduct

Returns or sets the option to remove plc relevant product

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

Getter Method

Signature RemovePLCRelevantProduct

Returns: Return type:bool

New in version NX12.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

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

Setter Method

Signature RemovePLCRelevantProduct

Parameters:removePLCRelevantProduct (bool) –

New in version NX12.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

SelectClassification

ProductSelectionBuilder.SelectClassification

Returns the selected classification

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

Getter Method

Signature SelectClassification

Returns: Return type:NXOpen.AME.SelectClassificationBuilder

New in version NX12.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

SelectedDevices

ProductSelectionBuilder.SelectedDevices

Returns the selected devices

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

Getter Method

Signature SelectedDevices

Returns: Return type:NXOpen.SelectNXObjectList

New in version NX12.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

Method Detail

SetAuxiliaryProducts

ProductSelectionBuilder.SetAuxiliaryProducts

Set auxiliary product details

Signature SetAuxiliaryProducts(auxiliaryProducts)

Parameters:auxiliaryProducts (list of NXOpen.AME.ProductDefinition) –

New in version NX12.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

SetSelectedProduct

ProductSelectionBuilder.SetSelectedProduct

Set selected product

Signature SetSelectedProduct(selectedProduct)

Parameters:selectedProduct (NXOpen.AME.ProductDefinition) –

New in version NX11.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

Validate

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