Enhance TripPolicy for more Private Lines, filter for PassengerCategory, Access Modes #349

ue71603 · 2023-04-07T12:42:29Z

With this PR it is possible to allow a trip planner to include specialised private LINE (e.g. car pooling, school busses, company shuttles) into the trip planning.
It also allows to define necessary ACCESS MODE (e.g. that you are in a car, which restricts search to road, ferry, carTransportRail or that you can access a dragLift, because you have skis with you.
The third part makes sure, that selected by the PassengerCategory some additional things might get "unlocked". E.g. in Delemont seniors have a different service offered to them by the demand responsive service: https://www.postauto.ch/de/fahrplan-und-netz/publicar/delemont

OJP/OJP_Trips.xsd

trurlurl

Sorry for slowing down the approval...

OJP/OJP_Trips.xsd

ue71603 · 2023-04-11T11:47:41Z

The use cases are:

• Alice wants to go to the mountain top restaurant and uses a snowboard. As the mountain top restaurant during winter is accessible by a dragLift, this should show in the trip result, because Alice sent (foot ski) in the new AccessModeList parameter.
• Bob goes from Bern to his holiday hotel in Crans Montana. He will use the carTransportRail between Kandersteg and Goppenstein. He informs himself about the waiting time and specifies his desired arrival time in Goppenstein, this results in a rail trip between Kandersteg and Goppenstein and he expands this with two trip requests (Bern – Kandersteg; Goppenstein – Crans Montana).
• Charlie wants to go to Crete. She is going with the motorcycle and needs to use a ferry that is willing to transport her and the vehicle.
• “Auto im Reisezug” we don’t have that really, but I guess this is also a use case.
• In future we will have additional use cases for Cargo transport and there it might be relevant).

OJP/OJP_Trips.xsd

OJP/OJP_ModesSupport.xsd

OJP/OJP_Trips.xsd

herlitze · 2023-05-08T14:28:52Z

I added IncludePrivateLines to the StopEvent-Request as well.

OJP/OJP_Trips.xsd

OJP/OJP_StopEvents.xsd

OJP/OJP_Trips.xsd

… ExtendTripPoliciy

trurlurl · 2023-09-14T12:42:15Z

examples/functions/trip/TR_07_request_Delemont_senior.xml

+					</PlaceRef>
+				</Destination>
+				<Params>
+					<PassengerCategory>Senior</PassengerCategory>


In my understanding there should be the IncludeRestrictedLines flag in order to obtain the example response that includes a restricted service.

@trurlurl If the PassengerCategory is set, there is no need for the IncludeRestrictedLines. It shows up. I will add an additional example showing it and a "private service".

Aha - to make this more clear, see the proposition on line 147.

examples/functions/trip/TR_08_request_dog.xml

trurlurl · 2023-09-14T13:00:35Z

examples/functions/trip/TR_08_response_dog.xml

+			<siri:ErrorCondition>
+				<OJPError>
+					<TripProblemType>TRIP_RESTRICTEDRESULTSDROPPED</TripProblemType>
+				</OJPError>


In what cases should that error condition appear? If, e.g., we have "Senior" among the passenger categories, but IncludeRestrictedLineswas not set to true?

I think most people will not implement this. I think this can be used, when the service knows it dropped things because they are restricted. In this case the Publicar was droopped, because: (a) no Senior (b) no IncludeRestrictedLines.

I improved the example some more.

I think the PubliCar shouldn't be dropped, since ,,, "If multiple PassengerCategories are provided, then Services are shown when they are available for at least one PassengerCategory."

And in that case the error condition wouldn't appear and should be shown in another example.

now only dog, even when this doesn't make completly sense.

OJP/OJP_Trips.xsd

trurlurl · 2023-09-15T09:16:58Z

OJP/OJP_Trips.xsd

