OrderAspectsBuilder Class¶
-
class
NXOpen.AME.
OrderAspectsBuilder
¶ Bases:
NXOpen.Builder
Represents a
OrderAspectsBuilder
for changing the order of NavigatorTo create a new instance of this class, use
NXOpen.AME.AMEManager.CreateOrderAspectsBuilder()
New in version NX11.0.0.
Properties¶
Property | Description |
---|---|
SortFunctionMode | Returns or sets |
SortLocationMode | Returns or sets |
SortProductMode | Returns or sets |
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. |
GetOrder | The order for the aspects |
SetOrder | The order for the aspects |
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¶
OrderAspectsBuilderOrderType Enumeration | possible choices for order of navigator objects |
OrderAspectsBuilderSortType Enumeration | possible choices for sorting of navigator objects in a set |
Property Detail¶
SortFunctionMode¶
-
OrderAspectsBuilder.
SortFunctionMode
¶ Returns or sets
-------------------------------------
Getter Method
Signature
SortFunctionMode
Returns: Return type: NXOpen.AME.OrderAspectsBuilderSortType
New in version NX11.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
-------------------------------------
Setter Method
Signature
SortFunctionMode
Parameters: sort ( NXOpen.AME.OrderAspectsBuilderSortType
) –New in version NX11.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
SortLocationMode¶
-
OrderAspectsBuilder.
SortLocationMode
¶ Returns or sets
-------------------------------------
Getter Method
Signature
SortLocationMode
Returns: Return type: NXOpen.AME.OrderAspectsBuilderSortType
New in version NX11.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
-------------------------------------
Setter Method
Signature
SortLocationMode
Parameters: sort ( NXOpen.AME.OrderAspectsBuilderSortType
) –New in version NX11.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
SortProductMode¶
-
OrderAspectsBuilder.
SortProductMode
¶ Returns or sets
-------------------------------------
Getter Method
Signature
SortProductMode
Returns: Return type: NXOpen.AME.OrderAspectsBuilderSortType
New in version NX11.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
-------------------------------------
Setter Method
Signature
SortProductMode
Parameters: sort ( NXOpen.AME.OrderAspectsBuilderSortType
) –New in version NX11.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
Method Detail¶
GetOrder¶
-
OrderAspectsBuilder.
GetOrder
¶ The order for the aspects
Signature
GetOrder()
Returns: Return type: list of NXOpen.AME.OrderAspectsBuilderOrderType
New in version NX11.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
SetOrder¶
-
OrderAspectsBuilder.
SetOrder
¶ The order for the aspects
Signature
SetOrder(order)
Parameters: order (list of NXOpen.AME.OrderAspectsBuilderOrderType
) –New in version NX11.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
Validate¶
-
OrderAspectsBuilder.
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.