Merge branch 'master' into doc/python-setup-update

OpenSimulationInterface · Apr 4, 2024 · d45eaf0 · d45eaf0
2 parents ec1882e + 3524cb1
commit d45eaf0
Show file tree

Hide file tree

Showing 4 changed files with 50 additions and 27 deletions.
diff --git a/.github/.pyspelling.yml b/.github/.pyspelling.yml
@@ -17,3 +17,8 @@ matrix:
       delimiters:
       - open: '(?s)^(?P<open> *\/\/)'
         close: '^(?P=open)$'
+  - pyspelling.filters.html:
+      comments: true
+      attributes:
+      - title
+      - alt
diff --git a/.github/spelling_custom_words_en_US.txt b/.github/spelling_custom_words_en_US.txt
@@ -15,11 +15,11 @@ antecessor
 arg
 asam
 atsc
-au
 auch
 auf
 auml
 Ausfahrt
+außer
 Baugebiet
 Baustelle
 Baustellen
@@ -33,7 +33,6 @@ bei
 beleuchtung
 Benrath
 Bereich
-berholt
 Besondere
 Bewohner
 BGBl
@@ -55,7 +54,6 @@ cd
 cellpadding
 cellspacing
 centerline
-chen
 Cianciaruso
 CIE
 cie
@@ -89,6 +87,7 @@ dt
 Duesseldorf
 Durchgangsverkehr
 dvr
+dürfen
 easting
 EBIKES
 edn
@@ -107,7 +106,6 @@ Endeninch
 endlink
 endrules
 engl
-enschaden
 enum
 enums
 eoas
@@ -127,6 +125,8 @@ Fak
 fcm
 fehlende
 Feiertagen
+Flächen
+flächen
 fmu
 Formelsammlung
 Formelzeichen
@@ -138,20 +138,22 @@ fuer
 fullreports
 ge
 geb
+gebührenpflichtig
 Gedeon
 Gefahrenzeichen
 gekennzeichneten
 gekennzeichneter
 Gelegenheitsverkehr
 Geospatial
 gesetze
+geändert
 github
-glichkeit
 GNSS
 grayscale
 gridded
 Groessen
 GroundTruthInit
+Grüne
 gulleys
 haben
 Hafengebiet
@@ -160,9 +162,6 @@ halten
 hier
 Hochwasser
 href
-hrend
-hrenpflichtig
-hrung
 hsv
 htm
 html
@@ -203,11 +202,11 @@ lidar
 lidar's
 Linksabbieger
 lm
-lspur
 lte
 luminance
 luv
 lx
+Lärmschutz
 Mainz
 Meteorologische
 metoffice
@@ -217,8 +216,6 @@ Modellierung
 MULTITRACK
 nd
 nde
-ndert
-ne
 NEBEL
 Nebenstrecke
 neuer
@@ -239,8 +236,8 @@ oktas
 ONEWAY
 onlinepubs
 ONRAMP
-opengroup
 opendrive
+opengroup
 openscenario
 optischen
 Ordnung
@@ -253,9 +250,9 @@ parametrization
 parametrize
 Parkausweis
 Parken
-Parkfl
+Parkflächen
 Parkschein
-Parkst
+Parkstände
 Paulat
 pdf
 png
@@ -280,17 +277,16 @@ rbd
 rcs
 rdquo
 README
-Rei
+Reißverschluss
 rfc
-rfen
 rgb
 rgbir
 rggb
 Richtzeichen
-rmschutz
 rmse
 Rollsplitt
 Rosenberger
+räumen
 Sa
 SAE
 sae
@@ -314,11 +310,11 @@ sr
 sslnet
 Steinburg
 steradian
-Stra
 Strahlungsphysik
 Strassenfahrzeuge
 Strassenverkehrs
 strassenverkehrsordnung
+Straßenschaden
 StVO
 stvo
 StVZO