+							<xs:documentation>Whether alternative options should be presented as well. Mainly important for dominated journeys or in the case of ContinuousLegs the second-best route. Should be optimised for the user expectance (see. e.g https://theses.hal.science/tel-01848737). However, what the alternative options are may vary widely depending on the optimisation methods and filters.</xs:documentation>
+						</xs:annotation>
+					</xs:element>
+					<xs:element name="IncludeRestrictedLines" type="xs:boolean" minOccurs="0" default="false">


Might IncludeAllRestrictedLines be a better name?

trurlurl · 2023-09-15T09:23:39Z

OJP/OJP_JourneySupport.xsd

@@ -143,6 +143,16 @@
 					<xs:documentation>Via points of the service that may help identify the vehicle to the public (In Transmodel modeled as TRIP REQUEST PLACE.TRIP VIA PLACE.GoVia; it will also most probably be detailed as a VIA and associated DESTINATION DISPLAY in the ROUTE description).</xs:documentation>
 				</xs:annotation>
 			</xs:element>
+			<xs:element name="Restricted" type="xs:boolean" minOccurs="0">
+				<xs:annotation>
+					<xs:documentation>This flag is set if the service can only be used in a restricted way. For example, a specific ACCESS MODE is required (e.g. dragLift) or the LINE is only made available to certain passenger groups (e.g. school buses, hotel shuttles), as defined in PrivateMode. Restricted trumps PassengerCategory, for example. If Restricted is set to true, all services are displayed.</xs:documentation>


Are the last two sentences at the right place here? Or were they intended for IncludeRestrictedLines? That would match my comment on line 147.

correct. changed

OJP/OJP_Trips.xsd

trurlurl · 2023-09-15T09:29:52Z

examples/functions/trip/TR_07_request_Delemont_senior.xml

+					</PlaceRef>
+				</Destination>
+				<Params>
+					<PassengerCategory>Senior</PassengerCategory>


Aha - to make this more clear, see the proposition on line 147.

trurlurl · 2023-09-15T09:31:05Z

examples/functions/trip/TR_08_response_dog.xml

+			<siri:ErrorCondition>
+				<OJPError>
+					<TripProblemType>TRIP_RESTRICTEDRESULTSDROPPED</TripProblemType>
+				</OJPError>


Co-authored-by: trurlurl <[email protected]>

OJP/OJP_JourneySupport.xsd

ue71603 · 2023-09-15T09:55:29Z

OJP/OJP_JourneySupport.xsd

@@ -143,6 +143,16 @@
 					<xs:documentation>Via points of the service that may help identify the vehicle to the public (In Transmodel modeled as TRIP REQUEST PLACE.TRIP VIA PLACE.GoVia; it will also most probably be detailed as a VIA and associated DESTINATION DISPLAY in the ROUTE description).</xs:documentation>
 				</xs:annotation>
 			</xs:element>
+			<xs:element name="Restricted" type="xs:boolean" minOccurs="0">
+				<xs:annotation>
+					<xs:documentation>This flag is set if the service can only be used in a restricted way. For example, a specific ACCESS MODE is required (e.g. dragLift) or the LINE is only made available to certain passenger groups (e.g. school buses, hotel shuttles), as defined in PrivateMode. Restricted trumps PassengerCategory, for example. If Restricted is set to true, all services are displayed.</xs:documentation>


correct. changed

OJP/OJP_Trips.xsd

ue71603 · 2023-09-15T09:56:30Z

OJP/OJP_Trips.xsd

+							<xs:documentation>There might exist lines that have special restrictions and are not generally available to the public. E.g. school buses, company shuttles. dragLifts need to have an ACCESS MODE ski. Lines with ACCESS MODE bicycle will be included as well. If this flag is set, then existing restricted lines are considered by the router. The results are marked as restricted in the ServiceGroup. The restriction can be seen from: ACCESS MODE or PrivateMode. The usage could also be detailed with Attribute elements.</xs:documentation>
+						</xs:annotation>
+					</xs:element>
+					<xs:element name="PassengerCategory" type="PassengerCategoryEnumeration" minOccurs="0" maxOccurs="unbounded">


I assume this is ok now

ue71603 · 2023-09-15T09:57:11Z

examples/functions/trip/TR_07_request_Delemont_senior.xml

+					</PlaceRef>
+				</Destination>
+				<Params>
+					<PassengerCategory>Senior</PassengerCategory>


ue71603 · 2023-09-15T10:00:05Z

examples/functions/trip/TR_08_response_dog.xml

+			<siri:ErrorCondition>
+				<OJPError>
+					<TripProblemType>TRIP_RESTRICTEDRESULTSDROPPED</TripProblemType>
+				</OJPError>


I improved the example some more.

ue71603 · 2023-09-15T10:08:26Z

OJP/OJP_Trips.xsd

+							<xs:documentation>Whether alternative options should be presented as well. Mainly important for dominated journeys or in the case of ContinuousLegs the second-best route. Should be optimised for the user expectance (see. e.g https://theses.hal.science/tel-01848737). However, what the alternative options are may vary widely depending on the optimisation methods and filters.</xs:documentation>
+						</xs:annotation>
+					</xs:element>
+					<xs:element name="IncludeRestrictedLines" type="xs:boolean" minOccurs="0" default="false">


… ExtendTripPoliciy

trurlurl · 2023-09-15T10:52:12Z

examples/functions/trip/TR_08_response_dog.xml

+			<siri:ErrorCondition>
+				<OJPError>
+					<TripProblemType>TRIP_RESTRICTEDRESULTSDROPPED</TripProblemType>
+				</OJPError>


I think the PubliCar shouldn't be dropped, since ,,, "If multiple PassengerCategories are provided, then Services are shown when they are available for at least one PassengerCategory."

And in that case the error condition wouldn't appear and should be shown in another example.

… ExtendTripPoliciy

ue71603 · 2023-09-18T15:28:14Z

@skinkie If you could approve it also, we could merge.

ue71603 · 2023-09-19T08:45:17Z

Are all of these changes actually related to each other in a way they have to be merged in one pull request? It isn't really easy to understand.

They came out of the same meeting and discussion (on sharing and necessary extensions). I know they are difficult to understand. But breaking them apart would not make it better.

Because we are at the end of the discussion.

ue71603 added enhancement New feature or request documentation labels Apr 7, 2023

ue71603 added this to the v2.0 milestone Apr 7, 2023

ue71603 requested review from skinkie, Aurige, herlitze, normanoffel, JonaVBB, trurlurl, AndreasAtSBB and sgrossberndt April 7, 2023 12:42

skinkie reviewed Apr 7, 2023

View reviewed changes

OJP/OJP_Trips.xsd Show resolved Hide resolved

skinkie previously approved these changes Apr 7, 2023

View reviewed changes

Aurige previously approved these changes Apr 7, 2023

View reviewed changes

trurlurl requested changes Apr 7, 2023

View reviewed changes

OJP/OJP_Trips.xsd Outdated Show resolved Hide resolved

OJP/OJP_Trips.xsd Outdated Show resolved Hide resolved

ue71603 mentioned this pull request Apr 7, 2023

Make sure that the PassengerCategoryies and the PrivateMode are done in NeTEx, so that it works out. NeTEx-CEN/NeTEx#437

Closed

ue71603 dismissed stale reviews from Aurige and skinkie via 11f42a5 April 7, 2023 19:52

ue71603 commented Apr 11, 2023

View reviewed changes

OJP/OJP_Trips.xsd Outdated Show resolved Hide resolved

OJP/OJP_Trips.xsd Outdated Show resolved Hide resolved

OJP/OJP_Trips.xsd Outdated Show resolved Hide resolved

trurlurl requested changes Apr 12, 2023

View reviewed changes

OJP/OJP_Trips.xsd Outdated Show resolved Hide resolved

OJP/OJP_Trips.xsd Outdated Show resolved Hide resolved

ue71603 commented Apr 13, 2023

View reviewed changes

OJP/OJP_ModesSupport.xsd Outdated Show resolved Hide resolved

trurlurl reviewed Apr 14, 2023

View reviewed changes

OJP/OJP_Trips.xsd Outdated Show resolved Hide resolved

trurlurl mentioned this pull request Apr 25, 2023

Update CHANGELOG.md #309

Merged

herlitze previously approved these changes May 2, 2023

View reviewed changes

herlitze dismissed their stale review via f40bffa May 8, 2023 14:27

herlitze force-pushed the ExtendTripPoliciy branch from f40bffa to a734061 Compare May 8, 2023 14:30

ue71603 force-pushed the ExtendTripPoliciy branch from c2d5b55 to dd9540b Compare May 31, 2023 19:47

trurlurl requested changes Jun 1, 2023

View reviewed changes

OJP/OJP_Trips.xsd Outdated Show resolved Hide resolved

OJP/OJP_StopEvents.xsd Outdated Show resolved Hide resolved

OJP/OJP_Trips.xsd Outdated Show resolved Hide resolved

OJP/OJP_Trips.xsd Outdated Show resolved Hide resolved

OJP/OJP_Trips.xsd Outdated Show resolved Hide resolved

ue71603 and others added 2 commits September 14, 2023 09:59

Merge branch 'ExtendTripPoliciy' of https://github.com/VDVde/OJP into…

4229102

… ExtendTripPoliciy

Lint and update documentation tables

ad31774

trurlurl requested changes Sep 14, 2023

View reviewed changes

ue71603 and others added 2 commits September 14, 2023 18:56

example with IncludeRestrictedLines

e5efaec

Lint and update documentation tables

8cd47a6

trurlurl requested changes Sep 15, 2023

View reviewed changes

ue71603 and others added 2 commits September 15, 2023 11:50

Update OJP/OJP_Trips.xsd

a33a692

Co-authored-by: trurlurl <[email protected]>

Lint and update documentation tables

cef6d3f

ue71603 commented Sep 15, 2023

View reviewed changes

ue71603 and others added 6 commits September 15, 2023 12:08

Update OJP/OJP_JourneySupport.xsd

a947635

Update OJP/OJP_Trips.xsd

3445869

Lint and update documentation tables

c96d56b

improved examples changed restriction name and comment

2b7e6ff

Merge branch 'ExtendTripPoliciy' of https://github.com/VDVde/OJP into…

303eedc

… ExtendTripPoliciy

Lint and update documentation tables

e7cca30

trurlurl requested changes Sep 15, 2023

View reviewed changes

ue71603 and others added 3 commits September 15, 2023 15:28

move AccesModesListOfEnumerations, fix dog example

65b33f9

Merge branch 'ExtendTripPoliciy' of https://github.com/VDVde/OJP into…

69c72a7

… ExtendTripPoliciy

Lint and update documentation tables

7dd81f8

trurlurl approved these changes Sep 15, 2023

View reviewed changes

skinkie approved these changes Sep 18, 2023

View reviewed changes

skinkie merged commit 4caa609 into changes_for_v1.1 Sep 19, 2023

skinkie deleted the ExtendTripPoliciy branch September 19, 2023 08:47

trurlurl mentioned this pull request Sep 25, 2023

implementing MODES OF OPERATION from FU 44 #379

Merged

trurlurl added doc updated breaking and removed documentation labels Oct 24, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Enhance TripPolicy for more Private Lines, filter for PassengerCategory, Access Modes #349

Enhance TripPolicy for more Private Lines, filter for PassengerCategory, Access Modes #349

ue71603 commented Apr 7, 2023

trurlurl left a comment

ue71603 commented Apr 11, 2023

herlitze commented May 8, 2023 •

edited

Loading

trurlurl Sep 14, 2023

ue71603 Sep 14, 2023

trurlurl Sep 15, 2023

ue71603 Sep 15, 2023

trurlurl Sep 14, 2023

ue71603 Sep 14, 2023

trurlurl Sep 15, 2023

ue71603 Sep 15, 2023

trurlurl Sep 15, 2023

ue71603 Sep 15, 2023

trurlurl Sep 15, 2023

ue71603 Sep 15, 2023

trurlurl Sep 15, 2023

ue71603 Sep 15, 2023

trurlurl Sep 15, 2023

trurlurl Sep 15, 2023

ue71603 Sep 15, 2023

ue71603 Sep 15, 2023

ue71603 Sep 15, 2023

ue71603 Sep 15, 2023

ue71603 Sep 15, 2023

trurlurl Sep 15, 2023

ue71603 commented Sep 18, 2023

ue71603 commented Sep 19, 2023

Enhance TripPolicy for more Private Lines, filter for PassengerCategory, Access Modes #349

Enhance TripPolicy for more Private Lines, filter for PassengerCategory, Access Modes #349

Conversation

ue71603 commented Apr 7, 2023

trurlurl left a comment

Choose a reason for hiding this comment

ue71603 commented Apr 11, 2023

herlitze commented May 8, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ue71603 commented Sep 18, 2023

ue71603 commented Sep 19, 2023

herlitze commented May 8, 2023 •

edited

Loading