Skip to content

Commit

Permalink
add leastDistance as OptimisationMethodEnumeration (#242)
Browse files Browse the repository at this point in the history
  • Loading branch information
ue71603 authored Oct 11, 2022
1 parent 741f33e commit df70e37
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 2 deletions.
7 changes: 6 additions & 1 deletion OJP/OJP_Trips.xsd
Original file line number Diff line number Diff line change
Expand Up @@ -166,13 +166,18 @@
</xs:group>
<xs:simpleType name="OptimisationMethodEnumeration">
<xs:annotation>
<xs:documentation>the types of algorithm that can be used for planning a journey (fastest, least walking, etc).</xs:documentation>
<xs:documentation>the types of algorithm that can be used for planning a journey (fastest, least walking, etc). If multiple optimisation methods are needed, then several requests should be performed in parallel.</xs:documentation>
</xs:annotation>
<xs:restriction base="xs:string">
<xs:enumeration value="fastest"/>
<xs:enumeration value="minChanges"/>
<xs:enumeration value="leastWalking"/>
<xs:enumeration value="leastCost"/>
<xs:enumeration value="leastDistance">
<xs:annotation>
<xs:documentation>Least distance in meter. Mostly used for ALTERNATIVE MODE OF OPERATION</xs:documentation>
</xs:annotation>
</xs:enumeration>
<xs:enumeration value="earliestArrival"/>
<xs:enumeration value="latestDeparture"/>
<xs:enumeration value="earliestArrivalAndLatestDeparture"/>
Expand Down
2 changes: 1 addition & 1 deletion docs/generated/OJP.html
Original file line number Diff line number Diff line change
Expand Up @@ -759,7 +759,7 @@ <h1>OJP - <strong>O</strong>pen API for distributed <strong>J</strong>ourney <st
<!--Group OperatingDaysGroup ──────┘--><!--Group ServiceFacilityGroup ──────┐-->
<!--Group could not be resolved: →siri:ServiceFacilityGroup--><!--======= row--><tr><td class="tableblock halign-left valign-top"><p class="tableblock"/></td><td class="tableblock halign-left valign-top" colspan="2"><p class="tableblock"><code>→‍siri:ServiceFacilityGroup</code></p></td><td class="tableblock halign-left valign-top"><p class="tableblock"/></td><td class="tableblock halign-left valign-top"><p class="tableblock"/></td><td class="tableblock halign-left valign-top"><p class="tableblock"/></td></tr>
<!--Group ServiceFacilityGroup ──────┘--><!--======= row--><tr><td class="tableblock halign-left valign-top"><p class="tableblock"/></td><td class="tableblock halign-left valign-top" colspan="2"><p class="tableblock"><code>JourneyTrack</code></p></td><td class="tableblock halign-left valign-top"><p class="tableblock">0:1</p></td><td class="tableblock halign-left valign-top"><p class="tableblock"><em>+<a href="#LegTrackStructure">LegTrack</a></em></p></td><td class="tableblock halign-left valign-top"><p class="tableblock">Geographic embedding of this journey. The entire journey is regarded as one leg.</p></td></tr><!--======= row--><tr><td class="tableblock halign-left valign-top"><p class="tableblock"/></td><td class="tableblock halign-left valign-top" colspan="2"><p class="tableblock"><code>Extension</code></p></td><td class="tableblock halign-left valign-top"><p class="tableblock">0:1</p></td><td class="tableblock halign-left valign-top"><p class="tableblock"><em>xs:anyType</em></p></td><td class="tableblock halign-left valign-top"><p class="tableblock"/></td></tr></tbody></table></div></div></div></div>
<!--============================================================= Schema file ===--><!--========================================================= schema schema_OJP_Trips--><div class="sect1" id="schema_OJP_Trips"><h2>15. OJP/OJP_Trips.xsd - Request and response definitions for trip requests and distributed journey planning</h2><div class="sectionbody"><div id="schema_OJP_Trips_std" class="simple-type-definitions"><h3>15.1. Simple type definitions</h3><div class="sectionbody"><table class="tableblock frame-all grid-all spread"><colgroup><col style="width:28%"/><col style="width:28%"/><col style="width:44%"/></colgroup><tbody><tr><td class="tableblock halign-left valign-top"><p class="tableblock" id="AccessFeatureTypeEnumeration"><code>AccessFeatureTypeEnumeration</code></p></td><td class="tableblock halign-left valign-top"><p class="tableblock">lift | stairs | seriesOfStairs | escalator | ramp | footpath</p></td><td class="tableblock halign-left valign-top"><p class="tableblock">Allowed values for a AccessFeature.</p></td></tr><tr><td class="tableblock halign-left valign-top"><p class="tableblock" id="GuidanceAdviceEnumeration"><code>GuidanceAdviceEnumeration</code></p></td><td class="tableblock halign-left valign-top"><p class="tableblock">origin | destination | continue | keep | turn | leave | enter</p></td><td class="tableblock halign-left valign-top"><p class="tableblock">various types of guidance advice given to travelle</p></td></tr><tr><td class="tableblock halign-left valign-top"><p class="tableblock" id="MultiPointTypeEnumeration"><code>MultiPointTypeEnumeration</code></p></td><td class="tableblock halign-left valign-top"><p class="tableblock">anyPoint | eachOrigin | eachDestination</p></td><td class="tableblock halign-left valign-top"><p class="tableblock">How the multiple origin/destination points should be considered</p></td></tr><tr><td class="tableblock halign-left valign-top"><p class="tableblock" id="OptimisationMethodEnumeration"><code>OptimisationMethodEnumeration</code></p></td><td class="tableblock halign-left valign-top"><p class="tableblock">fastest | minChanges | leastWalking | leastCost | earliestArrival | latestDeparture | earliestArrivalAndLatestDeparture</p></td><td class="tableblock halign-left valign-top"><p class="tableblock">the types of algorithm that can be used for planning a journey (fastest, least walking, etc).</p></td></tr><tr><td class="tableblock halign-left valign-top"><p class="tableblock" id="TransitionEnumeration"><code>TransitionEnumeration</code></p></td><td class="tableblock halign-left valign-top"><p class="tableblock">up | down | level | upAndDown | downAndUp</p></td><td class="tableblock halign-left valign-top"><p class="tableblock">Transition types for interchanges.</p></td></tr><tr><td class="tableblock halign-left valign-top"><p class="tableblock" id="TurnActionEnumeration"><code>TurnActionEnumeration</code></p></td><td class="tableblock halign-left valign-top"><p class="tableblock">sharp left | left | half left | straight on | half right | right | sharp right | uturn</p></td><td class="tableblock halign-left valign-top"><p class="tableblock">the range of alternative turns that can be described</p></td></tr></tbody></table></div></div><!--======================================= chapter TripRequestGroup--><div id="TripRequestGroup" class="sect2"><h3>15.2. The <code xmlns="">TripRequestGroup</code> group</h3><div class="sectionbody"><table class="tableblock frame-all grid-all spread"><colgroup><col style="width:11.9047619047619%"/><col style="width:1.19047619047619%"/><col style="width:11.9047619047619%"/><col style="width:1.19047619047619%"/><col style="width:23.8095238095238%"/><col style="width:35.7142857142857%"/></colgroup><tbody><!--======= type-description--><tr><td class="tableblock halign-left valign-top" colspan="4"><p class="tableblock"><code>TripRequestGroup</code></p></td><td class="tableblock halign-left valign-top" colspan="1"><p class="tableblock"/></td><td class="tableblock halign-left valign-top"><p class="tableblock">Trip request structure.</p></td></tr>
<!--============================================================= Schema file ===--><!--========================================================= schema schema_OJP_Trips--><div class="sect1" id="schema_OJP_Trips"><h2>15. OJP/OJP_Trips.xsd - Request and response definitions for trip requests and distributed journey planning</h2><div class="sectionbody"><div id="schema_OJP_Trips_std" class="simple-type-definitions"><h3>15.1. Simple type definitions</h3><div class="sectionbody"><table class="tableblock frame-all grid-all spread"><colgroup><col style="width:28%"/><col style="width:28%"/><col style="width:44%"/></colgroup><tbody><tr><td class="tableblock halign-left valign-top"><p class="tableblock" id="AccessFeatureTypeEnumeration"><code>AccessFeatureTypeEnumeration</code></p></td><td class="tableblock halign-left valign-top"><p class="tableblock">lift | stairs | seriesOfStairs | escalator | ramp | footpath</p></td><td class="tableblock halign-left valign-top"><p class="tableblock">Allowed values for a AccessFeature.</p></td></tr><tr><td class="tableblock halign-left valign-top"><p class="tableblock" id="GuidanceAdviceEnumeration"><code>GuidanceAdviceEnumeration</code></p></td><td class="tableblock halign-left valign-top"><p class="tableblock">origin | destination | continue | keep | turn | leave | enter</p></td><td class="tableblock halign-left valign-top"><p class="tableblock">various types of guidance advice given to travelle</p></td></tr><tr><td class="tableblock halign-left valign-top"><p class="tableblock" id="MultiPointTypeEnumeration"><code>MultiPointTypeEnumeration</code></p></td><td class="tableblock halign-left valign-top"><p class="tableblock">anyPoint | eachOrigin | eachDestination</p></td><td class="tableblock halign-left valign-top"><p class="tableblock">How the multiple origin/destination points should be considered</p></td></tr><tr><td class="tableblock halign-left valign-top"><p class="tableblock" id="OptimisationMethodEnumeration"><code>OptimisationMethodEnumeration</code></p></td><td class="tableblock halign-left valign-top"><p class="tableblock">fastest | minChanges | leastWalking | leastCost | leastDistance | earliestArrival | latestDeparture | earliestArrivalAndLatestDeparture</p></td><td class="tableblock halign-left valign-top"><p class="tableblock">the types of algorithm that can be used for planning a journey (fastest, least walking, etc). If multiple optimisation methods are needed, then several requests should be performed in parallel.</p></td></tr><tr><td class="tableblock halign-left valign-top"><p class="tableblock" id="TransitionEnumeration"><code>TransitionEnumeration</code></p></td><td class="tableblock halign-left valign-top"><p class="tableblock">up | down | level | upAndDown | downAndUp</p></td><td class="tableblock halign-left valign-top"><p class="tableblock">Transition types for interchanges.</p></td></tr><tr><td class="tableblock halign-left valign-top"><p class="tableblock" id="TurnActionEnumeration"><code>TurnActionEnumeration</code></p></td><td class="tableblock halign-left valign-top"><p class="tableblock">sharp left | left | half left | straight on | half right | right | sharp right | uturn</p></td><td class="tableblock halign-left valign-top"><p class="tableblock">the range of alternative turns that can be described</p></td></tr></tbody></table></div></div><!--======================================= chapter TripRequestGroup--><div id="TripRequestGroup" class="sect2"><h3>15.2. The <code xmlns="">TripRequestGroup</code> group</h3><div class="sectionbody"><table class="tableblock frame-all grid-all spread"><colgroup><col style="width:11.9047619047619%"/><col style="width:1.19047619047619%"/><col style="width:11.9047619047619%"/><col style="width:1.19047619047619%"/><col style="width:23.8095238095238%"/><col style="width:35.7142857142857%"/></colgroup><tbody><!--======= type-description--><tr><td class="tableblock halign-left valign-top" colspan="4"><p class="tableblock"><code>TripRequestGroup</code></p></td><td class="tableblock halign-left valign-top" colspan="1"><p class="tableblock"/></td><td class="tableblock halign-left valign-top"><p class="tableblock">Trip request structure.</p></td></tr>
<!--======= row--><tr><td class="tableblock halign-left valign-top" rowspan="6"><a href="#TripRequestGroup">TripRequest</a></td><td class="tableblock halign-left valign-top" colspan="2"><p class="tableblock"><code><strong>Origin</strong></code></p></td><td class="tableblock halign-left valign-top"><p class="tableblock"><strong>1:*</strong></p></td><td class="tableblock halign-left valign-top"><p class="tableblock"><em>+<a href="#PlaceContextStructure">PlaceContext</a></em></p></td><td class="tableblock halign-left valign-top"><p class="tableblock">Specifies the origin situation from where the user wants to start.</p></td></tr>
<!--======= row--><tr><td class="tableblock halign-left valign-top" colspan="2"><p class="tableblock"><code><strong>Destination</strong></code></p></td><td class="tableblock halign-left valign-top"><p class="tableblock"><strong>1:*</strong></p></td><td class="tableblock halign-left valign-top"><p class="tableblock"><em>+<a href="#PlaceContextStructure">PlaceContext</a></em></p></td><td class="tableblock halign-left valign-top"><p class="tableblock">Specifies the destination situation where the user is heading to.</p></td></tr>
<!--======= row--><tr><td class="tableblock halign-left valign-top" colspan="2"><p class="tableblock"><code>Via</code></p></td><td class="tableblock halign-left valign-top"><p class="tableblock">0:*</p></td><td class="tableblock halign-left valign-top"><p class="tableblock"><em>+<a href="#TripViaStructure">TripVia</a></em></p></td><td class="tableblock halign-left valign-top"><p class="tableblock">Ordered series of points where the journey must pass through. If more than one via point is given all of them must be obeyed - in the correct order. The server is allowed to replace a via stop by equivalent stops.</p></td></tr>
Expand Down

0 comments on commit df70e37

Please sign in to comment.