Merge pull request #94 from usdot-jpo-ode/clarify-lane-types

Clarify lane types and usage of lanes table
usdot-jpo-ode · Sep 1, 2020 · 8a1579e · 8a1579e
2 parents 3e3967f + 98c5ca7
commit 8a1579e
Show file tree

Hide file tree

Showing 10 changed files with 132 additions and 169 deletions.
diff --git a/README.md b/README.md
@@ -62,7 +62,6 @@ A third directory, [`images`](/images) contains images that are referenced throu
     - [**Enumerated Types**](/spec-content/enumerated-types)
         - [Event Status](/spec-content/enumerated-types/event_status.md)
         - [Geometry Type](/spec-content/enumerated-types/geometry_type.md)
-        - [Lane Edge Reference](/spec-content/enumerated-types/lane_edge_reference.md)
         - [Lane Status](/spec-content/enumerated-types/lane_status.md)
         - [Road Restriction](/spec-content/enumerated-types/road_restriction.md)
         - [Spatial Verification](/spec-content/enumerated-types/spatial_verification.md)

diff --git a/create-feed/examples/linestring_example.geojson b/create-feed/examples/linestring_example.geojson
@@ -42,11 +42,11 @@
         ],
         "lanes": [
           {
-            "lane_edge_reference": "left",
+            "order": 1,
             "lane_number": 1,
-            "lane_status": "open",
-            "lane_type": "left-lane",
-            "lane_restrictions": [
+            "status": "open",
+            "type": "left-lane",
+            "restrictions": [
               {
                 "restriction_type": "reduced-width",
                 "restriction_value": 10,
@@ -55,16 +55,16 @@
             ]
           },
           {
-            "lane_edge_reference": "left",
+            "order": 2,
             "lane_number": 2,
-            "lane_status": "closed",
-            "lane_type": "middle-lane"
+            "status": "closed",
+            "type": "middle-lane"
           },
           {
-            "lane_edge_reference": "left",
+            "order": 3,
             "lane_number": 3,
-            "lane_status": "closed",
-            "lane_type": "right-lane"
+            "status": "closed",
+            "type": "right-lane"
           }
         ]
       },
@@ -270,21 +270,21 @@
        ],
        "lanes": [
          {
-           "lane_edge_reference": "left",
+           "order": 1,
            "lane_number": 1,
-           "lane_status": "open",
-           "lane_type": "left-lane",
-           "lane_restrictions": [
+           "status": "open",
+           "type": "left-lane",
+           "restrictions": [
              {
                "restriction_type": "no-trucks"
              }
            ]
          },
          {
-           "lane_edge_reference": "left",
+           "order": 2,
            "lane_number": 2,
-           "lane_status": "open",
-           "lane_type": "right-lane"
+           "status": "open",
+           "type": "right-lane"
          }
        ]
      },

diff --git a/create-feed/examples/multipoint_example.geojson b/create-feed/examples/multipoint_example.geojson
@@ -42,11 +42,11 @@
         ],
         "lanes": [
           {
-            "lane_edge_reference": "left",
+            "order": 1,
             "lane_number": 1,
-            "lane_status": "open",
-            "lane_type": "left-lane",
-            "lane_restrictions": [
+            "status": "open",
+            "type": "left-lane",
+            "restrictions": [
               {
                 "restriction_type": "reduced-width",
                 "restriction_value": 10,
@@ -55,16 +55,16 @@
             ]
           },
           {
-            "lane_edge_reference": "left",
+            "order": 2,
             "lane_number": 2,
-            "lane_status": "closed",
-            "lane_type": "middle-lane"
+            "status": "closed",
+            "type": "middle-lane"
           },
           {
-            "lane_edge_reference": "left",
+            "order": 3,
             "lane_number": 3,
-            "lane_status": "closed",
-            "lane_type": "right-lane"
+            "status": "closed",
+            "type": "right-lane"
           }
         ]
       },
@@ -118,21 +118,21 @@
        ],
        "lanes": [
          {
-           "lane_edge_reference": "left",
+           "order": 1,
            "lane_number": 1,
-           "lane_status": "open",
-           "lane_type": "left-lane",
-           "lane_restrictions": [
+           "status": "open",
+           "type": "left-lane",
+           "restrictions": [
              {
                "restriction_type": "no-trucks"
              }
            ]
          },
          {
-           "lane_edge_reference": "left",
+           "order": 2,
            "lane_number": 2,
-           "lane_status": "open",
-           "lane_type": "right-lane"
+           "status": "open",
+           "type": "right-lane"
          }
        ]
      },

