ManualRouteBuilder Class¶
-
class
NXOpen.Routing.
ManualRouteBuilder
¶ Bases:
NXOpen.Builder
To create a new instance of this class, use
NXOpen.Routing.RouteManager.CreateManualRouteBuilder()
New in version NX7.5.0.
Properties¶
Property | Description |
---|---|
PointList | Returns the point list |
Tag | Returns the Tag for this object. |
Methods¶
Method | Description |
---|---|
Commit | Commits any edits that have been applied to the builder. |
CreateValidPointsOnPaths | This function will get all the paths stored in NXOpen.Routing.ManualRouteBuilder and will create point for any location which lies on any of the paths. |
CyclePaths | Cycle paths through filter paths array to enable user select path for routing. |
Destroy | Deletes the builder, and cleans up any objects created by the builder. |
FindPathsFromMultiplePoints | This function returns all possible paths which are passing through all the given points. |
GetCommittedObjects | For builders that create more than one object, this method returns the objects that are created by commit. |
GetFilterPaths | This function gets filter paths from builder. |
GetHighlightPath | This function returns currently highlighted path stored in builder @return |
GetObject | Returns the object currently being edited by this builder. |
GetPaths | This function returns all possible paths for stockDevice stored in builder. |
SetFilterPaths | |
SetHighlightPath | This function sets highlight path amongst all paths, and this highlight path only will be used for routing the stock device |
ShowResults | Updates the model to reflect the result of an edit to the model for all builders that support showing results. |
UpdateFilterPaths | This function updates the filter paths in builder, using the given selected point. |
Validate | Validate whether the inputs to the component are sufficient for commit to be called. |
Property Detail¶
PointList¶
-
ManualRouteBuilder.
PointList
¶ Returns the point list
-------------------------------------
Getter Method
Signature
PointList()
Returns: Return type: NXOpen.PointList
New in version NX7.5.0.
License requirements: routing_advanced (“Routing Advanced”), routing_base (“Routing Basic”)
Method Detail¶
CreateValidPointsOnPaths¶
-
ManualRouteBuilder.
CreateValidPointsOnPaths
¶ This function will get all the paths stored in
NXOpen.Routing.ManualRouteBuilder
and will create point for any location which lies on any of the paths.Newly created points will be returned as result. It will also return the filter paths found using given locations.
Signature
CreateValidPointsOnPaths(pointLocs)
Parameters: pointLocs (list of NXOpen.Point3d
) –Returns: a tuple Return type: A tuple consisting of (filterPaths, validPoints). filterPaths is a list of NXOpen.Routing.Path
. validPoints is a list ofNXOpen.Point
.New in version NX7.5.0.
License requirements: routing_advanced (“Routing Advanced”), routing_base (“Routing Basic”)
CyclePaths¶
-
ManualRouteBuilder.
CyclePaths
¶ Cycle paths through filter paths array to enable user select path for routing.
Signature
CyclePaths()
New in version NX7.5.0.
License requirements: routing_advanced (“Routing Advanced”), routing_base (“Routing Basic”)
FindPathsFromMultiplePoints¶
-
ManualRouteBuilder.
FindPathsFromMultiplePoints
¶ This function returns all possible paths which are passing through all the given points.
Signature
FindPathsFromMultiplePoints(points)
Parameters: points (list of NXOpen.Point
) –Returns: a tuple Return type: A tuple consisting of (paths, foundPath). paths is a list of NXOpen.Routing.Path
. foundPath is a bool.New in version NX7.5.0.
License requirements: routing_advanced (“Routing Advanced”), routing_base (“Routing Basic”)
GetFilterPaths¶
-
ManualRouteBuilder.
GetFilterPaths
¶ This function gets filter paths from builder.
These paths are those which passes through selected points in point list.
Signature
GetFilterPaths()
Returns: Return type: list of NXOpen.Routing.Path
New in version NX7.5.0.
License requirements: routing_advanced (“Routing Advanced”), routing_base (“Routing Basic”)
GetHighlightPath¶
-
ManualRouteBuilder.
GetHighlightPath
¶ This function returns currently highlighted path stored in builder
Signature
GetHighlightPath()
Returns: Return type: NXOpen.Routing.Path
New in version NX7.5.0.
License requirements: routing_advanced (“Routing Advanced”), routing_base (“Routing Basic”)
GetPaths¶
-
ManualRouteBuilder.
GetPaths
¶ This function returns all possible paths for stockDevice stored in builder.
Signature
GetPaths()
Returns: Return type: list of NXOpen.Routing.Path
New in version NX7.5.0.
License requirements: routing_advanced (“Routing Advanced”), routing_base (“Routing Basic”)
SetFilterPaths¶
-
ManualRouteBuilder.
SetFilterPaths
¶ Signature
SetFilterPaths(filterPaths)
Parameters: filterPaths (list of NXOpen.Routing.Path
) –New in version NX7.5.0.
License requirements: routing_advanced (“Routing Advanced”), routing_base (“Routing Basic”)
SetHighlightPath¶
-
ManualRouteBuilder.
SetHighlightPath
¶ This function sets highlight path amongst all paths, and this highlight path only will be used for routing the stock device
Signature
SetHighlightPath(path)
Parameters: path ( NXOpen.Routing.Path
) –New in version NX7.5.0.
License requirements: routing_advanced (“Routing Advanced”), routing_base (“Routing Basic”)
UpdateFilterPaths¶
-
ManualRouteBuilder.
UpdateFilterPaths
¶ This function updates the filter paths in builder, using the given selected point.
It checks all the filter paths stored in builder, and finds paths passing through given point. Then it updates filter paths accordingly in builder.
Signature
UpdateFilterPaths(point)
Parameters: point ( NXOpen.Point
) –Returns: Return type: bool New in version NX7.5.0.
License requirements: routing_advanced (“Routing Advanced”), routing_base (“Routing Basic”)
Validate¶
-
ManualRouteBuilder.
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.