IntegrateRunsBuilder Class¶
-
class
NXOpen.Routing.
IntegrateRunsBuilder
¶ Bases:
NXOpen.Builder
Builder Class for Integrate Runs Object
To create a new instance of this class, use
NXOpen.Routing.RouteManager.IntegrateRunsBuilder()
Default values.
Property Value RunAttributes FirstRun New in version NX8.0.0.
Properties¶
Property | Description |
---|---|
FirstRun | Returns the first run |
RunAttributes | Returns or sets the run attributes |
RunName | Returns or sets the user mentioned run name for Integrated Run |
SecondRun | Returns the second run |
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. |
ModifyItemsButton | Updates the selected nodes in Specify From/To item tree list to From/To/Member item based on buttonType |
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¶
IntegrateRunsBuilderButton Enumeration | Enums to distinguish callback’s for from/to/member Item buttons |
IntegrateRunsBuilderEnum Enumeration | RunAttributes from which Run |
Property Detail¶
FirstRun¶
-
IntegrateRunsBuilder.
FirstRun
¶ Returns the first run
-------------------------------------
Getter Method
Signature
FirstRun
Returns: Return type: NXOpen.SelectNXObject
New in version NX8.0.0.
License requirements: routing_advanced (“Routing Advanced”), routing_base (“Routing Basic”)
RunAttributes¶
-
IntegrateRunsBuilder.
RunAttributes
¶ Returns or sets the run attributes
-------------------------------------
Getter Method
Signature
RunAttributes
Returns: Return type: NXOpen.Routing.IntegrateRunsBuilderEnum
New in version NX8.0.0.
License requirements: routing_advanced (“Routing Advanced”), routing_base (“Routing Basic”)
-------------------------------------
Setter Method
Signature
RunAttributes
Parameters: runAttributes ( NXOpen.Routing.IntegrateRunsBuilderEnum
) –New in version NX8.0.0.
License requirements: routing_advanced (“Routing Advanced”), routing_base (“Routing Basic”)
RunName¶
-
IntegrateRunsBuilder.
RunName
¶ Returns or sets the user mentioned run name for Integrated Run
-------------------------------------
Getter Method
Signature
RunName
Returns: Return type: str New in version NX8.0.0.
License requirements: routing_advanced (“Routing Advanced”), routing_base (“Routing Basic”)
-------------------------------------
Setter Method
Signature
RunName
Parameters: runName (str) – New in version NX8.0.0.
License requirements: routing_advanced (“Routing Advanced”), routing_base (“Routing Basic”)
SecondRun¶
-
IntegrateRunsBuilder.
SecondRun
¶ Returns the second run
-------------------------------------
Getter Method
Signature
SecondRun
Returns: Return type: NXOpen.SelectNXObject
New in version NX8.0.0.
License requirements: routing_advanced (“Routing Advanced”), routing_base (“Routing Basic”)
Method Detail¶
ModifyItemsButton¶
-
IntegrateRunsBuilder.
ModifyItemsButton
¶ Updates the selected nodes in Specify From/To item tree list to From/To/Member item based on buttonType
Signature
ModifyItemsButton(objects, buttonType)
Parameters: - objects (list of
NXOpen.NXObject
) – object of From/To/Member Items of a Run - buttonType (
NXOpen.Routing.IntegrateRunsBuilderButton
) – Modify the selected nodes to From,To,Member Items
New in version NX8.0.0.
License requirements: routing_advanced (“Routing Advanced”), routing_base (“Routing Basic”)
- objects (list of
Validate¶
-
IntegrateRunsBuilder.
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.