DefineRunBuilder Class¶
-
class
NXOpen.Routing.DefineRunBuilder¶ Bases:
NXOpen.BuilderBuilder Class for DefineRun Object
To create a new instance of this class, use
NXOpen.Routing.RouteManager.CreateDefineRunBuilder()New in version NX8.5.0.
Properties¶
| Property | Description |
|---|---|
| FromItemsList | Returns the FROM items list of the run. |
| MemberItems | Returns the MEMBER items of the run. |
| RunIdentifier | Returns or sets the run identifier |
| RunType | Returns or sets the run type |
| SpecificationOption | Returns or sets the specification of the run. |
| Tag | Returns the Tag for this object. |
| ToItemsList | Returns the TO items list of the run . |
Methods¶
| Method | Description |
|---|---|
| AddMemberItems | Append a member item to the list in the builder for DefineRun |
| Commit | Commits any edits that have been applied to the builder. |
| CreateRunItemsBuilder | Creates a RunItems used to create list item for DefineRun |
| 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. |
| RemoveMemberItems | Remove a member item from the list in the builder for DefineRun |
| ShowResults | Updates the model to reflect the result of an edit to the model for all builders that support showing results. |
| UnifyPath | UnifyPath of the run. |
| Validate | Validate whether the inputs to the component are sufficient for commit to be called. |
Property Detail¶
FromItemsList¶
-
DefineRunBuilder.FromItemsList¶ Returns the FROM items list of the run.
The list consists of
NXOpen.Routing.DefineRunBuilderobjects.-------------------------------------Getter Method
Signature
FromItemsListReturns: Return type: NXOpen.Routing.RunItemsBuilderListNew in version NX8.5.0.
License requirements: routing_advanced (“Routing Advanced”), routing_base (“Routing Basic”)
MemberItems¶
-
DefineRunBuilder.MemberItems¶ Returns the MEMBER items of the run.
-------------------------------------Getter Method
Signature
MemberItemsReturns: Return type: NXOpen.Routing.RouteObjectCollectorNew in version NX8.5.0.
License requirements: routing_advanced (“Routing Advanced”), routing_base (“Routing Basic”)
RunIdentifier¶
-
DefineRunBuilder.RunIdentifier¶ Returns or sets the run identifier
-------------------------------------Getter Method
Signature
RunIdentifierReturns: Return type: str New in version NX8.5.0.
License requirements: routing_advanced (“Routing Advanced”), routing_base (“Routing Basic”)
-------------------------------------Setter Method
Signature
RunIdentifierParameters: runIdentifier (str) – New in version NX8.5.0.
License requirements: routing_advanced (“Routing Advanced”), routing_base (“Routing Basic”)
RunType¶
-
DefineRunBuilder.RunType¶ Returns or sets the run type
-------------------------------------Getter Method
Signature
RunTypeReturns: Return type: str New in version NX8.5.0.
License requirements: routing_advanced (“Routing Advanced”), routing_base (“Routing Basic”)
-------------------------------------Setter Method
Signature
RunTypeParameters: runType (str) – New in version NX8.5.0.
License requirements: routing_advanced (“Routing Advanced”), routing_base (“Routing Basic”)
SpecificationOption¶
-
DefineRunBuilder.SpecificationOption¶ Returns or sets the specification of the run.
-------------------------------------Getter Method
Signature
SpecificationOptionReturns: Return type: str New in version NX8.5.0.
License requirements: routing_advanced (“Routing Advanced”), routing_base (“Routing Basic”)
-------------------------------------Setter Method
Signature
SpecificationOptionParameters: specificationOption (str) – New in version NX8.5.0.
License requirements: routing_advanced (“Routing Advanced”), routing_base (“Routing Basic”)
ToItemsList¶
-
DefineRunBuilder.ToItemsList¶ Returns the TO items list of the run .
The list consists of
NXOpen.Routing.DefineRunBuilderobjects.-------------------------------------Getter Method
Signature
ToItemsListReturns: Return type: NXOpen.Routing.RunItemsBuilderListNew in version NX8.5.0.
License requirements: routing_advanced (“Routing Advanced”), routing_base (“Routing Basic”)
Method Detail¶
AddMemberItems¶
-
DefineRunBuilder.AddMemberItems¶ Append a member item to the list in the builder for DefineRun
Signature
AddMemberItems(memberItem)Parameters: memberItem ( NXOpen.TaggedObject) – run member itemNew in version NX8.5.0.
License requirements: routing_advanced (“Routing Advanced”), routing_base (“Routing Basic”)
CreateRunItemsBuilder¶
-
DefineRunBuilder.CreateRunItemsBuilder¶ Creates a RunItems used to create list item for DefineRun
Signature
CreateRunItemsBuilder()Returns: runItems builder Return type: NXOpen.Routing.RunItemsBuilderNew in version NX8.5.0.
License requirements: routing_advanced (“Routing Advanced”), routing_base (“Routing Basic”)
RemoveMemberItems¶
-
DefineRunBuilder.RemoveMemberItems¶ Remove a member item from the list in the builder for DefineRun
Signature
RemoveMemberItems(memberItems)Parameters: memberItems (list of NXOpen.TaggedObject) – member items to be removed from the run.New in version NX8.5.0.
License requirements: routing_advanced (“Routing Advanced”), routing_base (“Routing Basic”)
UnifyPath¶
-
DefineRunBuilder.UnifyPath¶ UnifyPath of the run.
Signature
UnifyPath()New in version NX8.5.0.
License requirements: routing_advanced (“Routing Advanced”), routing_base (“Routing Basic”)
Validate¶
-
DefineRunBuilder.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.