Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Scores for accessibility routing and other preferences #254

Closed
wants to merge 3 commits into from
Closed

Scores for accessibility routing and other preferences #254

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
5aaa53b
Score structure added
trurlurl Oct 7, 2022
009a8d9
Update OJP_Trips.xsd
trurlurl Oct 7, 2022
282018c
Update OJP_Trips.xsd
trurlurl Oct 8, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 0 additions & 37 deletions OJP/OJP_JourneySupport.xsd
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -523,43 +523,6 @@
</xs:element>
</xs:sequence>
</xs:group>
<xs:group name="BaseTripMobilityFilterGroup">
<xs:annotation>
<xs:documentation>Base mobility options to be applied for both public and individual transport.</xs:documentation>
</xs:annotation>
<xs:sequence>
<xs:element name="NoSingleStep" type="xs:boolean" default="false" minOccurs="0">
<xs:annotation>
<xs:documentation>The user is not able to climb one step.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="NoStairs" type="xs:boolean" default="false" minOccurs="0">
<xs:annotation>
<xs:documentation>The user is not able to walk up/down stairs.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="NoEscalator" type="xs:boolean" default="false" minOccurs="0">
<xs:annotation>
<xs:documentation>The user is not able to use an escalator.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="NoElevator" type="xs:boolean" default="false" minOccurs="0">
<xs:annotation>
<xs:documentation>The user is not able to use an elevator.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="NoRamp" type="xs:boolean" default="false" minOccurs="0">
<xs:annotation>
<xs:documentation>The user is not able to use an ramp.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="NoSight" type="xs:boolean" default="false" minOccurs="0">
<xs:annotation>
<xs:documentation>The user is not able to see.</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
</xs:group>
<xs:group name="BaseTripContentFilterGroup">
<xs:annotation>
<xs:documentation>Parameters to control the level of detail of both public and individual transport journey results.</xs:documentation>
Expand Down
215 changes: 187 additions & 28 deletions OJP/OJP_Trips.xsd
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,7 @@
<xs:sequence>
<xs:group ref="TripDataFilterGroup"/>
<xs:group ref="TripMobilityFilterGroup"/>
<xs:element name="Score" type="Score" minOccurs="0" maxOccurs="unbounded"/>
<xs:group ref="TripPolicyGroup"/>
<xs:group ref="TripContentFilterGroup"/>
<xs:element name="FareParam" type="FareParamStructure" minOccurs="0"/>
Expand Down Expand Up @@ -96,11 +97,6 @@
<xs:documentation>The maximum number of interchanges the user will accept per trip.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="OptimisationMethod" type="OptimisationMethodEnumeration" minOccurs="0">
<xs:annotation>
<xs:documentation>the types of algorithm that can be used for planning a journey (fastest, least walking, etc)</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="ItModesToCover" type="IndividualModesEnumeration" minOccurs="0" maxOccurs="unbounded">
<xs:annotation>
<xs:documentation>For each mode in this list a separate monomodal trip shall be found - in addition to inter-modal solutions.</xs:documentation>
Expand All @@ -113,7 +109,6 @@
<xs:documentation>Parameters the user can set to restrict the mobility options - particularly for interchanging.</xs:documentation>
</xs:annotation>
<xs:sequence>
<xs:group ref="BaseTripMobilityFilterGroup"/>
<xs:element name="LevelEntrance" type="xs:boolean" default="false" minOccurs="0">
<xs:annotation>
<xs:documentation>The user needs vehicles with level entrance between platform and vehicle, f.e. for wheelchair access.</xs:documentation>
Expand Down Expand Up @@ -164,23 +159,9 @@
</xs:element>
</xs:sequence>
</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: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="earliestArrival"/>
<xs:enumeration value="latestDeparture"/>
<xs:enumeration value="earliestArrivalAndLatestDeparture"/>
</xs:restriction>
</xs:simpleType>
<xs:complexType name="NotViaStructure">
<xs:annotation>
<xs:documentation>NNot-via restrictions for a TRIP, i.e. SCHEDULED STOP POINTs or STOP PLACEs that the TRIP is not allowed to pass through</xs:documentation>
<xs:documentation>Not-via restrictions for a TRIP, i.e. SCHEDULED STOP POINTs or STOP PLACEs that the TRIP is not allowed to pass through</xs:documentation>
</xs:annotation>
<xs:sequence>
<xs:choice>
Expand All @@ -191,7 +172,7 @@
</xs:complexType>
<xs:complexType name="NoChangeAtStructure">
<xs:annotation>
<xs:documentation>no-change-at restrictions for a TRIP, i.e. SCHEDULED STOP POINTs or STOP PLACEs at which no TRANSFER is allowed within a TRIP.</xs:documentation>
<xs:documentation>No-change-at restrictions for a TRIP, i.e. SCHEDULED STOP POINTs or STOP PLACEs at which no TRANSFER is allowed within a TRIP.</xs:documentation>
</xs:annotation>
<xs:sequence>
<xs:choice>
Expand All @@ -200,6 +181,181 @@
</xs:choice>
</xs:sequence>
</xs:complexType>
<xs:annotation>
<xs:documentation>========================================== Score / cost function definitions ==========================================</xs:documentation>
</xs:annotation>
<xs:complexType name="Score">
<xs:annotation>
<xs:documentation>Cost function to be optimized.</xs:documentation>
</xs:annotation>
<xs:sequence>
<xs:element name="ScoreType" type="ScoreTypeEnumeration" minOccurs="0">
<xs:annotation>
<xs:documentation>Predefined ScoreTypes favoring the use of similar scores across countries.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="Name" type="xs:NMTOKEN" minOccurs="1">
<xs:annotation>
<xs:documentation>Identifier of the score.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="Intention" type="xs:string" minOccurs="0">
<xs:annotation>
<xs:documentation>Description what the score intends to achieve / optimize.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="Priority" type="ScorePriorityTypeEnumeration" minOccurs="1">
<xs:annotation>
<xs:documentation>Priority when optimizing multiple scores. Higher priorities dominate lower priorities.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="Preference" type="Preference" minOccurs="1" maxOccurs="unbounded">
<xs:annotation>
<xs:documentation>Definition of how violating a preference like no stairs or short distance adds to the cost function.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="AdditionalConditions" type="TripParamStructure" minOccurs="0">
<xs:annotation>
<xs:documentation>Additional conditions relevant for the passenger type in question may apply, as can be specified in a TripParamStructure. Examples: PrivateModeFilter, BikeTransport, WalkSpeed, AdditionalTransferTime.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="Result" type="xs:float" minOccurs="0">
<xs:annotation>
<xs:documentation>Return parameter - the calculated score / cost value of the Trip.</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
</xs:complexType>
<xs:simpleType name="ScorePriorityTypeEnumeration">
<xs:annotation>
<xs:documentation>Priority when optimizing multiple scores.</xs:documentation>
</xs:annotation>
<xs:restriction base="xs:string">
<xs:enumeration value="priority1"/>
<xs:enumeration value="priority2"/>
<xs:enumeration value="priority3"/>
<xs:enumeration value="justComputeScore"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="ScoreTypeEnumeration">
<xs:annotation>
<xs:documentation>Common types of scores. They can also be used to retrieve standard (pre-defined) Score definitions. Additional knowledge, e.g., about sportiness may be used to adapt a Score.</xs:documentation>
</xs:annotation>
<xs:restriction base="xs:string">
<xs:annotation>
<xs:documentation>Accessibility.</xs:documentation>
</xs:annotation>
<xs:enumeration value="wheelchair"/>
<xs:enumeration value="assistedWheelchair"/>
<xs:enumeration value="sportyWheelchair"/>
<xs:enumeration value="motorisedWheelchair"/>
<xs:enumeration value="pushchair"/>
<xs:enumeration value="rollator"/>
<xs:enumeration value="walkingImpaired"/>
<xs:enumeration value="baggageTrolley"/>
<xs:enumeration value="baggageEncumbered"/>
<xs:enumeration value="visuallyImpaired"/>
<xs:enumeration value="auditorilyImpaired"/>
<xs:annotation>
<xs:documentation>Traditional optimization methods.</xs:documentation>
</xs:annotation>
<xs:enumeration value="fastest"/>
<xs:enumeration value="minChanges"/>
<xs:enumeration value="leastWalking"/>
<xs:enumeration value="leastCost"/>
<xs:enumeration value="earliestArrival"/>
<xs:enumeration value="latestDeparture"/>
<xs:enumeration value="earliestArrivalAndLatestDeparture"/>
<xs:annotation>
<xs:documentation>Further options.</xs:documentation>
</xs:annotation>
<xs:enumeration value="comfort"/>
<xs:enumeration value="weatherProtection"/>
<!-- The following seem less close to realisation:
<xs:enumeration value="environmentalFootprint"/>
<xs:enumeration value="reliability"/>
<xs:enumeration value="safety"/>
<xs:enumeration value="scenic"/>
<xs:enumeration value="peaceful"/>
-->
<xs:enumeration value="custom"/>
</xs:restriction>
</xs:simpleType>
<xs:complexType name="Preference">
<xs:annotation>
<xs:documentation>The less a Preference is met, the more it adds to the cost function.</xs:documentation>
</xs:annotation>
<xs:sequence>
<xs:element name="PreferenceType" type="PreferenceTypeEnumeration" minOccurs="1">
<xs:annotation>
<xs:documentation>Preference features the server side is able to check / evaluate.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="WeightFactor" type="xs:float" minOccurs="1">
<xs:annotation>
<xs:documentation>Multiplication factor reflecting the importance of the preference. Convention: A WeightFactor of 1000 or more means that the preference is essential (in case of boolean preferences).</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="SumCompleteTrip" type="xs:float" default="0" minOccurs="0">
<xs:annotation>
<xs:documentation>The preference has to be evaluated for each PathLink and the results are summed over the complete Trip. Convention: A value over 1000 means that an essential preference has been violated and the Trip is not valid.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="IncompleteDataButRealityMightBeBetter" type="xs:boolean" default="false" minOccurs="0">
<xs:annotation>
<xs:documentation>Indicates whether SumCompletTrip is based on incomplete data. Convention: In case of incomplete data, SumCompleteTrip is calculated by assuming an unfavorable evaluation.</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
</xs:complexType>
<xs:simpleType name="PreferenceTypeEnumeration">
<xs:annotation>
<xs:documentation>Preference features the system is able to check or evaluate.</xs:documentation>
</xs:annotation>
<xs:restriction base="xs:string">
<xs:annotation>
<xs:documentation>Boolean features - they evaluate to 0 in the favorable case, to 1 in the unvaforable case.</xs:documentation>
</xs:annotation>
<xs:enumeration value="levelEntrance"/>
<xs:enumeration value="noSingleStep"/>
<xs:enumeration value="noStairs"/>
<xs:enumeration value="noRamp"/>
<xs:enumeration value="noRampUp"/>
<xs:enumeration value="noRampDown"/>
<xs:enumeration value="noElevator"/>
<xs:enumeration value="noEscalator"/>
<xs:enumeration value="noTravelator"/>
<xs:enumeration value="visualSigns"/>
<xs:enumeration value="tactileGuidingStrips"/>
<xs:enumeration value="tactileOrAuditorySigns"/>
<xs:enumeration value="theAdditionalConditions">
<xs:annotation>
<xs:documentation>The boolean conditions in Score.AdditionalConditions.</xs:documentation>
</xs:annotation>
</xs:enumeration>
<!-- The following seem less close to realisation:
<xs:enumeration value="onlyExtraReliableConnections"/>
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Add onlyGuaranteedInterchanges, evaluation based on guaranteedConnection (TransferModesEnumeration)?

