Skip to content

Commit

Permalink
Merge branch 'changes_for_v1.1' into PathGuidance
Browse files Browse the repository at this point in the history 
# Conflicts:
#	OJP/OJP_Trips.xsd
#	docs/generated/index.html
  • Loading branch information
@skinkie
skinkie committed Jan 20, 2023
2 parents bcd8f52 + 3df0bd0 commit b54e2cd
Show file tree
Hide file tree
Showing 5 changed files with 74 additions and 39 deletions.
18 changes: 15 additions & 3 deletions OJP/OJP_JourneySupport.xsd
View file
Original file line number Diff line number Diff line change
Expand Up @@ -231,7 +231,11 @@
<xs:documentation>Indicates whether this service needs some kind of reservation or booking to run.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element ref="SituationFullRef" minOccurs="0" maxOccurs="unbounded"/>
<xs:element name="SituationFullRefs" type="SituationRefList" minOccurs="0">
<xs:annotation>
<xs:documentation>A list of references to SITUATIONs.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="Extension" type="xs:anyType" minOccurs="0"/>
</xs:sequence>
</xs:complexType>
Expand Down Expand Up @@ -338,7 +342,11 @@
</xs:annotation>
</xs:element>
<xs:group ref="StopCallStatusGroup"/>
<xs:element ref="SituationFullRef" minOccurs="0" maxOccurs="unbounded"/>
<xs:element name="SituationFullRefs" type="SituationRefList" minOccurs="0">
<xs:annotation>
<xs:documentation>A list of references to SITUATIONs.</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
</xs:complexType>
<xs:group name="StopCallStatusGroup">
Expand Down Expand Up @@ -433,7 +441,11 @@
<xs:documentation>Container with information on booking possibilities for this service.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element ref="SituationFullRef" minOccurs="0" maxOccurs="unbounded"/>
<xs:element name="SituationFullRefs" type="SituationRefList" minOccurs="0">
<xs:annotation>
<xs:documentation>A list of references to SITUATIONs.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="Extension" type="xs:anyType" minOccurs="0"/>
</xs:sequence>
</xs:complexType>
Expand Down
5 changes: 5 additions & 0 deletions OJP/OJP_PlaceSupport.xsd
View file
Original file line number Diff line number Diff line change
Expand Up @@ -430,6 +430,11 @@
</xs:annotation>
</xs:element>
<xs:element name="GeoPosition" type="siri:LocationStructure"/>
<xs:element name="SituationFullRefs" type="SituationRefList" minOccurs="0">
<xs:annotation>
<xs:documentation>SITUATION reference. Mostly used for STOP PLACE, SCHEDULED STOP POINT (StopPoint). However, in future a situation reference may occur on many geographic elements (e.g. roads) as well.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="Attribute" type="GeneralAttributeStructure" minOccurs="0" maxOccurs="unbounded">
<xs:annotation>
<xs:documentation>Attribute associated with this place.</xs:documentation>
Expand Down
8 changes: 8 additions & 0 deletions OJP/OJP_SituationSupport.xsd
View file
Original file line number Diff line number Diff line change
Expand Up @@ -31,4 +31,12 @@
<xs:extension base="siri:SituationFullRefStructure"/>
</xs:complexContent>
</xs:complexType>
<xs:complexType name="SituationRefList">
<xs:annotation>
<xs:documentation>List of references to SITUATIONs.</xs:documentation>
</xs:annotation>
<xs:sequence>
<xs:element ref="SituationFullRef" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
</xs:schema>
5 changes: 5 additions & 0 deletions OJP/OJP_StopEvents.xsd
View file
Original file line number Diff line number Diff line change
Expand Up @@ -227,6 +227,11 @@
</xs:annotation>
</xs:element>
<xs:group ref="OperatingDaysGroup" minOccurs="0"/>
<xs:element name="SituationFullRefs" type="SituationRefList" minOccurs="0">
<xs:annotation>
<xs:documentation>For SITUATIONs that affect the whole StopEvent. Otherwise References for SITUATIONs can be added at the different CALL elements</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="Extension" type="xs:anyType" minOccurs="0"/>
</xs:sequence>
</xs:complexType>
Expand Down
77 changes: 41 additions & 36 deletions OJP/OJP_Trips.xsd
View file
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,7 @@
<xs:element name="OptimisationMethod" type="OptimisationMethodEnumeration"/>
<xs:element name="OptimisationMethods" type="OptimisationMethodList" 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:documentation>The types of algorithm that can be used for planning a journey (fastest, least walking, etc.)</xs:documentation>
</xs:annotation>
</xs:element>
</xs:choice>
Expand Down Expand Up @@ -167,7 +167,7 @@
</xs:element>
<xs:element name="IncludeAlternativeOptions" type="xs:boolean" default="false" minOccurs="0">
<xs:annotation>
<xs:documentation>Whether altnerative 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://tel.archives-ouvertes.fr/tel-01848737). However, what the alternative options are may vary widely depending on the optimisation methods and filters.</xs:documentation>
<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="IncludeFare" type="xs:boolean" default="false" minOccurs="0">
Expand All @@ -182,13 +182,13 @@
</xs:element>
<xs:element name="HikingProfile" default="easy" minOccurs="0" maxOccurs="1">
<xs:annotation>
<xs:documentation>Users hiking profile. The main element to control general walking behaviour is WalkSpeed (together with accessibility constraints). Note: possible explanations in German can be found here: https://akademie.alpinewelten.com/bergwandern/klassifizierung-von-wanderwegen#:~:text=Die%20Kategorie%20Blau,Sturzes%20drastische%20Konsequenzen%20haben%20w%C3%BCrden</xs:documentation>
<xs:documentation>Users hiking profile. The main element to control general walking behaviour is WalkSpeed (together with accessibility constraints). Note: possible explanations in German can be found here: https://akademie.alpinewelten.com/bergwandern/klassifizierung-von-wanderwegen</xs:documentation>
</xs:annotation>
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:enumeration value="easy">
<xs:annotation>
<xs:documentation>Regular hiking/walking in valleys and plains and easy mountain trails e.g. yellow hiking signs in Switzerland or blue in Germany</xs:documentation>
<xs:documentation>Regular hiking/walking in valleys and plains and easy mountain trails e.g. yellow hiking signs in Switzerland or blue in Germany.</xs:documentation>
</xs:annotation>
</xs:enumeration>
<xs:enumeration value="medium">
Expand All @@ -206,23 +206,23 @@
</xs:element>
<xs:element name="CyclingProfile" default="fast" minOccurs="0" maxOccurs="1">
<xs:annotation>
<xs:documentation>Users cycling profile (especially for sportive activities).</xs:documentation>
<xs:documentation>Cycling profile of the user (especially for sportive activities).</xs:documentation>
</xs:annotation>
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:enumeration value="fast">
<xs:annotation>
<xs:documentation>fastest cycle route</xs:documentation>
<xs:documentation>Fastest cycle route</xs:documentation>
</xs:annotation>
</xs:enumeration>
<xs:enumeration value="green">
<xs:annotation>
<xs:documentation>greenest cycle route</xs:documentation>
<xs:documentation>Greenest cycle route</xs:documentation>
</xs:annotation>
</xs:enumeration>
<xs:enumeration value="comfortable">
<xs:annotation>
<xs:documentation>family friendly and leisurely route</xs:documentation>
<xs:documentation>Family friendly and leisurely route</xs:documentation>
</xs:annotation>
</xs:enumeration>
</xs:restriction>
Expand All @@ -237,7 +237,7 @@
</xs:group>
<xs:complexType name="OptimisationMethodList">
<xs:annotation>
<xs:documentation>List of OptimisationMethods. The order of precedence - if used at all - is high to low. In single criteria optimisers the optimisation methods may be used in parallel and not truely used to score the results.</xs:documentation>
<xs:documentation>List of OptimisationMethods. The order of precedence - if used at all - is high to low. In single criteria optimisers the optimisation methods may be used in parallel and not truly used to score the results.</xs:documentation>
</xs:annotation>
<xs:sequence>
<xs:element name="OptimisationMethod" type="OptimisationMethodEnumeration" maxOccurs="unbounded"/>
Expand All @@ -262,18 +262,17 @@
<xs:enumeration value="earliestArrivalAndLatestDeparture"/>
<xs:enumeration value="environmentalSafety">
<xs:annotation>
<xs:documentation>If set, favour "green" modes/lines such as bike sharing and (electric) trains, avoid or restrict modes/lines known for higher CO2 emissions such as (conventional) taxi, ridehailing or coach.</xs:documentation>
<xs:documentation>If set, favour "green" modes/lines such as bike sharing and (electric) trains, avoid or restrict modes/lines known for higher CO2 emissions such as (conventional) taxi, ride-hailing or coach.</xs:documentation>
</xs:annotation>
</xs:enumeration>
<xs:enumeration value="extraSafe">
<xs:annotation>
<xs:documentation>High level of safety (refering to crime, hazards or prone to accidents). If used, certain modes, lines or zones/districts known for lower safety, i.e. higher risk of accidents and crime, may be avoided, others may be preferred. This may depend on the actual, local or time of day situation. E.g. bike or scooter may be considered unsafe in some cities/districts while safe in others.</xs:documentation>
<xs:documentation>High level of safety (referring to crime, hazards or prone to accidents). If used, certain modes, lines or zones/districts known for lower safety, i.e. higher risk of accidents and crime, may be avoided, others may be preferred. This may depend on the actual, local or time of day situation. E.g. bike or scooter may be considered unsafe in some cities/districts while safe in others.</xs:documentation>
</xs:annotation>
</xs:enumeration>
<xs:enumeration value="extraReliable">
<xs:annotation>
<xs:documentation>Low probability of delays, cancellations etc. If used, modes known for their (un)reliability may be avoided/preferred, and extra time added for transfers. This may depend on the actual, local or time of day situation,
based on punctuality statics, traffic jam statistics or rush hours. E.g. taxis in a given city might be known to be unreliable during at 8-10 and 16-19 hours, otherwise reliable.</xs:documentation>
<xs:documentation>Low probability of delays, cancellations etc. If used, modes known for their (un)reliability may be avoided/preferred, and extra time added for transfers. This may depend on the actual, local or time of day situation, based on punctuality statics, traffic jam statistics or rush hours. E.g. taxis in a given city might be known to be unreliable during at 8-10 and 16-19 hours, otherwise reliable.</xs:documentation>
</xs:annotation>
</xs:enumeration>
<xs:enumeration value="scenic">
Expand Down Expand Up @@ -416,7 +415,11 @@ based on punctuality statics, traffic jam statistics or rush hours. E.g. taxis i
</xs:annotation>
</xs:element>
<xs:group ref="OperatingDaysGroup" minOccurs="0"/>
<xs:element ref="SituationFullRef" minOccurs="0" maxOccurs="unbounded"/>
<xs:element name="SituationFullRefs" type="SituationRefList" minOccurs="0">
<xs:annotation>
<xs:documentation>A list of references to SITUATIONs.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="Extension" type="xs:anyType" minOccurs="0"/>
</xs:sequence>
</xs:complexType>
Expand Down Expand Up @@ -461,7 +464,11 @@ based on punctuality statics, traffic jam statistics or rush hours. E.g. taxis i
</xs:annotation>
</xs:element>
<xs:group ref="OperatingDaysGroup" minOccurs="0"/>
<xs:element ref="SituationFullRef" minOccurs="0" maxOccurs="unbounded"/>
<xs:element name="SituationFullRefs" type="SituationRefList" minOccurs="0">
<xs:annotation>
<xs:documentation>A list of references to SITUATIONs.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:group ref="TripStatusGroup" minOccurs="0"/>
<xs:element name="Extension" type="xs:anyType" minOccurs="0"/>
</xs:sequence>
Expand Down Expand Up @@ -626,7 +633,11 @@ based on punctuality statics, traffic jam statistics or rush hours. E.g. taxis i
<xs:documentation>Structured model further describing this interchange, its geographic embedding and accessibility.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element ref="SituationFullRef" minOccurs="0" maxOccurs="unbounded"/>
<xs:element name="SituationFullRefs" type="SituationRefList" minOccurs="0">
<xs:annotation>
<xs:documentation>A list of references to SITUATIONs.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="Extension" type="xs:anyType" minOccurs="0"/>
</xs:sequence>
</xs:complexType>
Expand Down Expand Up @@ -714,24 +725,24 @@ based on punctuality statics, traffic jam statistics or rush hours. E.g. taxis i
</xs:complexType>
<xs:complexType name="PathGuidanceStructure">
<xs:annotation>
<xs:documentation>Description of a piece of a TRIP. May include geographic information, turn instructions and accessibility information.</xs:documentation>
<xs:documentation> description of a piece of a TRIP. May include geographic information, turn instructions and accessibility information </xs:documentation>
</xs:annotation>
<xs:sequence>
<xs:element name="PathGuidanceSection" type="PathGuidanceSectionStructure" maxOccurs="unbounded">
<xs:annotation>
<xs:documentation>One or more PATH GUIDANCE sections that form the LEG. For a good PATH GUIDANCE a fine granularity of the sections may be needed. This may also depend on the MODE and the type of guidance required.</xs:documentation>
<xs:documentation>one or more path guidance sections that build the trip Leg</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
</xs:complexType>
<xs:complexType name="PathGuidanceSectionStructure">
<xs:annotation>
<xs:documentation>An extended definition of a NAVIGATION PATH in TMv6 and PATH GUIDANCE to include the textual navigation instructions. Description of a part of a TRIP. May include geographic information, turn instructions and accessibility information.</xs:documentation>
<xs:documentation>[an extended definition of a NAVIGATION PATH in TMv6 to include the textual navigation instructions] description of a piece of a TRIP. May include geographic information, turn instructions and accessibility information </xs:documentation>
</xs:annotation>
<xs:sequence>
<xs:element name="TrackSection" type="TrackSectionStructure" minOccurs="0">
<xs:annotation>
<xs:documentation>LINK PROJECTION on the infrastructure network of the LEG together with time information</xs:documentation>
<xs:documentation>LINK PROJECTION on the infrastructure network of the TRIP LEG together with time information</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="TurnDescription" type="InternationalTextStructure" minOccurs="0">
Expand All @@ -741,40 +752,34 @@ based on punctuality statics, traffic jam statistics or rush hours. E.g. taxis i
</xs:element>
<xs:element name="GuidanceAdvice" type="GuidanceAdviceEnumeration" minOccurs="0">
<xs:annotation>
<xs:documentation>Various types of guidance advice given to traveller.</xs:documentation>
<xs:documentation>various types of guidance advice given to travelle.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="TurnAction" type="TurnActionEnumeration" minOccurs="0">
<xs:annotation>
<xs:documentation>The range of alternative turns that can be described.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="RoadName" type="InternationalTextStructure" minOccurs="0">
<xs:annotation>
<xs:documentation>Road name</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="Follow" type="FollowStructure" minOccurs="0" maxOccurs="unbounded">
<xs:annotation>
<xs:documentation>Signs, roads, POI to follow.</xs:documentation>
<xs:documentation>the range of alternative turns that can be described.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="DirectionHint" type="InternationalTextStructure" minOccurs="0">
<xs:annotation>
<xs:documentation>Textual direction hint for better understanding, e.g. "follow signs to Hamburg".</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="AbsoluteBearing" type="siri:AbsoluteBearingType" minOccurs="0">
<xs:element name="Bearing" type="siri:AbsoluteBearingType" minOccurs="0">
<xs:annotation>
<xs:documentation>Absolute bearing (sky direction) after the described manoeuvre.</xs:documentation>
<xs:documentation>Absolute bearing after the described manoeuvre.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="PathLink" type="PathLinkStructure" minOccurs="0">
<xs:annotation>
<xs:documentation>Description of the type of accessibility on this navigation section. This view is simplified in comparison to the NeTEx PathLink structure.</xs:documentation>
<xs:documentation>Description of the type of accessibility on this navigation section.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="SituationFullRefs" type="SituationRefList" minOccurs="0">
<xs:annotation>
<xs:documentation>A list of references to SITUATIONs.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="SituationFullRef" type="SituationFullRefStructure" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
<xs:complexType name="FollowStructure">
Expand Down

0 comments on commit b54e2cd

Please sign in to comment.