SplitRunBuilder Class¶
-
class
NXOpen.Routing.
SplitRunBuilder
¶ Bases:
NXOpen.Builder
Builder Class for Split Run Object
To create a new instance of this class, use
NXOpen.Routing.RouteManager.SplitRunBuilder()
Default values.
Property Value NameToFrom 0 New in version NX8.0.0.
Properties¶
Property | Description |
---|---|
NameToFrom | Returns or sets the new run name to From section or not |
RunName | Returns or sets the user mentioned run name after split |
RunObject | Returns the user selected Run for Split |
SplitObject | Returns the user selected split object |
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. |
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¶
NameToFrom¶
-
SplitRunBuilder.
NameToFrom
¶ Returns or sets the new run name to From section or not
-------------------------------------
Getter Method
Signature
NameToFrom()
Returns: Return type: bool New in version NX8.0.0.
License requirements: routing_advanced (“Routing Advanced”), routing_base (“Routing Basic”)
-------------------------------------
Setter Method
Signature
NameToFrom(nameToFrom)
Parameters: nameToFrom (bool) – New in version NX8.0.0.
License requirements: routing_advanced (“Routing Advanced”), routing_base (“Routing Basic”)
RunName¶
-
SplitRunBuilder.
RunName
¶ Returns or sets the user mentioned run name after split
-------------------------------------
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(runName)
Parameters: runName (str) – New in version NX8.0.0.
License requirements: routing_advanced (“Routing Advanced”), routing_base (“Routing Basic”)
RunObject¶
-
SplitRunBuilder.
RunObject
¶ Returns the user selected Run for Split
-------------------------------------
Getter Method
Signature
RunObject()
Returns: Return type: NXOpen.Routing.SelectRun
New in version NX8.0.0.
License requirements: routing_advanced (“Routing Advanced”), routing_base (“Routing Basic”)
SplitObject¶
-
SplitRunBuilder.
SplitObject
¶ Returns the user selected split object
-------------------------------------
Getter Method
Signature
SplitObject()
Returns: Return type: NXOpen.Routing.RouteObjectCollector
New in version NX8.0.0.
License requirements: routing_advanced (“Routing Advanced”), routing_base (“Routing Basic”)
Method Detail¶
Validate¶
-
SplitRunBuilder.
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.