SpaceReservationBuilder Class¶
-
class
NXOpen.Routing.SpaceReservationBuilder¶ Bases:
NXOpen.BuilderRepresents a
NXOpen.Routing.SpaceReservationBuilderThis builder takes one or more segments and creates space reservation stock on it.
To create a new instance of this class, use
NXOpen.Routing.RouteManager.CreateSpaceReservationBuilder()New in version NX6.0.0.
Properties¶
| Property | Description |
|---|---|
| GridTopologyEligibilityFlag | Returns or sets the grid topology eligibility flag. |
| SegmentCollector | Returns the routing segment collector |
| StockSettings | Returns the stock settings for creating space reservation stock |
| 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¶
GridTopologyEligibilityFlag¶
-
SpaceReservationBuilder.GridTopologyEligibilityFlag¶ Returns or sets the grid topology eligibility flag.
When this flag is set, a non circular space reservation will produce bend faces in the bend regions instead of merged faces. This flag has no effect on space reservation.
-------------------------------------Getter Method
Signature
GridTopologyEligibilityFlagReturns: Return type: bool New in version NX10.0.3.
License requirements: routing_base (“Routing Basic”)
-------------------------------------Setter Method
Signature
GridTopologyEligibilityFlagParameters: gridOptionEligible (bool) – New in version NX10.0.3.
License requirements: routing_base (“Routing Basic”)
SegmentCollector¶
-
SpaceReservationBuilder.SegmentCollector¶ Returns the routing segment collector
-------------------------------------Getter Method
Signature
SegmentCollectorReturns: Return type: NXOpen.Routing.RouteObjectCollectorNew in version NX6.0.0.
License requirements: routing_base (“Routing Basic”)
StockSettings¶
-
SpaceReservationBuilder.StockSettings¶ Returns the stock settings for creating space reservation stock
-------------------------------------Getter Method
Signature
StockSettingsReturns: Return type: NXOpen.Routing.PathStockBuilderNew in version NX6.0.0.
License requirements: routing_base (“Routing Basic”)
Method Detail¶
Validate¶
-
SpaceReservationBuilder.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.