BaseExplicitOrderBuilder Class¶
-
class
NXOpen.Gateway.BaseExplicitOrderBuilder¶ Bases:
NXOpen.BuilderThis is the
NXOpen.Gateway.BaseExplicitOrderBuilderfor the explicit orderThis is an abstract class, and cannot be instantiated.
New in version NX9.0.0.
Properties¶
| Property | Description |
|---|---|
| SaveName | Returns or sets the save name |
| Tag | Returns the Tag for this object. |
Methods¶
| Method | Description |
|---|---|
| Clear | Clears the current order and restores it to the default order |
| Commit | Commits any edits that have been applied to the builder. |
| Delete | Deletes the saved order/orders that has/have been selected by the user from the list of saved orders @return |
| Destroy | Deletes the builder, and cleans up any objects created by the builder. |
| DownArrow | Moves down the row/rows selected by the user in the lists @return |
| 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. |
| Paste | Pastes the rows that have been previously selected using the cut operation @return |
| Save | Saves an explicit order defined by the user |
| SaveAsTextFile | Saves the selected saved order in the form of a text file |
| ShowResults | Updates the model to reflect the result of an edit to the model for all builders that support showing results. |
| UpArrow | Moves up the row/rows selected by the user in the lists @return |
| Validate | Validate whether the inputs to the component are sufficient for commit to be called. |
Property Detail¶
SaveName¶
-
BaseExplicitOrderBuilder.SaveName¶ Returns or sets the save name
-------------------------------------Getter Method
Signature
SaveName()Returns: Return type: str New in version NX9.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
SaveName(saveName)Parameters: saveName (str) – New in version NX9.0.0.
License requirements: None.
Method Detail¶
Clear¶
-
BaseExplicitOrderBuilder.Clear¶ Clears the current order and restores it to the default order
Signature
Clear()New in version NX9.0.0.
License requirements: None.
Delete¶
-
BaseExplicitOrderBuilder.Delete¶ Deletes the saved order/orders that has/have been selected by the user from the list of saved orders
Signature
Delete(selectedEntries, currentOrder, numOfRemainingEntries)Parameters: - selectedEntries (list of str) –
- currentOrder (list of str) –
- numOfRemainingEntries (int) –
Returns: Return type: list of str
New in version NX9.0.0.
License requirements: None.
DownArrow¶
-
BaseExplicitOrderBuilder.DownArrow¶ Moves down the row/rows selected by the user in the lists
Signature
DownArrow(selectedEntries, currentOrder)Parameters: - selectedEntries (list of str) –
- currentOrder (list of str) –
Returns: Return type: list of str
New in version NX9.0.0.
License requirements: None.
Paste¶
-
BaseExplicitOrderBuilder.Paste¶ Pastes the rows that have been previously selected using the cut operation
Signature
Paste(pastePoint, selectedEntries, currentOrder)Parameters: - pastePoint (int) –
- selectedEntries (list of str) –
- currentOrder (list of str) –
Returns: Return type: list of str
New in version NX9.0.0.
License requirements: None.
Save¶
-
BaseExplicitOrderBuilder.Save¶ Saves an explicit order defined by the user
Signature
Save(orderList, saveName)Parameters: - orderList (list of str) –
- saveName (str) –
New in version NX9.0.0.
License requirements: None.
SaveAsTextFile¶
-
BaseExplicitOrderBuilder.SaveAsTextFile¶ Saves the selected saved order in the form of a text file
Signature
SaveAsTextFile(savedOrderName, saveFileName, overwriteFile)Parameters: - savedOrderName (str) –
- saveFileName (str) –
- overwriteFile (bool) –
New in version NX9.0.0.
License requirements: None.
UpArrow¶
-
BaseExplicitOrderBuilder.UpArrow¶ Moves up the row/rows selected by the user in the lists
Signature
UpArrow(selectedEntries, currentOrder)Parameters: - selectedEntries (list of str) –
- currentOrder (list of str) –
Returns: Return type: list of str
New in version NX9.0.0.
License requirements: None.
Validate¶
-
BaseExplicitOrderBuilder.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.