diff --git a/create-feed/schemas/wzdx_v3.0_feed.json b/create-feed/schemas/wzdx_v3.0_feed.json
@@ -220,32 +220,31 @@
       "description": "An individual lane within a road event",
       "type": "object",
       "properties": {
-        "lane_status": {
+        "order": {
+          "description": "The position (index) of the lane in sequence on the roadway, where '1' represents the left-most lane",
+          "type": "integer",
+          "minimum": 1
+        },
+        "status": {
           "$ref": "#/definitions/lane_status"
         },
-        "lane_type": {
+        "type": {
           "$ref": "#/definitions/lane_type"
         },
         "lane_number": {
-          "description": "The number (index) assigned to the lane (not including shoulders)",
+          "description": "The number assigned to the lane to help identify its position. Flexible, but usually used for regular, driveable lanes",
           "type": "integer",
-          "minimum": 0
-        },
-        "lane_edge_reference": {
-          "$ref": "#/definitions/lane_edge_reference"
+          "minimum": 1
         },
-        "lane_restrictions": {
+        "restrictions": {
           "description": "A list of restrictions specific to the lane",
           "type": "array",
           "items": {
             "$ref": "#/definitions/lane_restriction"
           }
         }
       },
-      "required": ["lane_status", "lane_type"],
-      "dependencies": {
-        "lane_number": ["lane_edge_reference"]
-      }
+      "required": ["status", "type", "order"]
     },
     "lane_restriction": {
       "title": "Lane Restriction",
@@ -327,11 +326,6 @@
         "roadway-creation"
       ]
     },
-    "lane_edge_reference": {
-      "title": "Lane Edge Reference Enumerated Type",
-      "description": "The roadside edge from which lane numbers are assigned",
-      "enum": ["left", "right"]
-    },
     "lane_status": {
       "title": "Lane Status Enumerated Type",
       "description": "The status of the lane for the traveling public",
@@ -341,15 +335,11 @@
       "title": "Lane Type Enumerated Type",
       "description": "An indication of the type of lane or shoulder",
       "enum": [
-        "all",
         "left-lane",
         "right-lane",
-        "left-2-lanes",
-        "right-2-lanes",
-        "left-3-lanes",
-        "right-3-lanes",
         "middle-lane",
-        "middle-two-lanes",
+        "center-lane",
+        "lane",
         "right-turning-lane",
         "left-turning-lane",
         "right-exit-lane",
@@ -366,12 +356,13 @@
         "left-second-entrance-ramp",
         "sidewalk",
         "bike-lane",
-        "none",
-        "unknown",
         "alternating-flow-lane",
-        "outside",
-        "inside",
-        "both"
+        "right-shoulder",
+        "left-shoulder",
+        "shoulder",
+        "hov-lane",
+        "reversible-lane",
+        "center-left-turn-lane"
       ]
     },
     "lane_restriction_unit": {

diff --git a/images/road_event_erd.png b/images/road_event_erd.png
diff --git a/spec-content/README.md b/spec-content/README.md
@@ -51,7 +51,6 @@ This section provides a list of all enumerated types uses in the WZDx specificat
 
 - [Event Status](/spec-content/enumerated-types/event_status.md)
 - [Geometry Type](/spec-content/enumerated-types/geometry_type.md)
-- [Lane Edge Reference](/spec-content/enumerated-types/lane_edge_reference.md)
 - [Lane Status](/spec-content/enumerated-types/lane_status.md)
 - [Lane Restriction Unit](/spec-content/enumerated-types/lane_restriction_unit.md)
 - [Road Restriction](/spec-content/enumerated-types/road_restriction.md)
@@ -78,8 +77,7 @@ Field Name | Table | Enumerated Type | Notes
 `vehicle_impact` | [road_events](/spec-content/data-tables/road_events.md) | [Vehicle Impact](/spec-content/enumerated-types/vehicle_impact.md) | Enumeration created in WZDx v2.0
 `restrictions` | [road_events](/spec-content/data-tables/road_events.md) | [Road Restriction](/spec-content/enumerated-types/road_restriction.md) | Enumeration created in WZDx v1.0
 `type_name` | [types_of_work](/spec-content/data-tables/types_of_work.md) | [Work Type Name](/spec-content/enumerated-types/work_type_name.md) | Enumeration created in WZDx v2.0
-`lane_edge_reference` | [lanes](/spec-content/data-tables/lanes.md) | [Lane Edge Reference](/spec-content/enumerated-types/lane_edge_reference.md) | Enumeration created in WZDx v2.0
-`lane_status` | [lanes](/spec-content/data-tables/lanes.md) | [Lane Status](/spec-content/enumerated-types/lane_status.md) | Enumeration created in WZDx v2.0
-`lane_type` | [lanes](/spec-content/data-tables/lanes.md) | [Lane Type](/spec-content/enumerated-types/derived-from-its-standards/lane_type.md) | Enumeration adapted from TMDD LaneRoadway
+`status` | [lanes](/spec-content/data-tables/lanes.md) | [Lane Status](/spec-content/enumerated-types/lane_status.md) | Enumeration created in WZDx v2.0
+`type` | [lanes](/spec-content/data-tables/lanes.md) | [Lane Type](/spec-content/enumerated-types/derived-from-its-standards/lane_type.md) | Enumeration adapted from TMDD LaneRoadway, updated in WZDx v3.0
 `restriction_type` | [lane_restrictions](/spec-content/data-tables/lane_restrictions.md) | [Road Restriction](/spec-content/enumerated-types/road_restriction.md) | Individual lane restrictions | Enumeration created in WZDx v1.0
 `restriction_units` | [lane_restrictions](/spec-content/data-tables/lane_restrictions.md) | [Lane Restriction Unit](/spec-content/enumerated-types/lane_restriction_unit.md) | This is an intial list, created in WZDx v2.0, and is not intended to be complete. More values will be added as needed.
diff --git a/spec-content/data-tables/lanes.md b/spec-content/data-tables/lanes.md
@@ -1,18 +1,18 @@
 # lanes
 **Optional**
 
-This table identifies and describes individual lanes within a road event.  
+This table identifies and describes individual lanes within a road event. Each entry in this table represents a single lane.
 
 This table is related to the [road_events](/spec-content/data-tables/road_events.md) table by the foreign key road_event_id.  For every record in the road_event table there may exist one or more record(s) in the lanes table.
 
 This table is related to the [lane_restrictions](/spec-content/data-tables/lane_restrictions.md) table. For each record in the lanes table there may exist one or more records in the lane_restrictions table.  The lane_id field acts as the foreign key in the lanes table.
 
 ## Lanes Table Structure
-Data Name|Data Type|Description|Conformance|Notes
--|-|-|-|-|
-lane_id|ID|Identifies the lane_info record|Required|Primary key
-[road_event_id](/data-tables/road_events.md)|ID|Identifies the road event to which a lane information is related.|Required|Foreign key
-lane_edge_reference|Enumeration; Text|The roadside edge from which lanes are assigned numbers.|Conditional: required if  lane_number is not null|Counting begins from the edge of the improved surface. See [Lane Edge Reference Enumerated Type](/spec-content/enumerated-types/lane_edge_reference.md)
-lane_number|Non-negative Integer|The number assigned to a lane (not including shoulders)|Optional|Assigned by counting from right or left edge of the improved surface. Counting begins from the edge indicated in the lane_edge_reference field. Useful for text to voice translation.
-lane_status|Enumeration; Text|Status of the lane for the traveling public|Required|Allowed values: open, closed, shift-left, shift-right, merge-right, merge-left, alternating-one-way. See [Lane Status Enumerated Type](/spec-content/enumerated-types/lane_status.md)
-lane_type|Enumeration; Text|An indication of the type of lane or shoulder|Required|See [Lane Type Enumerated Type](/spec-content/enumerated-types/derived-from-its-standards/lane_type.md)
+Data Name | Data Type | Description | Conformance | Notes
+--- | --- | --- | --- | ---
+lane_id | ID | Identifies the lane_info record | Required | Primary key
+[road_event_id](/spec-content/data-tables/road_events.md) | ID | Identifies the road event to which a lane information is related. | Required | Foreign key
+order | Positive Integer | The position of a lane in sequence on the roadway. This value is used as an index to indicate the order of all WZDx lanes provided for a road event. | Required | A value of `1` must represent the **left-most** lane and an increase in 1 must represent moving a single lane over from the **left**.
+type | Enumeration; Text | An indication of the type of lane or shoulder | Required | See [Lane Type Enumerated Type](/spec-content/enumerated-types/derived-from-its-standards/lane_type.md)
+status | Enumeration; Text | Status of the lane for the traveling public | Required | See [Lane Status Enumerated Type](/spec-content/enumerated-types/lane_status.md)
+lane_number | Positive Integer | The number assigned to the lane to help identify its position. Flexible, but usually used for regular, driveable lanes. | Optional | Assigned by counting from the **left** edge of the improved surface. Useful for text to voice translation.