pietervdvn/AspectedRouting
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Update of documentation

Browse source
This commit is contained in:
Pieter Vander Vennet 2022-10-17 11:24:54 +02:00
parent 6746f96b91
commit 7f34dafc1a
1 changed files with 6 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

7
Examples/Format.md
View file

@ -20,7 +20,7 @@ Aspects can use the following (extra) tags:
- Metdata: these tags will be copied to the routerdb, but can not be used for routeplanning. A prime example is `name` (the streetname), as it is useful for routeplanning but very useful for navigation afterwards - Metdata: these tags will be copied to the routerdb, but can not be used for routeplanning. A prime example is `name` (the streetname), as it is useful for routeplanning but very useful for navigation afterwards
- vehicletypes: used for turn restrictions, legacy for use with itinero 1.0 - vehicletypes: used for turn restrictions, legacy for use with itinero 1.0
- defaults: a dictionary of `{"#paramName": "value"}`, used in determining the weight of an edge. note: the `#` has to be included - defaults: a dictionary of `{"#paramName": "value"}`, used in determining the weight of an edge. note: the `#` has to be included
- `access` is a field in the vehicle file. It should be an expression returning a string. If (and only if) this string is `no`, the way will be marked as not accessible and no more values will be calculated. All other values are regarded as being accessible. When calculated, the tag `access` with the calculated value is written into the tag table or the other aspects to use. - `access` is a field in the vehicle file. It should be an expression returning a string. If (and only if) this string is `no`, the way will be marked as not accessible and no more values will be calculated. All other values are regarded as being accessible. When calculated, the tag `access` with the calculated value is written into the tag table for the other aspects to use.
- `oneway` is a field in the vehicle file. It should be an expression returning `both`, `with` or `against`. - `oneway` is a field in the vehicle file. It should be an expression returning `both`, `with` or `against`.
When calculated, the tag `oneway` is added to the tags for the other aspects to be calculated. When calculated, the tag `oneway` is added to the tags for the other aspects to be calculated.
- `speed`: an expression indicating how fast the vehicle can go there. It should take into account legal, practical and social aspects. An example expression could be `{"$min", ["$legal_maxspeed", "#defaultspeed"]}` - `speed`: an expression indicating how fast the vehicle can go there. It should take into account legal, practical and social aspects. An example expression could be `{"$min", ["$legal_maxspeed", "#defaultspeed"]}`
@ -28,6 +28,11 @@ Aspects can use the following (extra) tags:
- `priorities`: a table of `{'#paramName', expression}` determining the priority (1/cost) of a way, per meter. The formula used is `paramName * expression + paramName0 * expression0 + ...` (`speed`, `access` and `oneway` can be used here as tags indicate the earlier defined respective aspects). Use a weight == 1 to get the shortest route or `$speed` to get the fastest route - `priorities`: a table of `{'#paramName', expression}` determining the priority (1/cost) of a way, per meter. The formula used is `paramName * expression + paramName0 * expression0 + ...` (`speed`, `access` and `oneway` can be used here as tags indicate the earlier defined respective aspects). Use a weight == 1 to get the shortest route or `$speed` to get the fastest route
## Why is `access`, `oneway` and `speed` copied onto the tags?
`speed` is copied in order for the profile to be able to make a `fast` profile (and accessible as `$speed`).
Access is copied so that `highway=cycleway` and `highway=cycleway;bicycle=designated` will render the same result.
# Calculating oneway and forward/backward speeds # Calculating oneway and forward/backward speeds