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.

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

Stratification of transport mode enumerations #791

Open
wants to merge 3 commits into
base: next
Choose a base branch
from

Conversation

trurlurl
Copy link
Collaborator

This resolves issue #772. Stratified VehicleModeEnumeration, AllVehicleModesOfTransportEnumeration, AllModesEnumeration to ony two: AllVehicleModesOfTransportEnumeration and AllModesOfTransportEnumeration.

VehicleMode now uniformly maps to AllVehicleModesOfTransportEnumeration.
TransportMode maps to both AllVehicleModesOfTransportEnumeration and AllModesOfTransportEnumeration, but context and annotations prevent confusion, in my view.

The changes should keep backwards compatibilty, though I changed the mappings (to an enumeration type) at a few places where I thought the chosen enumeration likely to be erroneous. I'm going to mark them in this PR.

@trurlurl trurlurl added enhancement non semantic enhacement: technical enhancement, etc. needs documentation update The NeTEx document needs to be updated labels Oct 18, 2024
@trurlurl trurlurl added this to the netex_2.0 milestone Oct 18, 2024
@@ -731,7 +731,7 @@ Rail transport, Roads and Road transport
<xsd:documentation>Elements for an TRANSPORT ADMINISTRATIVE ZONE.</xsd:documentation>
</xsd:annotation>
<xsd:sequence>
<xsd:element name="VehicleModes" type="AllModesListOfEnumerations" default="all" minOccurs="0">
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

This looks like having been the wrong before.

@@ -114,9 +114,9 @@ Rail transport, Roads and Road transport
<xsd:documentation>Elements for a TICKETING EQUIPMENT.</xsd:documentation>
</xsd:annotation>
<xsd:sequence>
<xsd:element name="VehicleModes" type="AllModesListOfEnumerations" minOccurs="0">
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

This looks like having been the wrong before.

@@ -112,41 +112,13 @@ Rail transport, Roads and Road transport
<xsd:list itemType="AccessModeEnumeration"/>
</xsd:simpleType>
<!--======Vehicle===================================================================================-->
<xsd:element name="VehicleMode" type="AllModesEnumeration">
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

This looks like having been the wrong before.

<!--======Modes===================================================================================-->
<xsd:element name="RoadVehicleMode" type="AllModesEnumeration">
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

This looks like having been the wrong before.

skinkie
skinkie previously approved these changes Oct 18, 2024
Copy link
Contributor

@skinkie skinkie left a comment

Choose a reason for hiding this comment

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

You get my approval because the tests / checks succeed not because I am at academic level aware if this change is "transmodel compliant" etc.

In all cases: simplification is a good job.

@Aurige
Copy link
Contributor

Aurige commented Oct 29, 2024

@Aurige @Ulf9 @nick-knowles to check

Copy link
Collaborator

@Ulf9 Ulf9 Nov 8, 2024

Choose a reason for hiding this comment

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

If we are to make any changes we should try to align the suggested type-names and annotation as far as possible with what Transmodel 6.2 states to not further add to the confusion. I am not sure that the suggested changes do align with Transmodel 6.2. We need to basically separate between the combination of conventional modes of operation with alternative modes of operation on one side i. e. "advertised transport" and personal modes of operation e.g. with your own bike or your own car (when you are not car-sharing) on the other side. This is represented in Transmodel as either PUBLIC TRANSPORT MODE or PERSONAL MODE.
If you wish to generalise PUBLIC TRANSPORT MODE and PERSONAL MODE you use the term MODE.

These three terms are defined in Transmodel as:

MODE :
A broad characterisation of the means of movement and / or operational aspect in consideration (e.g., by bus, by train, by metro, by ferry, by foot, by private car, etc.).


PUBLIC TRANSPORT MODE:
A MODE used for public transport services (e.g., by bus, by tram, by metro, by train, by ferry, by ship, by shared taxi car, by shared car) under either a CONVENTIONAL MODE OF OPERATION or an ALTERNATIVE MODE OF OPERATION (i.e., excluding a PERSONAL MODE OF OPERATION).
Note: Prior to TM 6.2 this was named VEHICLE MODE

PERSONAL MODE :
A MODE used outside of public transport services (e.g., by private car, by private cycle, by private scooter, by private boat) under a PERSONAL MODE OF OPERATION.

Thus, please change the terminology of type-names and annotation accordingly and use capital letters only in accordance with Transmodel.

@ue71603
Copy link
Contributor

ue71603 commented Nov 30, 2024

@trurlurl Can you incorporate the input from Ulf?
Transmodel terms can be found here https://transmodel-cen.eu/model/

@trurlurl
Copy link
Collaborator Author

trurlurl commented Dec 5, 2024

Thank you @Ulf9 ! So, in order to match Transmodel we could

(a) rename AllVehicleModesOfTransportEnumeration to AllPublicTransportModesEnumeration with the annotation: "PUBLIC TRANSPORT MODE: A MODE used for public transport services (e.g., by bus, by tram, by metro, by train, by ferry, by ship, by shared taxi car, by shared car) under either a CONVENTIONAL MODE OF OPERATION or an ALTERNATIVE MODE OF OPERATION (i.e., excluding a PERSONAL MODE OF OPERATION). Note: Prior to TM 6.2 this was named VEHICLE MODE.", and

(b) rename AllModesOfTransportEnumeration to AllModesEnumeration with annotation "All MODEs (PUBLIC TRANSPORT MODEs and PERSONAL MODEs): TPEG pti_table 01."

I would prefer, however, to be able to have, instead of (b): AllTransportModesEnumeration. But having read your explanations, I suspect that "TRANSPORT MODE" is not a Transmodel term and "TRANSPORT" only appears in "PUBLIC TRANSPORT" ? Such that "PUBLIC TRANSPORT MODE" is only a MODE of PUBLIC TRANSPORT and never a PUBLIC "TRANSPORT MODE".

If you agree with that then I'm going to do the necessary changes.

@Aurige
Copy link
Contributor

Aurige commented Dec 7, 2024

If you agree with that then I'm going to do the necessary changes.

That's fine for me ... looks pretty well aligned with Transmodel.
Maybe skip the reference to tpeg since their codes are not stable (or just mention something like "initilised taking into account TPEG pti_table 01, with its 2010 version" ... but that may not really be helpful)

@Aurige
Copy link
Contributor

Aurige commented Dec 11, 2024

Group Decision: Ok

Occurrences were somehow missed by search.
@nick-knowles
Copy link
Contributor

NK NB This afects the name in many UML diagrams. Here are just teh basic ones.

(1) Transport Mode model
image(2) USe of Transport Model
image

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement non semantic enhacement: technical enhancement, etc. needs documentation update The NeTEx document needs to be updated
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants