RunItemsBuilder Class¶
-
class
NXOpen.Routing.
RunItemsBuilder
¶ Bases:
NXOpen.Builder
The builder for creating the list item of RunItems
To create a new instance of this class, use
NXOpen.Routing.DefineRunBuilder.CreateRunItemsBuilder()
New in version NX8.5.0.
Properties¶
Property | Description |
---|---|
CurrentSelectedPort | Returns or sets the ports of FROM/TO item of the run. |
RunItems | Returns the list item of run From/To item |
Tag | Returns the Tag for this object. |
VirtualReferenceId | Returns or sets the virtual reference Id for FROM/TO items of a run. |
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. |
GetVirtualStubItem | A virtual stub item to be used as From/To item. |
SetSelectedItemData | The selected items data of the run |
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. |
Property Detail¶
CurrentSelectedPort¶
-
RunItemsBuilder.
CurrentSelectedPort
¶ Returns or sets the ports of FROM/TO item of the run.
-------------------------------------
Getter Method
Signature
CurrentSelectedPort()
Returns: Return type: NXOpen.TaggedObject
New in version NX8.5.0.
License requirements: routing_advanced (“Routing Advanced”), routing_base (“Routing Basic”)
-------------------------------------
Setter Method
Signature
CurrentSelectedPort(selectedPort)
Parameters: selectedPort ( NXOpen.TaggedObject
) –New in version NX8.5.0.
License requirements: routing_advanced (“Routing Advanced”), routing_base (“Routing Basic”)
RunItems¶
-
RunItemsBuilder.
RunItems
¶ Returns the list item of run From/To item
-------------------------------------
Getter Method
Signature
RunItems()
Returns: Return type: NXOpen.SelectNXObjectList
New in version NX8.5.0.
License requirements: routing_advanced (“Routing Advanced”), routing_base (“Routing Basic”)
VirtualReferenceId¶
-
RunItemsBuilder.
VirtualReferenceId
¶ Returns or sets the virtual reference Id for FROM/TO items of a run.
-------------------------------------
Getter Method
Signature
VirtualReferenceId()
Returns: Return type: str New in version NX8.5.0.
License requirements: routing_advanced (“Routing Advanced”), routing_base (“Routing Basic”)
-------------------------------------
Setter Method
Signature
VirtualReferenceId(virtualRefIdFrom)
Parameters: virtualRefIdFrom (str) – ReferenceId to create a stub item as FROM/TO item of a run. New in version NX8.5.0.
License requirements: routing_advanced (“Routing Advanced”), routing_base (“Routing Basic”)
Method Detail¶
GetVirtualStubItem¶
-
RunItemsBuilder.
GetVirtualStubItem
¶ A virtual stub item to be used as From/To item.
Signature
GetVirtualStubItem(virtualReferenceId)
Parameters: virtualReferenceId (str) – Returns: Return type: NXOpen.TaggedObject
New in version NX8.5.0.
License requirements: routing_advanced (“Routing Advanced”), routing_base (“Routing Basic”)
SetSelectedItemData¶
-
RunItemsBuilder.
SetSelectedItemData
¶ The selected items data of the run
Signature
SetSelectedItemData(scopedObject, referenceId, portName, availablePorts)
Parameters: - scopedObject (
NXOpen.TaggedObject
) – - referenceId (str) –
- portName (str) –
- availablePorts (list of
NXOpen.TaggedObject
) –
New in version NX8.5.0.
License requirements: routing_advanced (“Routing Advanced”), routing_base (“Routing Basic”)
- scopedObject (
Validate¶
-
RunItemsBuilder.
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.