From 69103f7489a485a7cf3de5afecff55e288351702 Mon Sep 17 00:00:00 2001 From: github-actions <41898282+github-actions[bot]@users.noreply.github.com> Date: Tue, 26 Sep 2023 11:44:39 +0000 Subject: [PATCH] Lint and update documentation tables --- docs/generated/index.html | 12 ++++++------ .../trip/TR_11_request_with_ItModeToCover.xml | 2 +- 2 files changed, 7 insertions(+), 7 deletions(-) diff --git a/docs/generated/index.html b/docs/generated/index.html index d2ea907f0..86d227485 100644 --- a/docs/generated/index.html +++ b/docs/generated/index.html @@ -718,7 +718,7 @@
OptimisationMethod
0:1
The type of algorithm to be used in the calculation of the trip (fastest, least walking, etc.).
ConsiderElevationData
0:1
xs:boolean
Whether the trip calculation should take elevation data into account (bike, walk). Default is FALSE.
Then, the element contains one of the following elements:
The element contains a sequence of the following elements:
ItModesToCover
-0:*
For each mode in this list a separate monomodal trip shall be found - in addition to inter-modal solutions.
IncludeAlternativeOptions
-0:1
xs:boolean
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.
IncludeAllRestrictedLines
-0:1
xs:boolean
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, irrespective of the selected passenger categories or the MotorisedMainTravelMode. 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. Restricted trumps PassengerCategory, for example. If Restricted is set to true, all services are displayed.
PassengerCategory
-0:*
Sequence of all passenger categories, for which this search shall be conducted. In rare cases additional offerings may be available (e.g., demand responsive service with certain areas being reserved for seniors). If multiple PassengerCategories are provided, then Services are shown when they are available for at least one PassengerCategory.
b
MotorisedMainTravelMode
-0:1
xs:boolean
The MotorisedMainTravelMode defines whether the trip planner works in PT mode (or pure IT mode) or includes carTransportRail and the like. If set to true (e.g. because one travels by car, truck or motorcycle), then carTransportRail, ferry are used together with roads.
Then, the element contains one of the following elements:
The element contains a sequence of the following elements:
ItModeToCover
-0:*
For each mode in this list a separate monomodal trip shall be found - in addition to inter-modal solutions.
IncludeAlternativeOptions
-0:1
xs:boolean
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.
IncludeAllRestrictedLines
-0:1
xs:boolean
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, irrespective of the selected passenger categories or the MotorisedMainTravelMode. 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. Restricted trumps PassengerCategory, for example. If Restricted is set to true, all services are displayed.
PassengerCategory
-0:*
Sequence of all passenger categories, for which this search shall be conducted. In rare cases additional offerings may be available (e.g., demand responsive service with certain areas being reserved for seniors). If multiple PassengerCategories are provided, then Services are shown when they are available for at least one PassengerCategory.
b
MotorisedMainTravelMode
-0:1
xs:boolean
The MotorisedMainTravelMode defines whether the trip planner works in PT mode (or pure IT mode) or includes carTransportRail and the like. If set to true (e.g. because one travels by car, truck or motorcycle), then carTransportRail, ferry are used together with roads.
IncludeTrackSections
0:1
xs:boolean
Whether the result should include TrackSection elements to describe the geographic route of each journey leg.
OptimisationMethod
0:1
The type of algorithm to be used in the calculation of the trip (fastest, least walking, etc.).
ConsiderElevationData
0:1
xs:boolean
Whether the trip calculation should take elevation data into account (bike, walk). Default is FALSE.
The element contains one of the following elements:
The element contains a sequence of the following elements:
ItModesToCover
-0:*
For each mode in this list a separate monomodal trip shall be found - in addition to inter-modal solutions.
IncludeAlternativeOptions
-0:1
xs:boolean
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.
IncludeAllRestrictedLines
-0:1
xs:boolean
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, irrespective of the selected passenger categories or the MotorisedMainTravelMode. 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. Restricted trumps PassengerCategory, for example. If Restricted is set to true, all services are displayed.
PassengerCategory
-0:*
Sequence of all passenger categories, for which this search shall be conducted. In rare cases additional offerings may be available (e.g., demand responsive service with certain areas being reserved for seniors). If multiple PassengerCategories are provided, then Services are shown when they are available for at least one PassengerCategory.
b
MotorisedMainTravelMode
-0:1
xs:boolean
The MotorisedMainTravelMode defines whether the trip planner works in PT mode (or pure IT mode) or includes carTransportRail and the like. If set to true (e.g. because one travels by car, truck or motorcycle), then carTransportRail, ferry are used together with roads.
The element contains one of the following elements:
The element contains a sequence of the following elements:
ItModeToCover
-0:*
For each mode in this list a separate monomodal trip shall be found - in addition to inter-modal solutions.
IncludeAlternativeOptions
-0:1
xs:boolean
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.
IncludeAllRestrictedLines
-0:1
xs:boolean
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, irrespective of the selected passenger categories or the MotorisedMainTravelMode. 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. Restricted trumps PassengerCategory, for example. If Restricted is set to true, all services are displayed.
PassengerCategory
-0:*
Sequence of all passenger categories, for which this search shall be conducted. In rare cases additional offerings may be available (e.g., demand responsive service with certain areas being reserved for seniors). If multiple PassengerCategories are provided, then Services are shown when they are available for at least one PassengerCategory.
b
MotorisedMainTravelMode
-0:1
xs:boolean
The MotorisedMainTravelMode defines whether the trip planner works in PT mode (or pure IT mode) or includes carTransportRail and the like. If set to true (e.g. because one travels by car, truck or motorcycle), then carTransportRail, ferry are used together with roads.
TripMobilityFilterGroup
group
| Parameters the user can set to restrict the mobility options - particularly for interchanging. | ||||
BaseTripMobilityFilter |
| 0:1 | xs:boolean | The user is not able to pass over (or wants to avoid) single steps. Stairs and non-level entrances are not excluded. | |
| 0:1 | The type of algorithm to be used in the calculation of the trip (fastest, least walking, etc.). | |||
| 0:1 | xs:boolean | Whether the trip calculation should take elevation data into account (bike, walk). Default is FALSE. | ||
Then, the element contains one of the following elements: | |||||
The element contains a sequence of the following elements: | |||||
TripPolicy |
| -0:* | For each mode in this list a separate monomodal trip shall be found - in addition to inter-modal solutions. | ||
| -0:1 | xs:boolean | 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. | ||
| -0:1 | xs:boolean | 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, irrespective of the selected passenger categories or the MotorisedMainTravelMode. 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. Restricted trumps PassengerCategory, for example. If Restricted is set to true, all services are displayed. | ||
| -0:* | Sequence of all passenger categories, for which this search shall be conducted. In rare cases additional offerings may be available (e.g., demand responsive service with certain areas being reserved for seniors). If multiple PassengerCategories are provided, then Services are shown when they are available for at least one PassengerCategory. | |||
b |
| -0:1 | xs:boolean | The MotorisedMainTravelMode defines whether the trip planner works in PT mode (or pure IT mode) or includes carTransportRail and the like. If set to true (e.g. because one travels by car, truck or motorcycle), then carTransportRail, ferry are used together with roads. | |
Then, the element contains one of the following elements: | |||||
The element contains a sequence of the following elements: | |||||
TripPolicy |
| -0:* | For each mode in this list a separate monomodal trip shall be found - in addition to inter-modal solutions. | ||
| -0:1 | xs:boolean | 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. | ||
| -0:1 | xs:boolean | 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, irrespective of the selected passenger categories or the MotorisedMainTravelMode. 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. Restricted trumps PassengerCategory, for example. If Restricted is set to true, all services are displayed. | ||
| -0:* | Sequence of all passenger categories, for which this search shall be conducted. In rare cases additional offerings may be available (e.g., demand responsive service with certain areas being reserved for seniors). If multiple PassengerCategories are provided, then Services are shown when they are available for at least one PassengerCategory. | |||
b |
| -0:1 | xs:boolean | The MotorisedMainTravelMode defines whether the trip planner works in PT mode (or pure IT mode) or includes carTransportRail and the like. If set to true (e.g. because one travels by car, truck or motorcycle), then carTransportRail, ferry are used together with roads. | |
BaseTripContentFilter |
| 0:1 | xs:boolean | Whether the result should include TrackSection elements to describe the geographic route of each journey leg. | |
b |
| -0:1 | Shared mobility offer. | ||
c |
| -1:1 | |||
| 0:1 | Container with information on booking possibilities for this service. | |||
| 0:1 | A list of references to SITUATIONs. | |||
| 0:1 | xs:anyType |
VehiclePositionStructure
| Geographical and logical position of a vehicle. | ||||
The element contains a sequence of the following elements: | |||||
| 0:1 | siri:LocationStructure | Geographic position of vehicle. | ||
| 0:1 | Logical progress of vehicle relative to service pattern. | |||
| 0:1 | siri:AbsoluteBearingType | Bearing in compass degrees in which vehicle is heading (expected to be consistent with Transmodel ROUTE -or LEG TRACK- and PATH GUIDANCE). | ||
| 0:1 | siri:ProgressBetweenStopsStructure | Provides information about the progress of the vehicle along its current link, that is link from previous visited top to current position. |
PlaceContextStructure
| [a view of PLACE in TMv6] a PLACE and access to it by individual transport | ||||
The element contains a sequence of the following elements: | |||||
Then, the element contains one of the following elements: | |||||
a |
| -1:1 | Static place. | ||
b |
| -1:1 | Location within a (moving) vehicle. | ||
Then, the element contains one of the following elements: | |||||
a |
| -0:1 | xs:dateTime | Time when departure/arrival from/to location is required. | |
b |
| -0:1 | xs:duration | Extra time needed before reaching/after leaving this location (an example of a TRIP ACCESS CONSTRAINT. In Transmodel it is modeled more extensively and could relate to ACCESS MODE e.g. walk max 5 mintues, but cycle 10 minutes). | |
| 0:* | Options how to access/leave the place by individual transport. |
NumberOfResultsGroup
group
| parameter to control the number of TRIP results before/after a point in time. May NOT be used when departure time at origin AND arrival time at destination are set | ||||
b |
| -0:1 | Shared mobility offer. | ||
c |
| -1:1 | |||
| 0:1 | Container with information on booking possibilities for this service. | |||
| 0:1 | A list of references to SITUATIONs. | |||
| 0:1 | xs:anyType |
VehiclePositionStructure
| Geographical and logical position of a vehicle. | ||||
The element contains a sequence of the following elements: | |||||
| 0:1 | siri:LocationStructure | Geographic position of vehicle. | ||
| 0:1 | Logical progress of vehicle relative to service pattern. | |||
| 0:1 | siri:AbsoluteBearingType | Bearing in compass degrees in which vehicle is heading (expected to be consistent with Transmodel ROUTE -or LEG TRACK- and PATH GUIDANCE). | ||
| 0:1 | siri:ProgressBetweenStopsStructure | Provides information about the progress of the vehicle along its current link, that is link from previous visited top to current position. |
PlaceContextStructure
| [a view of PLACE in TMv6] a PLACE and access to it by individual transport | ||||
The element contains a sequence of the following elements: | |||||
Then, the element contains one of the following elements: | |||||
a |
| -1:1 | Static place. | ||
b |
| -1:1 | Location within a (moving) vehicle. | ||
Then, the element contains one of the following elements: | |||||
a |
| -0:1 | xs:dateTime | Time when departure/arrival from/to location is required. | |
b |
| -0:1 | xs:duration | Extra time needed before reaching/after leaving this location (an example of a TRIP ACCESS CONSTRAINT. In Transmodel it is modeled more extensively and could relate to ACCESS MODE e.g. walk max 5 mintues, but cycle 10 minutes). | |
| 0:* | Options how to access/leave the place by individual transport. |
NumberOfResultsGroup
group
| parameter to control the number of TRIP results before/after a point in time. May NOT be used when departure time at origin AND arrival time at destination are set | ||||
NumberOfResults |
| 1:1 | xs:nonNegativeInteger | The desired number of trip results before the given time (at origin or destination). | |
| 1:1 | xs:nonNegativeInteger | The desired number of trip results after the given time (at origin or destination). |
BaseTripPolicyGroup
group
| Policies that control the trip search behaviour for both public and individual transport. |
VehicleFilterStructure
| Filter for Vehicles | ||||
The element contains a sequence of the following elements: | |||||
| 0:1 | xs:boolean | Whether to include or exclude given VehicleRefs and TRAIN NUMBERS in the list from the search. Default is exclude. | ||
| 0:* | siri:VehicleRefStructure | Reference to VEHICLE | ||
| 0:* | xs:normalizedString | TRAIN NUMBERs |
AlternativeServiceUsageGroup
group
| Usage parameters of a sharing service. | ||||
AlternativeServiceUsage |
| 0:1 | xs:duration | Typical time a user will need to check in and unlock the vehicle. | |
| 0:1 | xs:duration | Typical time a user will need to lock the vehicle and check out. |
AlternativeServiceStructure
| Service that provides shared vehicles (The Transmodel MODE OF OPERATION is VEHICLE SHARING; other related Transmodel concepts: ALTERNATIVE MODE LEG.SINGLE JOURNEY.COMMON.VEHICLE SERVICE.TRANSPORT ORGANISATION). | ||||
The element contains a sequence of the following elements: | |||||
| 1:1 | ||||
| 1:1 | siri:OperatorRefStructure | Identifier of the operator of the sharing service | ||
| 0:1 | xs:string | Public name of the service. | ||
| 0:1 | Type of the sharing scheme. |
AlternativeServiceStructure
| Service that provides shared vehicles (The Transmodel MODE OF OPERATION is VEHICLE SHARING; other related Transmodel concepts: ALTERNATIVE MODE LEG.SINGLE JOURNEY.COMMON.VEHICLE SERVICE.TRANSPORT ORGANISATION). | ||||
The element contains a sequence of the following elements: | |||||
| 1:1 | ||||
| 1:1 | siri:OperatorRefStructure | Identifier of the operator of the sharing service | ||
| 0:1 | xs:string | Public name of the service. | ||
| 0:1 | Type of the sharing scheme. | |||
AlternativeServiceUsage |
| 0:1 | xs:duration | Typical time a user will need to check in and unlock the vehicle. | |
| 0:1 | xs:duration | Typical time a user will need to lock the vehicle and check out. | ||
| 0:1 | Link to web page providing more details on service. | |||
| 0:1 | xs:boolean | 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. | ||
| 0:1 | Information about the restriction. |
OwnerRefStructure
| Reference to an ORGANISATION with ownership as the RESPONSIBILITY ROLE |
OwnerRef
| Reference to an ORGANISATION with ownership as the RESPONSIBILITY ROLE |
OperatingDayRefStructure
| Reference to an Operating Day |
OperatingDayRef
| Reference to an Operating Day |
OperatingDaysStructure
| [TMv6] day of public transport operation of which the characteristics are defined in a specific SERVICE CALENDAR and which may last more than 24 hours. This is useful, when the trip can be made during several days. Often users search in "general" withouth setting a date and then refine with the actual date. By using OperatingDaysStructure the result can directly be reused without an additional OJPTripRequest. | ||||
The element contains a sequence of the following elements: | |||||
| 1:1 | xs:date | Start date of period. | ||
| 1:1 | xs:date | End date of period. | ||
| 1:1 | Bit pattern for operating days between start date and end date. The length of the pattern is equal to the number of days from start date to end date. A bit value of "1" indicates that an event actually happens on the day that is represented by the bit position. |
OperatingDaysGroup
group
| Coded as bit pattern |
ServiceFacilityGroup
group
| Wrapper for SIRI service facilities. | ||||
|
| sharing | stationLessSharing | stationBasedSharing | peerToPeerSharing | parkAndRideSharing | sharingClubSharing | prM | pooling | taxi | shuttle | dynamicPooling | longDistancePooling | commuterPooling | parkAndRidePooling | chauffeured | demandResponsive | flexibleArea | school | companyShuttle | hotelShuttle | other | ALTERNATIVE MODE OF OPERATION offered. |
| scheduled | demandResponsive | flexibleRoute | flexibleArea | shuttle | pooling | replacement | pRM | Types of MODES OF OPERATION are scheduled, classic and also flexible. From NeTEx. |
| walk | cycle | car | motorcycle | truck | scooter | other | TYPE OF MODE than can be used in an individual context. |
| self | own | otherOwned | lease | hire | PERSONAL MODE OF OPERATION |
| walk | shuttle | taxi | protectedConnection | guaranteedConnection | remainInVehicle | changeWithinVehicle | checkIn | checkOut | parkAndRide | bikeAndRide | carHire | bikeHire | other | TYPE OF TRANSFER. It is a mix between MODE information, MODE OF OPERATION information and a more stringent TYPE OF TRANSFER. |
IndividualTransportOptionsStructure
| Individual modes and their usage limits as stated by the passenger (TRIP ACCESS CONSTRAINT). | ||||
The element contains a sequence of the following elements: | |||||
| 0:1 | Mode of individual transport. When mode self-drive-car is used the connection to another mode will need a parking space for the car. Thus, this mode is a generalisation of all park and ride use cases. The mode others-drive-car, however, only needs a place to let a person be set down from a car. | |||
| 1:1 | Mode | |||
| 0:1 | siri:DistanceType | Maximum distance in meters. If given, it restricts the maximum distance of routes with the given mode. | ||
| 0:1 | xs:duration | Maximum duration. If given, it restricts the maximum time of routes with the given mode. | ||
| 0:1 | siri:DistanceType | Minimum distance in meters. If given, it restricts the minimum distance of routes with the given mode. | ||
| 0:1 | xs:duration | Minimum duration. If given, it restricts the minimum time of routes with the given mode. | ||
| 0:1 | Relative speed in percent. If given slows the standard speed (below 100) or fasten it (above 100). | |||
| 0:1 | xs:duration | Additional time added to the actual traveling time needed to use a specific mode. |
ModeStructure
| [a specialisation of MODE in TMv6] an extended range of VEHICLE MODEs, aggregating them with some SUBMODEs | ||||
The element contains a sequence of the following elements: |
| sharing | stationLessSharing | stationBasedSharing | peerToPeerSharing | parkAndRideSharing | sharingClubSharing | prM | pooling | taxi | shuttle | dynamicPooling | longDistancePooling | commuterPooling | parkAndRidePooling | chauffeured | demandResponsive | flexibleArea | school | companyShuttle | hotelShuttle | other | ALTERNATIVE MODE OF OPERATION offered. |
| scheduled | demandResponsive | flexibleRoute | flexibleArea | shuttle | pooling | replacement | pRM | Types of MODES OF OPERATION are scheduled, classic and also flexible. From NeTEx. |
| walk | cycle | car | motorcycle | truck | scooter | other | TYPE OF MODE than can be used in an individual context. |
| self | own | otherOwned | lease | hire | PERSONAL MODE OF OPERATION |
| walk | shuttle | taxi | protectedConnection | guaranteedConnection | remainInVehicle | changeWithinVehicle | checkIn | checkOut | parkAndRide | bikeAndRide | carHire | bikeHire | other | TYPE OF TRANSFER. It is a mix between MODE information, MODE OF OPERATION information and a more stringent TYPE OF TRANSFER. |
IndividualTransportOptionsStructure
| Individual modes and their usage limits as stated by the passenger (TRIP ACCESS CONSTRAINT). | ||||
The element contains a sequence of the following elements: | |||||
| 0:1 | Mode of individual transport. When mode self-drive-car is used the connection to another mode will need a parking space for the car. Thus, this mode is a generalisation of all park and ride use cases. The mode others-drive-car, however, only needs a place to let a person be set down from a car. | |||
| 1:1 | Mode | |||
| 0:1 | siri:DistanceType | Maximum distance in meters. If given, it restricts the maximum distance of routes with the given mode. | ||
| 0:1 | xs:duration | Maximum duration. If given, it restricts the maximum time of routes with the given mode. | ||
| 0:1 | siri:DistanceType | Minimum distance in meters. If given, it restricts the minimum distance of routes with the given mode. | ||
| 0:1 | xs:duration | Minimum duration. If given, it restricts the minimum time of routes with the given mode. | ||
| 0:1 | Relative speed in percent. If given slows the standard speed (below 100) or fasten it (above 100). | |||
| 0:1 | xs:duration | Additional time added to the actual traveling time needed to use a specific mode. |
ModeStructure
| [a specialisation of MODE in TMv6] an extended range of VEHICLE MODEs, aggregating them with some SUBMODEs | ||||
The element contains a sequence of the following elements: | |||||
Mode |
| 1:1 | siri:VehicleModesOfTransportEnumeration | Categorisation of mode | |
| |||||
| 0:1 | Name of the mode. | |||
| 0:1 | Short name or acronym of the mode. | |||
| 0:1 | Additional text that further describes the mode. |
ModeGroup
group
| Elements for a Transport Mode |