NeTEx-CEN
Confused by VehicleMode, TransportMode, AllVehicleModesOfTransport, etc.
There are elements like VehicleMode(s), TransportMode(s), OtherTransportModes, Mode that map to the following three enumerations, but in very inconsistent or non-obvious ways: VehicleModeEnumeration, AllVehicleModesOfTransportEnumeration, AllModesEnumeration. It would be helpful to disentangle things a bit - by improving annotations and perhaps, where possible, by renaming elements and the three enumeration types.
What I've found (unless I made some mistake):
- AllVehicleModesOfTransportEnumeration is a superset of VehicleModeEnumeration, with additional values unknown, anyMode, intercityRail, urbanRail
- AllModesEnumeration is a superset of AllVehicleModesOfTransportEnumeration, with additional values foot, bicycle, motorcycle, scooter, car, shuttle
I guess we can't get rid of VehicleModeEnumeration in favor of AllVehicleModesOfTransportEnumeration - or can we? If not, it would be good to describe the difference / rationale.
Could we choose less confusing names? E.g., PrimaryVehicleModesOfTransportEnumeration, AllVehicleModesOfTransportEnumeration, AllModesOfTransportEnumeration?
If the subset-superset hierarchy between the three enumerations were to hold in the future - would it make sense to inherit the values from the subset using the union construct in XSD?
As for the mapping from element names to the enumerations, could we choose more consistent names?
-
I guess that VehicleMode needs to stay for backwards compatibility. But then it would be good if OtherTransportModes (which also maps to VehicleModeEnumeration / PrimaryVehicleModesOfTransportEnumeration) could be renamed to OtherVehicleModes or OtherPrimaryVehicleModes.
-
TransportMode(s) should always map to AllModesEnumeration / AllModesOfTransportEnumeration.
-
A new name VehicleTransportMode might be introduced to consistently map to AllVehicleModesOfTransportEnumeration?
Last question: the plural forms referring to a list should, in principle, start with a lower case (transportModes). Change or leave it (many places)?
Depending on your feedback I would prepare a PR.
I'm open to renaming the enumeration's name and to "merge" some (most probably forgot VehicleModeEnumeration and only keep AllVehicleModesOfTransportEnumeration for example) But that's definitely to be discussed/approved by the group first
Ok for a PR @trurlurl : trying to match TM as much as possible and avoid breaking compatibility With support from @Ulf9 @nick-knowles and me