<xs:enumeration value="onlyConnectionsWithBaggageTrolleys"/>
-->
<xs:annotation>
<xs:documentation>Numerical features - they evaluate to a value that will be multiplied by Preference.WeightFactor.</xs:documentation>
</xs:annotation>
<xs:enumeration value="numberOfChanges"/>
<xs:enumeration value="waitDuration"/>
<xs:enumeration value="walkDistance"/>
<xs:enumeration value="walkDistanceCovered"/>
<xs:enumeration value="walkDistanceNotCovered"/>
<xs:enumeration value="walkDistancePossiblyCovered"/>
<!-- The following seem less close to realisation:
<xs:enumeration value="distanceByCycle"/>
<xs:enumeration value="distanceByScooter"/>
<xs:enumeration value="price"/>
<xs:enumeration value="scenicRatingsMax"/>
<xs:enumeration value="scenicRatingsAvg"/>
<xs:enumeration value="environmentalFootprint"/>
-->
</xs:restriction>
</xs:simpleType>
Copy link
Contributor Author

@trurlurl trurlurl Oct 7, 2022 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Example` to illustrate a Score definition:

ExampleScore.txt

<xs:annotation>
<xs:documentation>========================================== Response definitions ==========================================</xs:documentation>
</xs:annotation>
Expand Down Expand Up @@ -247,6 +403,7 @@
</xs:annotation>
</xs:element>
</xs:choice>
<xs:element name="Score" type="Score" minOccurs="0" maxOccurs="unbounded"/>
<xs:element name="TripFare" type="TripFareResultStructure" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
Expand Down Expand Up @@ -703,12 +860,17 @@
<xs:documentation>Allowed values for a AccessFeature.</xs:documentation>
</xs:annotation>
<xs:restriction base="xs:string">
<xs:enumeration value="lift"/>
<xs:enumeration value="elevator"/>
<xs:enumeration value="stairs"/>
<xs:enumeration value="seriesOfStairs"/>
<xs:enumeration value="singleStep"/>
<xs:enumeration value="seriesOfSingleSteps"/>
<xs:enumeration value="escalator"/>
<xs:enumeration value="travelator"/>
<xs:enumeration value="ramp"/>
<xs:enumeration value="footpath"/>
<xs:enumeration value="other"/>
<xs:enumeration value="unknown"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="TransitionEnumeration">
Expand Down Expand Up @@ -792,6 +954,7 @@
<xs:sequence>
<xs:group ref="TripDataFilterGroup"/>
<xs:group ref="TripMobilityFilterGroup"/>
<xs:element name="Score" type="Score" minOccurs="0" maxOccurs="unbounded"/>
<xs:group ref="MultiPointTripPolicyGroup"/>
<xs:group ref="TripContentFilterGroup"/>
<xs:element name="FareParam" type="FareParamStructure" minOccurs="0"/>
Expand All @@ -809,11 +972,6 @@
<xs:documentation>The maximum number of interchanges the user will accept per trip.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="OptimisationMethod" type="OptimisationMethodEnumeration" minOccurs="0">
<xs:annotation>
<xs:documentation>the types of algorithm that can be used for planning a journey (fastest, least walking, etc)</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="MultiPointType" type="MultiPointTypeEnumeration" default="anyPoint" minOccurs="0">
<xs:annotation>
<xs:documentation>If a solution for any one of multiple origin/destination points is sufficient. Or a distinct solution for each of the origin/destination points has to be found.</xs:documentation>
Expand Down Expand Up @@ -874,6 +1032,7 @@
</xs:element>
<xs:element name="TripSummary" type="TripSummaryStructure"/>
</xs:choice>
<xs:element name="Score" type="Score" minOccurs="0" maxOccurs="unbounded"/>
<xs:group ref="MultiPointWaitTimeGroup" minOccurs="0"/>
<xs:element name="TripFare" type="TripFareResultStructure" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
Expand Down