@@ -343,7 +339,6 @@ ubc
 ubc
 uint
 uk
-umen
 umich
 umtri
 und
@@ -357,20 +352,20 @@ vda
 verkehr
 Verkehrseinrichtungen
 Verkehrsf
+Verkehrsführung
 Verkehrstechnik
 verkehrszeichen
-verschluss
 Verschmutzte
 Vorfahrt
 Vorschriftzeichen
 Vorweg
 vz
-vzkat
 VzKat
+vzkat
 wa
 Welle
 Wellenausbreitung
-Wendem
+Wendemöglichkeit
 werden
 werktags
 Wernli
@@ -381,7 +376,7 @@ Wilster
 wp
 wsdot
 www
-www
+während
 xrat
 XXXX
 xy
@@ -391,3 +386,5 @@ Zeitschrift
 Zou
 Zufahrt
 Zuflussregelung
+Ölspur
+überholt
diff --git a/doc/images/osi-streaming-principle.PNG → doc/images/osi-streaming-principle.png b/doc/images/osi-streaming-principle.PNG → doc/images/osi-streaming-principle.png
diff --git a/osi_object.proto b/osi_object.proto
@@ -764,10 +764,12 @@ message MovingObject
         // other OpenX standards (in particular, OpenScenario 1.x and 2.x, and OpenLabel).
         // This is primarily for historical reasons.  Where a single type from a
         // different standard can map to multiple OSI types it is left up to the
-        // discretion of the OSI implementer how that mapping is achieved.  For example,
-        // a simulator may use the dimensions of a provided 3d model of a vehicle with type
-        // "car" in OpenScenario, to determine whether it should be a TYPE_SMALL_CAR or
-        // TYPE_MEDIUM_CAR in OSI.
+        // discretion of the OSI implementer how that mapping is achieved. In previous
+        // versions, for example, a simulator might have used the dimensions of a provided
+        // 3d model of a vehicle with type "car" in OpenScenario, to determine whether it
+        // should be a TYPE_SMALL_CAR or TYPE_MEDIUM_CAR in OSI. As part of the harmonization
+        // effort, it should now map to TYPE_CAR, which is an alias of the old TYPE_MEDIUM_CAR,
+        // and all other car type enums have been deprecated in favor of TYPE_CAR.
         //
         // \note Vehicle type classification is a complex area and there are no
         // universally recognized standards.  As such, the boundaries between some of the
@@ -778,6 +780,10 @@ message MovingObject
         //
         enum Type
         {
+            // Allow aliases in enum
+            //
+            option allow_alias = true;
+
             // Type of vehicle is unknown (must not be used in ground truth).
             //
             TYPE_UNKNOWN = 0;
@@ -790,24 +796,39 @@ message MovingObject
             //
             // Definition: Hatchback car with maximum length 4 m.
             //
+            // \note Deprecated differentiation, use TYPE_CAR instead
+            //
             TYPE_SMALL_CAR = 2;
 
             // Vehicle is a compact car.
             //
             // Definition: Hatchback car with length between 4 and 4.5 m.
             //
+            // \note Deprecated differentiation, use TYPE_CAR instead
+            //
             TYPE_COMPACT_CAR = 3;
 
+            // Vehicle is a car.
+            //
+            // This is to be used for all car-like vehicles, without any
+            // further differentiated type available.
+            //
+            TYPE_CAR = 4;
+
             // Vehicle is a medium car.
             //
             // Definition: Hatchback or sedan with length between 4.5 and 5 m.
             //
+            // \note Deprecated differentiation, use the alias TYPE_CAR instead
+            //
             TYPE_MEDIUM_CAR = 4;
 
             // Vehicle is a luxury  car.
             //
             // Definition: Sedan or coupe that is longer then 5 m.
             //
+            // \note Deprecated differentiation, use TYPE_CAR instead
+            //
             TYPE_LUXURY_CAR = 5;
 
             // Vehicle is a delivery van.