Skip to content

Commit

Permalink
Deployed 2e1f54b0aa to dev-2.x in en with MkDocs 1.5.3 and mike 1.2.0…
Browse files Browse the repository at this point in the history
….dev0
  • Loading branch information
OTP Bot committed May 14, 2024
1 parent 62a7f5a commit 28516a3
Show file tree
Hide file tree
Showing 6 changed files with 19 additions and 16 deletions.
4 changes: 2 additions & 2 deletions en/dev-2.x/BuildConfiguration/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -3309,7 +3309,7 @@ <h3 id="gd_stationTransferPreference">stationTransferPreference</h3>
<strong>Enum values:</strong> <code>discouraged</code> | <code>allowed</code> | <code>recommended</code> | <code>preferred</code></p>
<p>Should there be some preference or aversion for transfers at stops that are part of a station.</p>
<p>This parameter sets the generic level of preference. What is the actual cost can be changed
with the <code>stopTransferCost</code> parameter in the router configuration.</p>
with the <code>stopBoardAlightDuringTransferCost</code> parameter in the router configuration.</p>
<h3 id="islandPruning_adaptivePruningDistance">adaptivePruningDistance</h3>

<p><strong>Since version:</strong> <code>2.3</code><strong>Type:</strong> <code>integer</code><strong>Cardinality:</strong> <code>Optional</code><strong>Default value:</strong> <code>250</code> <br />
Expand Down Expand Up @@ -3475,7 +3475,7 @@ <h3 id="tf_0_stationTransferPreference">stationTransferPreference</h3>
<strong>Enum values:</strong> <code>discouraged</code> | <code>allowed</code> | <code>recommended</code> | <code>preferred</code></p>
<p>Should there be some preference or aversion for transfers at stops that are part of a station. Overrides the value specified in <code>gtfsDefaults</code>.</p>
<p>This parameter sets the generic level of preference. What is the actual cost can be changed
with the <code>stopTransferCost</code> parameter in the router configuration.</p>
with the <code>stopBoardAlightDuringTransferCost</code> parameter in the router configuration.</p>
<h3 id="tf_1_groupFilePattern">groupFilePattern</h3>

<p><strong>Since version:</strong> <code>2.0</code><strong>Type:</strong> <code>regexp</code><strong>Cardinality:</strong> <code>Optional</code><strong>Default value:</strong> <code>"(\w{3})-.*\.xml"</code> <br />
Expand Down
2 changes: 1 addition & 1 deletion en/dev-2.x/RouteRequest/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -3843,7 +3843,7 @@ <h3 id="rd_to_extraStopBoardAlightCostsFactor">extraStopBoardAlightCostsFactor</
<p><strong>Since version:</strong> <code>2.1</code><strong>Type:</strong> <code>double</code><strong>Cardinality:</strong> <code>Optional</code><strong>Default value:</strong> <code>0.0</code> <br />
<strong>Path:</strong> /routingDefaults/transferOptimization </p>
<p>Add an extra board- and alight-cost for prioritized stops.</p>
<p>A stopBoardAlightCosts is added to the generalized-cost during routing. But this cost
<p>A stopBoardAlightTransferCosts is added to the generalized-cost during routing. But this cost
cannot be too high, because that would add extra cost to the transfer, and favor other
alternative paths. But, when optimizing transfers, we do not have to take other paths
into consideration and can <em>boost</em> the stop-priority-cost to allow transfers to
Expand Down
23 changes: 13 additions & 10 deletions en/dev-2.x/RouterConfiguration/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -2250,9 +2250,9 @@ <h2 id="parameter-summary">Parameter Summary</h2>
<td style="text-align: center;">na</td>
</tr>
<tr>
<td>   <a href="#transit_stopTransferCost">stopTransferCost</a></td>
<td>   <a href="#transit_stopBoardAlightDuringTransferCost">stopBoardAlightDuringTransferCost</a></td>
<td style="text-align: center;"><code>enum map of integer</code></td>
<td>Use this to set a stop transfer cost for the given transfer priority</td>
<td>Costs for boarding and alighting during transfers at stops with a given transfer priority.</td>
<td style="text-align: center;"><em>Optional</em></td>
<td></td>
<td style="text-align: center;">2.0</td>
Expand Down Expand Up @@ -2513,16 +2513,19 @@ <h3 id="transit_pagingSearchWindowAdjustments">pagingSearchWindowAdjustments</h3
and so on. The duration is added to the existing search-window and inserted into the next and
previous page cursor. See JavaDoc for <a href="https://github.com/opentripplanner/OpenTripPlanner/blob/dev-2.x/src/main/java/org/opentripplanner/routing/algorithm/raptor/transit/TransitTuningParameters.java">TransitTuningParameters#pagingSearchWindowAdjustments</a>" +
for more info."</p>
<h3 id="transit_stopTransferCost">stopTransferCost</h3>
<h3 id="transit_stopBoardAlightDuringTransferCost">stopBoardAlightDuringTransferCost</h3>

