Skip to content

Commit

Permalink
Aligning MultiPointTripPolicyGroup with TripPolicyGroup (#333)
Browse files Browse the repository at this point in the history
* OptimisationMethods, ItModesToCover, ConsiderElevationData
* Move parameters used by MultiPointTripPolicyGroup and TripPolicyGroup to BaseTripPolicyGroup

ItModesToCover is left in each PolicyGroup as it has a different meaning (and thus documentation) for MultiPointTripPolicyGroup and TripPolicyGroup
  • Loading branch information
trurlurl authored Mar 13, 2023
1 parent 208225c commit 7691e00
Show file tree
Hide file tree
Showing 3 changed files with 54 additions and 59 deletions.
24 changes: 23 additions & 1 deletion OJP/OJP_JourneySupport.xsd
Original file line number Diff line number Diff line change
Expand Up @@ -598,7 +598,29 @@
</xs:element>
<xs:element name="ImmediateTripStart" type="xs:boolean" default="false" minOccurs="0">
<xs:annotation>
<xs:documentation>Whether the trip calculation should find a solution that starts immediately (f.e. because the user is already on the way) instead of finding the latest possible start opportunity.</xs:documentation>
<xs:documentation>Whether the trip calculation should find a solution that starts immediately (e.g. because the user is already on the way) instead of finding the latest possible start opportunity. Default is FALSE.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="TransferLimit" type="xs:nonNegativeInteger" minOccurs="0">
<xs:annotation>
<xs:documentation>The maximum number of interchanges the user will accept per trip.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:choice>
<xs:element name="OptimisationMethod" type="OptimisationMethodEnumeration">
<xs:annotation>
<xs:documentation>The type of algorithm to be used in the calculation of the trip (fastest, least walking, etc.).</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="OptimisationMethods" type="OptimisationMethodList" minOccurs="0">
<xs:annotation>
<xs:documentation>The types of algorithm that should be used in the calculation of the trip.</xs:documentation>
</xs:annotation>
</xs:element>
</xs:choice>
<xs:element name="ConsiderElevationData" type="xs:boolean" default="false" minOccurs="0">
<xs:annotation>
<xs:documentation>Whether the trip calculation should take elevation data into account (bike, walk). Default is FALSE.</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
Expand Down
34 changes: 1 addition & 33 deletions OJP/OJP_Trips.xsd
Original file line number Diff line number Diff line change
Expand Up @@ -112,33 +112,11 @@
</xs:annotation>
<xs:sequence>
<xs:group ref="BaseTripPolicyGroup"/>
<xs:element name="TransferLimit" type="xs:nonNegativeInteger" minOccurs="0">
<xs:annotation>
<xs:documentation>The maximum number of interchanges the user will accept per trip.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:choice>
<xs:element name="OptimisationMethod" type="OptimisationMethodEnumeration">
<xs:annotation>
<xs:documentation>The type of algorithm to be used for planning a journey (fastest, least walking, etc.).</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="OptimisationMethods" type="OptimisationMethodList" minOccurs="0">
<xs:annotation>
<xs:documentation>The types of algorithm that should be used for planning a journey.</xs:documentation>
</xs:annotation>
</xs:element>
</xs:choice>
<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>
</xs:annotation>
</xs:element>
<xs:element name="ConsiderElevationData" type="xs:boolean" default="false" minOccurs="0">
<xs:annotation>
<xs:documentation>Trip calculation takes elevation data into account (bike, walk)</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
</xs:group>
<xs:group name="TripMobilityFilterGroup">
Expand Down Expand Up @@ -1304,20 +1282,10 @@
</xs:complexType>
<xs:group name="MultiPointTripPolicyGroup">
<xs:annotation>
<xs:documentation>Policies that control the multi-point trip search behaviour.</xs:documentation>
<xs:documentation>Policies that control the multipoint trip search behaviour.</xs:documentation>
</xs:annotation>
<xs:sequence>
<xs:group ref="BaseTripPolicyGroup"/>
<xs:element name="TransferLimit" type="xs:nonNegativeInteger" minOccurs="0">
<xs:annotation>
<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
Loading

0 comments on commit 7691e00

Please sign in to comment.