Merge pull request #87 from zephyr-data-specs/autogenerated-docs

Update Spec Documentation

docs/spec/README.md

@@ -1,7 +1,7 @@
 # `gmns` General Modeling Network Specification (GMNS)
 - `description` The General Modeling Network Specification (GMNS) defines a common machine (and human) readable format for sharing routable road network files. It is designed to be used in multi-modal static and dynamic transportation planning and operations models.
 - `homepage` https://github.com/zephyr-data-specs/GMNS
-- `version` 0.95
+- `version` 0.96
 ## `link`
 
 - `description` A link is an edge in a network, defined by the nodes it travels from and to. It may have associated geometry information. Links have three types of attributes:<br>  - Those that define the physical location of the link (e.g., `shape` `information`, `length`, `width`)<br>  - Those that define the link's directionality: `from_node`, `to_node`<br>  - Those that define properties in the direction of travel: capacity, free flow speed, number of lanes, permitted uses, grade, facility type

usage/database/curb_seg.sql

@@ -7,6 +7,6 @@ CREATE TABLE IF NOT EXISTS curb_seg (
 	regulation TEXT, 
 	width FLOAT CHECK (width >= 0), 
 	PRIMARY KEY (curb_seg_id), 
-	FOREIGN KEY(link_id) REFERENCES link (link_id), 
-	FOREIGN KEY(ref_node_id) REFERENCES node (node_id)
+	FOREIGN KEY(ref_node_id) REFERENCES node (node_id), 
+	FOREIGN KEY(link_id) REFERENCES link (link_id)
 )

usage/database/lane.sql

