From 21f15f0a2916531eb8d962ab2d7aea699d2ad781 Mon Sep 17 00:00:00 2001 From: Patrick Niklaus Date: Wed, 16 Aug 2017 21:01:23 +0000 Subject: [PATCH] Add docs for lua profiles --- docs/profiles.md | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/docs/profiles.md b/docs/profiles.md index 28a0947b2..ee3d5e288 100644 --- a/docs/profiles.md +++ b/docs/profiles.md @@ -104,6 +104,16 @@ max_speed_for_map_matching | Float | Maximum vehicle speed to be as max_turn_weight | Float | Maximum turn penalty weight force_split_edges | Boolean | True value forces a split of forward and backward edges of extracted ways and guarantees that `process_segment` will be called for all segments (default `false`) +The following additional global properties can be set in the hash you return in the `setup` function: + +Attribute | Type | Notes +-------------------------------------|------------------|---------------------------------------------------------------------------- +excludable | Sequence of Sets | Determines which class-combinations are supported by the `exclude` option at query time. + | | E.g. `Sequence{Set{"ferry", "motorway"}, Set{"motorway"}}` will allow you to exclude ferries and motorways, or only motorways. +classes | Set | Determines the allowed classes that can be referenced using `{forward,backward}_classes` on the way in the `process_way` function. +restrictions | Set | Determines which turn restrictions will be used for this profile. +suffix_list | Set | List of name suffixes needed for determining if "Highway 101 NW" the same road as "Highway 101 ES". + ### process_node(profile, node, result) Process an OSM node to determine whether this node is a barrier or can be passed and whether passing it incurs a delay. @@ -272,4 +282,4 @@ durationIsValid parseDuration trimLaneString applyAccessTokens -canonicalizeStringList \ No newline at end of file +canonicalizeStringList