<p><strong>Since version:</strong> <code>2.0</code><strong>Type:</strong> <code>enum map of integer</code><strong>Cardinality:</strong> <code>Optional</code> <br />
<strong>Path:</strong> /transit <br />
<strong>Enum keys:</strong> <code>discouraged</code> | <code>allowed</code> | <code>recommended</code> | <code>preferred</code></p>
<p>Use this to set a stop transfer cost for the given transfer priority</p>
<p>The cost is applied to boarding and alighting at all stops. All stops have a transfer cost priority
set, the default is <code>allowed</code>. The <code>stopTransferCost</code> parameter is optional, but if listed all
values must be set.</p>
<p>If not set the <code>stopTransferCost</code> is ignored. This is only available for NeTEx imported Stops.</p>
<p>Costs for boarding and alighting during transfers at stops with a given transfer priority.</p>
<p>This cost is applied <strong>both to boarding and alighting</strong> at stops during transfers. All stops have a
transfer cost priority set, the default is <code>allowed</code>. The <code>stopBoardAlightDuringTransferCost</code>
parameter is optional, but if listed all values must be set.</p>
<p>When a transfer occurs at the same stop, the cost will be applied twice since the cost is both for
boarding and alighting,</p>
<p>If not set the <code>stopBoardAlightDuringTransferCost</code> is ignored. This is only available for NeTEx
imported Stops.</p>
<p>The cost is a scalar, but is equivalent to the felt cost of riding a transit trip for 1 second.</p>
<table>
<thead>
Expand Down Expand Up @@ -2556,7 +2559,7 @@ <h3 id="transit_stopTransferCost">stopTransferCost</h3>
</tbody>
</table>
<p>Use values in a range from <code>0</code> to <code>100 000</code>. <strong>All key/value pairs are required if the
<code>stopTransferCost</code> is listed.</strong></p>
<code>stopBoardAlightDuringTransferCost</code> is listed.</strong></p>
<h3 id="transit_transferCacheRequests">transferCacheRequests</h3>

<p><strong>Since version:</strong> <code>2.3</code><strong>Type:</strong> <code>object[]</code><strong>Cardinality:</strong> <code>Optional</code> <br />
Expand Down Expand Up @@ -2764,7 +2767,7 @@ <h2 id="router-config-example">Router Config Example</h2>
<a id="__codelineno-2-170" name="__codelineno-2-170" href="#__codelineno-2-170"></a><span class="w"> </span><span class="nt">&quot;minWindow&quot;</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;1h&quot;</span><span class="p">,</span>
<a id="__codelineno-2-171" name="__codelineno-2-171" href="#__codelineno-2-171"></a><span class="w"> </span><span class="nt">&quot;maxWindow&quot;</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;5h&quot;</span>
<a id="__codelineno-2-172" name="__codelineno-2-172" href="#__codelineno-2-172"></a><span class="w"> </span><span class="p">},</span>
<a id="__codelineno-2-173" name="__codelineno-2-173" href="#__codelineno-2-173"></a><span class="w"> </span><span class="nt">&quot;stopTransferCost&quot;</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="p">{</span>
<a id="__codelineno-2-173" name="__codelineno-2-173" href="#__codelineno-2-173"></a><span class="w"> </span><span class="nt">&quot;stopBoardAlightDuringTransferCost&quot;</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="p">{</span>
<a id="__codelineno-2-174" name="__codelineno-2-174" href="#__codelineno-2-174"></a><span class="w"> </span><span class="nt">&quot;DISCOURAGED&quot;</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="mi">1500</span><span class="p">,</span>
<a id="__codelineno-2-175" name="__codelineno-2-175" href="#__codelineno-2-175"></a><span class="w"> </span><span class="nt">&quot;ALLOWED&quot;</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="mi">75</span><span class="p">,</span>
<a id="__codelineno-2-176" name="__codelineno-2-176" href="#__codelineno-2-176"></a><span class="w"> </span><span class="nt">&quot;RECOMMENDED&quot;</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="mi">30</span><span class="p">,</span>
Expand Down
2 changes: 1 addition & 1 deletion en/dev-2.x/examples/entur/router-config.json
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@
"minWindow" : "1h",
"maxWindow" : "5h"
},
"stopTransferCost" : {
"stopBoardAlightDuringTransferCost" : {
"DISCOURAGED" : 1500,
"ALLOWED" : 75,
"RECOMMENDED" : 30,
Expand Down
2 changes: 1 addition & 1 deletion en/dev-2.x/examples/skanetrafiken/router-config.json
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
"24h",
"0h"
],
"stopTransferCost": {
"stopBoardAlightDuringTransferCost": {
"DISCOURAGED": 3000,
"ALLOWED": 150,
"RECOMMENDED": 60,
Expand Down
2 changes: 1 addition & 1 deletion en/dev-2.x/search/search_index.json

Large diffs are not rendered by default.

0 comments on commit 28516a3

Please sign in to comment.