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

Enable road restriction feeds #205

Merged
merged 64 commits into from
Dec 13, 2021

Conversation

DeraldDudley
Copy link
Collaborator

@DeraldDudley DeraldDudley commented Sep 3, 2021

Enable road restriction feeds; add RestrictionRoadEvent and RoadRestrictionFeed

Contingent on Pull Request #209 and #198.

The RestrictionRoadEvent enables the publication of road restriction feeds (see RoadRestrictionFeed). Restriction feeds inform drivers of hazardous restrictions such as low clearances, narrow widths, weight limits, and more.

New Objects

Object Description
RestrictionRoadEvent A road event describing a section of roadway and the limitations of how that section can be used.
RoadRestrictionFeed The root (highest-level) object of a Road Restriction Feed GeoJSON document.

RestrictionRoadEvent Object

The RestrictionRoadEvent object describes one or more restrictions on a section of a roadway. It describes the location of the road section and the limitations on how it can be used. The RestrictionRoadEvent is a linear road event intended to represent persistent restrictions without a defined start or event date, such as bridge clearances.

The RestrictionRoadEvent is a type of road event; it has a core_details property which contains the RoadEventCoreDetails and exists within a RoadEventFeature.

For representing restrictions due to road work, see the WorkZoneRoadEvent and WZDxFeed.

Properties

Name Type Description Conformance Notes
core_details RoadEventCoreDetails Describes the basic characterisitics of a Road Event. Required
restrictions Array; [Restriction] A list of zero or more road restrictions that apply to the roadway segment described by this road event. Conditional: required if lanes property is not provided. Restrictions can also be provided on an individual lane.
lanes Array; [Lane] A list of individual lanes within a road event (roadway segment) Conditional: required if restrictions property is not provided.

Used By

Property Object
properties RoadEventFeature

WZDx Feeds

Feed Name Description Producer Consumer Uses Content
WZDxFeed (existing) Provides information about events ocurring on roadways (called "road events") such as work zones that impact the characteristics of the roadway and involve a change the roadway from the default state (e.g. a lane closure). The WZDxFeed is the original work zone data exchange feed, focused on describing high-level information about road work. Agencies responsible for managing roadways and road work, typically state and local DOTs. Traveling public via third parties such as mapping companies and CAVs. Route planning; increased awareness; "put work zones on the map" Work zone and detour road events (see RoadEventFeature).
SwzDeviceFeed (see #208) Provides information (location, status, live data) about field devices deployed on the roadway in work zones. Smart work zone equipment manufacturers or vendors. Agencies responsible for managing roadways and permitting work, typically state and local DOTs who are often interested in producing a WZDxFeed. Third-parties such as mapping companies and CAVs may also be interested in field device information. Simplifies design process for agencies wanting to interface with equipment manufacturers; aids in dynamically generating a WZDx feed with accurate information; reduces effort for manufacturers to conform to different agencies requirements. Field devices.
RoadRestrictionFeed (new) Locates and describes portions of a road that have restrictions. Restriction types described by this specification are listed in the RestrictionType enumerated type. Transportation Authorities like Tribal, Local, State, or Federal Agencies. Traveling public via third parties such as mapping companies and CAVs. Increased awareness; Route planning; Driver, Passenger, and Road-User Safety; Increased Efficiency; Reduced Damage to Infrastructure. Restriction road events (see RoadEventFeature and RestrictionRoadEvent).

Notes about this PR

This PR is a draft as it cannot be implemented unless #209 and #198 are approved. It contains a JSON schema for the new RoadRestrictionFeed and fully complete markdown documentation for the new objects, but does not update example files nor the object diagram. It targets the source branch of #209 (usdot-jpo-ode:refactor-road-event). The source branch for #198 (DeraldDudley:v4.0-release-restrictions) is merged into the source branch here (DeraldDudley:RestrictionEvent), so some of the changes proposed here are from the restriction change. Thus the files changed shows more than just the "new" changes for the RoadRestrictionfeed and RestrictionRoadEvent.

@j-d-b edit: updated to match the finalized implementation.

@j-d-b j-d-b marked this pull request as draft September 16, 2021 13:19
@j-d-b j-d-b added the Specification Extension This issue/PR is related to the Specification Extension Subgroup label Sep 21, 2021
@j-d-b j-d-b changed the base branch from v4.0-release to refactor-road-event November 1, 2021 18:55
@j-d-b j-d-b changed the title Create RestrictionEvent Object Add RestrictionRoadEvent and new RoadRestrictionFeed Nov 1, 2021
@j-d-b j-d-b added New Functionality This item relates to adding new functionality to the specification v4.0 labels Nov 1, 2021
@j-d-b j-d-b changed the title Add RestrictionRoadEvent and new RoadRestrictionFeed Add RestrictionRoadEvent and RoadRestrictionFeed Nov 1, 2021
@j-d-b j-d-b marked this pull request as ready for review December 10, 2021 23:04
Copy link
Collaborator

@j-d-b j-d-b left a comment

Choose a reason for hiding this comment

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

I had a bit of trouble with the schema but got it working. This PR looks good to me now, ready for review.

schemas/4.0/RoadEventFeature.json Outdated Show resolved Hide resolved
Copy link
Collaborator

@mark-mockett mark-mockett left a comment

Choose a reason for hiding this comment

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

Looks good to me, thanks Jacob and Derald!

@j-d-b j-d-b merged commit ed917c2 into usdot-jpo-ode:v4.0-release Dec 13, 2021
@j-d-b j-d-b mentioned this pull request Mar 23, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
New Functionality This item relates to adding new functionality to the specification Specification Extension This issue/PR is related to the Specification Extension Subgroup
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants