A PathSearchRequest describes a routing request from a source obstacle to a target obstacle which is handled and considered during the path search phase of the EdgeRouter.
Inheritance Hierarchy
Remarks
The path that is searched for an edge is potentially split into multiple requests. The path finding algorithm finds a path for each request and, finally, the results are put together to a final, full path for the actual edge. Multiple requests are introduced, for example, to model intermediate routing points.
This class cannot be instantiated
Members
No filters for this type
Properties
Gets the EdgeRouterEdgeDescriptor that describes routing settings for this path request.
Gets the EdgeRouterEdgeDescriptor that describes routing settings for this path request.
When implementing PathSearchExtensions and using descriptor settings, always query this descriptor belonging to the current request. It may be different from the one originally registered for the edge when there are multiple PathSearchRequests for an edge.
readonlyfinal
Property Value
the EdgeRouterEdgeDescriptor of this path request
Gets the path that was found for this path request.
Gets the path that was found for this path request.
readonlyfinal
Property Value
the path found for this request or
null if none was found yetGets the source obstacle describing the area where this request starts.
Gets the source obstacle describing the area where this request starts.
readonlyfinal
Property Value
the source obstacle of this request
Gets the source LayoutPortCandidates associated with this path request and describing how the path must connect to the source obstacle.
Gets the source LayoutPortCandidates associated with this path request and describing how the path must connect to the source obstacle.
Gets the target obstacle describing the area where this request ends.
Gets the target obstacle describing the area where this request ends.
readonlyfinal
Property Value
the target obstacle of this request
Gets the target LayoutPortCandidates associated with this path request and describing how the path must connect to the target obstacle.
Gets the target LayoutPortCandidates associated with this path request and describing how the path must connect to the target obstacle.