NXOpen::AME::ProductSelectionBuilder Class Reference

JA class for Product Selection dialog
To create a new instance of this class, use NXOpen::AME::AMEManager::CreateProductSelectionBuilder
Default values. More...

Inheritance diagram for NXOpen::AME::ProductSelectionBuilder:

Public Types
enum	Type { TypeSameEngineeringObjectDefinition, TypeSameClassificationAndMoreDetailedClassification, TypeAllCommonProducts }
	the product type for product selection More...

Public Member Functions
bool	BreakUnLockedTemplate ()
	Returns the option to exchange product by breaking unlocked template Created in NX12.0.0. More...
bool	ExchangePLCRelevantProduct ()
	Returns the option to exchange plc relevant product Created in NX12.0.0. More...
bool	ExchangeProductForNotLockedTemplate ()
	Returns the option to exchange product for device which are not members of locked template Created in NX12.0.0. More...
bool	PlaceInProductAspect ()
	Returns the option to create product aspect for device if not available Created in NX12.0.0. More...
NXOpen::AME::ProductSelectionBuilder::Type	ProductType ()
	Returns the product type for product selection Created in NX11.0.0. More...
bool	RemovePLCRelevantProduct ()
	Returns the option to remove plc relevant product Created in NX12.0.0. More...
NXOpen::AME::SelectClassificationBuilder *	SelectClassification ()
	Returns the selected classification Created in NX12.0.0. More...
NXOpen::SelectNXObjectList *	SelectedDevices ()
	Returns the selected devices Created in NX12.0.0. More...
void	SetAuxiliaryProducts (const std::vector< NXOpen::AME::ProductDefinition * > &auxiliaryProducts)
	Set auxiliary product details Created in NX12.0.0. More...
void	SetBreakUnLockedTemplate (bool breakUnLockedTemplate)
	Sets the option to exchange product by breaking unlocked template Created in NX12.0.0. More...
void	SetExchangePLCRelevantProduct (bool exchangePLCRelevantProduct)
	Sets the option to exchange plc relevant product Created in NX12.0.0. More...
void	SetExchangeProductForNotLockedTemplate (bool exchangeProductForNotLockedTemplate)
	Sets the option to exchange product for device which are not members of locked template Created in NX12.0.0. More...
void	SetPlaceInProductAspect (bool placeInProductAspect)
	Sets the option to create product aspect for device if not available Created in NX12.0.0. More...
void	SetProductType (NXOpen::AME::ProductSelectionBuilder::Type productType)
	Sets the product type for product selection Created in NX11.0.0. More...
void	SetRemovePLCRelevantProduct (bool removePLCRelevantProduct)
	Sets the option to remove plc relevant product Created in NX12.0.0. More...
void	SetSelectedProduct (NXOpen::AME::ProductDefinition *selectedProduct)
	Set selected product Created in NX11.0.0. More...
Public Member Functions inherited from NXOpen::Builder
NXOpen::NXObject *	Commit ()
	Commits any edits that have been applied to the builder. More...
void	Destroy ()
	Deletes the builder, and cleans up any objects created by the builder. More...
std::vector< NXOpen::NXObject * >	GetCommittedObjects ()
	For builders that create more than one object, this method returns the objects that are created by commit. More...
NXOpen::NXObject *	GetObject ()
	Returns the object currently being edited by this builder. More...
void	ShowResults ()
	Updates the model to reflect the result of an edit to the model for all builders that support showing results. More...
virtual bool	Validate ()
	Validate whether the inputs to the component are sufficient for commit to be called. More...
Public Member Functions inherited from NXOpen::TaggedObject
tag_t	Tag () const
	Returns the tag of this object. More...

Detailed Description

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

Created in NX11.0.0.

Member Enumeration Documentation

enum NXOpen::AME::ProductSelectionBuilder::Type

the product type for product selection

Enumerator
TypeSameEngineeringObjectDefinition	same engineering object definition
TypeSameClassificationAndMoreDetailedClassification	same classification and more detailed classification
TypeAllCommonProducts	all common products

Member Function Documentation

bool NXOpen::AME::ProductSelectionBuilder::BreakUnLockedTemplate

(

)

Returns the option to exchange product by breaking unlocked template
Created in NX12.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

bool NXOpen::AME::ProductSelectionBuilder::ExchangePLCRelevantProduct

(

)

Returns the option to exchange plc relevant product
Created in NX12.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

bool NXOpen::AME::ProductSelectionBuilder::ExchangeProductForNotLockedTemplate

(

)

Returns the option to exchange product for device which are not members of locked template
Created in NX12.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

bool NXOpen::AME::ProductSelectionBuilder::PlaceInProductAspect

(

)

Returns the option to create product aspect for device if not available
Created in NX12.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

NXOpen::AME::ProductSelectionBuilder::Type NXOpen::AME::ProductSelectionBuilder::ProductType

(

)

Returns the product type for product selection
Created in NX11.0.0.

License requirements : None

bool NXOpen::AME::ProductSelectionBuilder::RemovePLCRelevantProduct

(

)

Returns the option to remove plc relevant product
Created in NX12.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

NXOpen::AME::SelectClassificationBuilder* NXOpen::AME::ProductSelectionBuilder::SelectClassification

(

)

Returns the selected classification
Created in NX12.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

NXOpen::SelectNXObjectList* NXOpen::AME::ProductSelectionBuilder::SelectedDevices

(

)

Returns the selected devices
Created in NX12.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

void NXOpen::AME::ProductSelectionBuilder::SetAuxiliaryProducts

(

const std::vector< NXOpen::AME::ProductDefinition * > &

auxiliaryProducts

)

Set auxiliary product details
Created in NX12.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters

auxiliaryProducts

auxiliaryproducts

void NXOpen::AME::ProductSelectionBuilder::SetBreakUnLockedTemplate

(

bool

breakUnLockedTemplate

)

Sets the option to exchange product by breaking unlocked template
Created in NX12.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters

breakUnLockedTemplate

breakunlockedtemplate

void NXOpen::AME::ProductSelectionBuilder::SetExchangePLCRelevantProduct

(

bool

exchangePLCRelevantProduct

)

Sets the option to exchange plc relevant product
Created in NX12.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters

exchangePLCRelevantProduct

exchangeplcrelevantproduct

void NXOpen::AME::ProductSelectionBuilder::SetExchangeProductForNotLockedTemplate

(

bool

exchangeProductForNotLockedTemplate

)

Sets the option to exchange product for device which are not members of locked template
Created in NX12.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters

exchangeProductForNotLockedTemplate

exchangeproductfornotlockedtemplate

void NXOpen::AME::ProductSelectionBuilder::SetPlaceInProductAspect

(

bool

placeInProductAspect

)

Sets the option to create product aspect for device if not available
Created in NX12.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters

placeInProductAspect

placeinproductaspect

void NXOpen::AME::ProductSelectionBuilder::SetProductType

(

NXOpen::AME::ProductSelectionBuilder::Type

productType

)

Sets the product type for product selection
Created in NX11.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters

productType

producttype

void NXOpen::AME::ProductSelectionBuilder::SetRemovePLCRelevantProduct

(

bool

removePLCRelevantProduct

)

Sets the option to remove plc relevant product
Created in NX12.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters

removePLCRelevantProduct

removeplcrelevantproduct

void NXOpen::AME::ProductSelectionBuilder::SetSelectedProduct

(

NXOpen::AME::ProductDefinition *

selectedProduct

)

Set selected product
Created in NX11.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters

selectedProduct

selectedproduct

---

The documentation for this class was generated from the following file:

• AME_ProductSelectionBuilder.hxx