@@ -1,7 +1,7 @@
 CREATE TABLE IF NOT EXISTS lane (
 	lane_id TEXT NOT NULL, 
 	link_id TEXT NOT NULL, 
-	lane_num INTEGER NOT NULL CHECK (lane_num >= -10) CHECK (lane_num <= 10), 
+	lane_num INTEGER NOT NULL CHECK (lane_num <= 10) CHECK (lane_num >= -10), 
 	allowed_uses TEXT, 
 	r_barrier TEXT, 
 	l_barrier TEXT, 

usage/database/link.sql

@@ -12,7 +12,7 @@ CREATE TABLE IF NOT EXISTS link (
 	grade FLOAT CHECK (grade >= -100) CHECK (grade <= 100), 
 	facility_type TEXT, 
 	capacity FLOAT CHECK (capacity >= 0), 
-	free_speed FLOAT CHECK (free_speed <= 200) CHECK (free_speed >= 0), 
+	free_speed FLOAT CHECK (free_speed >= 0) CHECK (free_speed <= 200), 
 	lanes INTEGER CHECK (lanes >= 0), 
 	bike_facility TEXT, 
 	ped_facility TEXT, 
@@ -22,8 +22,8 @@ CREATE TABLE IF NOT EXISTS link (
 	jurisdiction TEXT, 
 	row_width FLOAT CHECK (row_width >= 0), 
 	PRIMARY KEY (link_id), 
-	FOREIGN KEY(parent_link_id) REFERENCES link (link_id), 
+	FOREIGN KEY(geometry_id) REFERENCES geometry (geometry_id), 
 	FOREIGN KEY(from_node_id) REFERENCES node (node_id), 
-	FOREIGN KEY(to_node_id) REFERENCES node (node_id), 
-	FOREIGN KEY(geometry_id) REFERENCES geometry (geometry_id)
+	FOREIGN KEY(parent_link_id) REFERENCES link (link_id), 
+	FOREIGN KEY(to_node_id) REFERENCES node (node_id)
 )

usage/database/location.sql

@@ -10,6 +10,6 @@ CREATE TABLE IF NOT EXISTS location (
 	zone_id TEXT, 
 	gtfs_stop_id TEXT, 
 	PRIMARY KEY (loc_id), 
-	FOREIGN KEY(ref_node_id) REFERENCES node (node_id), 
-	FOREIGN KEY(link_id) REFERENCES link (link_id)
+	FOREIGN KEY(link_id) REFERENCES link (link_id), 
+	FOREIGN KEY(ref_node_id) REFERENCES node (node_id)
 )

usage/database/segment_lane.sql

@@ -1,7 +1,7 @@
 CREATE TABLE IF NOT EXISTS segment_lane (
 	segment_lane_id TEXT NOT NULL, 
 	segment_id TEXT NOT NULL, 
-	lane_num INTEGER NOT NULL CHECK (lane_num <= 10) CHECK (lane_num >= -10), 
+	lane_num INTEGER NOT NULL CHECK (lane_num >= -10) CHECK (lane_num <= 10), 
 	parent_lane_id TEXT, 
 	allowed_uses TEXT, 
 	r_barrier TEXT, 

usage/database/segment_lane_tod.sql

@@ -9,6 +9,6 @@ CREATE TABLE IF NOT EXISTS segment_lane_tod (
 	l_barrier TEXT, 
 	width FLOAT CHECK (width >= 0), 
 	PRIMARY KEY (segment_lane_tod_id), 
-	FOREIGN KEY(timeday_id) REFERENCES time_set_definitions (timeday_id), 
-	FOREIGN KEY(segment_lane_id) REFERENCES segment_lane (segment_lane_id)
+	FOREIGN KEY(segment_lane_id) REFERENCES segment_lane (segment_lane_id), 
+	FOREIGN KEY(timeday_id) REFERENCES time_set_definitions (timeday_id)
 )

usage/database/segment_tod.sql

@@ -4,7 +4,7 @@ CREATE TABLE IF NOT EXISTS segment_tod (
 	timeday_id TEXT, 
 	time_day TEXT, 
 	capacity FLOAT CHECK (capacity >= 0), 
-	free_speed FLOAT CHECK (free_speed <= 200) CHECK (free_speed >= 0), 
+	free_speed FLOAT CHECK (free_speed >= 0) CHECK (free_speed <= 200), 
 	lanes INTEGER, 
 	l_lanes_added INTEGER, 
 	r_lanes_added INTEGER, 
@@ -14,6 +14,6 @@ CREATE TABLE IF NOT EXISTS segment_tod (
 	toll FLOAT, 
 	allowed_uses TEXT, 
 	PRIMARY KEY (segment_tod_id), 
-	FOREIGN KEY(timeday_id) REFERENCES time_set_definitions (timeday_id), 
-	FOREIGN KEY(segment_id) REFERENCES segment (segment_id)
+	FOREIGN KEY(segment_id) REFERENCES segment (segment_id), 
+	FOREIGN KEY(timeday_id) REFERENCES time_set_definitions (timeday_id)
 )

usage/database/signal_coordination.sql

@@ -7,7 +7,7 @@ CREATE TABLE IF NOT EXISTS signal_coordination (
 	coord_ref_to TEXT, 
 	"offset" FLOAT CHECK ("offset" >= 0), 
 	PRIMARY KEY (coordination_id), 
-	FOREIGN KEY(coord_contr_id) REFERENCES signal_controller (controller_id), 
 	FOREIGN KEY(controller_id) REFERENCES signal_controller (controller_id), 
-	FOREIGN KEY(timing_plan_id) REFERENCES signal_timing_plan (timing_plan_id)
+	FOREIGN KEY(timing_plan_id) REFERENCES signal_timing_plan (timing_plan_id), 
+	FOREIGN KEY(coord_contr_id) REFERENCES signal_controller (controller_id)
 )

usage/database/signal_detector.sql

@@ -11,7 +11,7 @@ CREATE TABLE IF NOT EXISTS signal_detector (
 	det_zone_back FLOAT, 
 	det_type TEXT, 
 	PRIMARY KEY (detector_id), 
+	FOREIGN KEY(ref_node_id) REFERENCES node (node_id), 
 	FOREIGN KEY(controller_id) REFERENCES signal_controller (controller_id), 
-	FOREIGN KEY(link_id) REFERENCES link (link_id), 
-	FOREIGN KEY(ref_node_id) REFERENCES node (node_id)
+	FOREIGN KEY(link_id) REFERENCES link (link_id)
 )

usage/database/signal_phase_mvmt.sql

@@ -5,7 +5,7 @@ CREATE TABLE IF NOT EXISTS signal_phase_mvmt (
 	link_id TEXT, 
 	protection TEXT, 
 	PRIMARY KEY (signal_phase_mvmt_id), 
-	FOREIGN KEY(mvmt_id) REFERENCES movement (mvmt_id), 
 	FOREIGN KEY(link_id) REFERENCES link (link_id), 
-	FOREIGN KEY(timing_phase_id) REFERENCES signal_timing_phase (timing_phase_id)
+	FOREIGN KEY(timing_phase_id) REFERENCES signal_timing_phase (timing_phase_id), 
+	FOREIGN KEY(mvmt_id) REFERENCES movement (mvmt_id)
 )

usage/database/signal_timing_phase.sql

@@ -8,8 +8,8 @@ CREATE TABLE IF NOT EXISTS signal_timing_phase (
 	clearance FLOAT CHECK (clearance >= 0) CHECK (clearance <= 120), 
 	walk_time FLOAT CHECK (walk_time <= 120) CHECK (walk_time >= 0), 
 	ped_clearance FLOAT CHECK (ped_clearance >= 0) CHECK (ped_clearance <= 120), 
-	ring INTEGER NOT NULL CHECK (ring >= 0) CHECK (ring <= 12), 
-	barrier INTEGER NOT NULL CHECK (barrier >= 0) CHECK (barrier <= 12), 
+	ring INTEGER NOT NULL CHECK (ring <= 12) CHECK (ring >= 0), 
+	barrier INTEGER NOT NULL CHECK (barrier <= 12) CHECK (barrier >= 0), 
 	position INTEGER NOT NULL, 
 	PRIMARY KEY (timing_phase_id), 
 	FOREIGN KEY(timing_plan_id) REFERENCES signal_timing_plan (timing_plan_id)

usage/database/signal_timing_plan.sql

@@ -3,7 +3,7 @@ CREATE TABLE IF NOT EXISTS signal_timing_plan (
 	controller_id TEXT NOT NULL, 
 	timeday_id TEXT, 
 	time_day TEXT, 
-	cycle_length FLOAT CHECK (cycle_length >= 0) CHECK (cycle_length <= 600), 
+	cycle_length FLOAT CHECK (cycle_length <= 600) CHECK (cycle_length >= 0), 
 	PRIMARY KEY (timing_plan_id), 
 	FOREIGN KEY(timeday_id) REFERENCES time_set_definitions (timeday_id), 
 	FOREIGN KEY(controller_id) REFERENCES signal_controller (controller_id)