Parameters of a nearest resource computation (calculateNearestResources).
Inherits from RequestBase.
Field name |
Type |
Default value |
Comments |
|---|---|---|---|
position |
|
Position, used for distance computation to the resources |
|
resources |
List of Resource |
null |
Additional resources, used for computations. If the resources have a special speed profile, use VehicleResource. |
useResourcesFromDB |
Boolean |
true |
True, if the resources from the database should be loaded and used. Only available if database resources are defined. |
resourceTypes |
Set of String |
null |
Filter: String representations of the searched resources. To include unknown types add an empty string. Empty list for all. |
resourceStatuses |
Set of String |
null |
Filter: String representations of the statuses of the searched resources. To include unknown statuses add an empty string. Empty list for all. |
optimization |
Time |
Optimization (minimal time or way), used for routing |
|
inverseRouting |
Boolean |
true |
Routing direction: •false - from position to resources •true - from resources to position (One-way streets and other non-symmetrical street parameters causes different results for the two variants.) |
maxTravelTime |
Double |
0 |
Maximum travel time to resource (in seconds). 0 for unlimited. |
maxDistance |
Double |
0 |
Maximum distance to resource (in meters). 0 for unlimited. |
maxCount |
Integer |
0 |
Maximum count of returned resources. 0 for unlimited. |
defaultRoadwaySystemParameters |
default values |
Vehicle and street parameters (VehicleResource used, if no special parameters are given for the resource.) |
|
useStraightLineDistance |
Boolean |
false |
No routing, using the straight-line distance. Parameters inverseRouting, roadwaySystemParameters, optimization, includeRouteCoordinates and maxTravelTime are ignored. |
includeRouteCoordinates |
Boolean |
true |
Include route coordinates in response |
includeRouteDescription |
Boolean |
false |
Include route description (verbal description of the route) in response |
includeStructuredRouteDescription |
Boolean |
false |
Include route description (structured) in response |
includeStreetSectionsIds |
Boolean |
false |
Include the street sections ID of the computed route in response |
© 2020, Fraunhofer IVI