Skip to content

Commit

Permalink
updating option docs #2 #563
Browse files Browse the repository at this point in the history
  • Loading branch information
behrisch committed May 6, 2024
1 parent 6883261 commit 8c21005
Show file tree
Hide file tree
Showing 9 changed files with 48 additions and 12 deletions.
16 changes: 11 additions & 5 deletions docs/web/docs/Netedit/attribute_help.md
Original file line number Diff line number Diff line change
Expand Up @@ -163,6 +163,7 @@ child element of [busStop](#busstop), [trainStop](#trainstop)
|chargeDelay|SUMOTime|Time delay after the vehicles has reached / stopped on the charging station, before the energy transfer (charging) begins *default:* **0.00**|
|chargeType|discrete string|Battery charging type *default:* **normal**|
|waitingTime|SUMOTime|Waiting time before start charging *default:* **900.00**|
|parkingArea|string|Parking area the charging station is located|

## parkingArea
| Attribute | Type | Description |
Expand All @@ -173,6 +174,7 @@ child element of [busStop](#busstop), [trainStop](#trainstop)
|endPos|unique string|The end position on the lane (the higher position on the lane) in meters, must be larger than startPos by more than 0.1m|
|departPos|string|Lane position in that vehicle must depart when leaves parkingArea|
|name|string|Name of parkingArea|
|acceptedBadges|list of strings|Accepted badges to access this parkingArea|
|roadsideCapacity|non-negative integer| The number of parking spaces for road-side parking *default:* **0**|
|onRoad|boolean|If set, vehicles will park on the road lane and thereby reducing capacity *default:* **0**|
|friendlyPos|boolean|If set, no error will be reported if element is placed behind the lane. Instead, it will be placed 0.1 meters from the lanes end or at position 0.1, if the position was negative and larger than the lanes length after multiplication with - 1 *default:* **0**|
Expand Down Expand Up @@ -219,7 +221,7 @@ child element of [parkingArea](#parkingarea)
|vTypes|list of strings|Space separated list of vehicle type ids to consider|
|timeThreshold|SUMOTime|The time-based threshold that describes how much time has to pass until a vehicle is recognized as halting) *default:* **1.00**|
|speedThreshold|non-negative float|The speed-based threshold that describes how slow a vehicle has to be to be recognized as halting) in m/s *default:* **1.39**|
|jamThreshold|non-negative float|The minimum distance to the next standing vehicle in order to make this vehicle count as a participant to the jam) in m *default:* **10.00**|
|jamThreshold|non-negative float|The maximum distance to the next standing vehicle in order to make this vehicle count as a participant to the jam in m *default:* **10.00**|
|friendlyPos|boolean|If set, no error will be reported if element is placed behind the lane. Instead, it will be placed 0.1 meters from the lanes end or at position 0.1, if the position was negative and larger than the lanes length after multiplication with - 1 *default:* **0**|
|lanes|list of unique strings|The sequence of lane ids in which the detector shall be laid on|
|endPos|unique float|The end position on the lane the detector shall be laid on in meters|
Expand Down Expand Up @@ -343,6 +345,7 @@ child element of [entryExitDetector](#entryexitdetector)
|timeThreshold|SUMOTime|The waiting time threshold (in s) that must be reached to activate rerouting (default -1 which disables the threshold) *default:* **0.00**|
|vTypes|list of strings|The list of vehicle types that shall be affected by this rerouter (empty to affect all types)|
|off|boolean|Whether the router should be inactive initially (and switched on in the gui) *default:* **0**|
|optional|boolean|If rerouter is optional *default:* **0**|

### interval
child element of [rerouter](#rerouter)
Expand Down Expand Up @@ -553,6 +556,7 @@ also child element of [calibrator](#calibrator)
|guiShape|discrete string|How this vehicle is rendered|
|width|non-negative float|The vehicle's width [m] (only used for drawing) *default:* **1.8**|
|height|non-negative float|The vehicle's height [m] (only used for drawing) *default:* **1.5**|
|parkingBadges|list of strings|The parking badges assigned to the vehicle|
|imgFile|filename|Image file for rendering vehicles of this type (should be grayscale to allow functional coloring)|
|laneChangeModel|discrete string|The model used for changing lanes *default:* **default**|
|carFollowModel|discrete string|The model used for car-following *default:* **Krauss**|
Expand Down Expand Up @@ -712,13 +716,15 @@ child element of [route](#route), [trip](#trip), [flow](#flow)
|extension|SUMOTime|If set to a non-negative time value, then the stop duration can be extended at most by the extension value in seconds *default:* **0**|
|triggered|discrete string|Whether a person or container or both may end the stop *default:* **false**|
|expected|list of strings|List of elements that must board the vehicle before it may continue|
|join|string|Joins this train to another upon reaching the stop|
|permitted|list of strings|List of elements that can board the vehicle before it may continue|
|parking|discrete string|Whether the vehicle stops on the road or beside *default:* **false**|
|actType|string|Activity displayed for stopped person in GUI and output files|
|tripId|string|Parameter to be applied to the vehicle to track the trip id within a cyclical public transport route|
|line|string|New line attribute to be set on the vehicle when reaching this stop (for cyclical public transport route)|
|onDemand|boolean|Whether the stop may be skipped if no passengers wants to embark or disembark *default:* **0**|
|jump|SUMOTime|transfer time if there shall be a jump from this stop to the next route edge *default:* **-1**|
|split|string|Splits the train upon reaching the stop|
|busStop|list of unique strings|BusStop associated with this stop|
|trainStop|list of unique strings|TrainStop associated with this stop|
|containerStop|list of unique strings|ContainerStop associated with this stop|
Expand Down Expand Up @@ -763,17 +769,17 @@ child element of [route](#route), [trip](#trip), [flow](#flow)
|disallow|list of vClasses|Explicitly disallows the given vehicle classes (not given will be allowed)|
|spreadType|discrete string|The spreadType defines how to compute the lane geometry from the edge geometry (used for visualization) *default:* **right**|
|priority|integer|The priority of the edge *default:* **-1**|
|width|non-negative float|Lane width for all lanes of this edge in meters (used for visualization) *default:* **-1**|
|sidewalkWidth|float|The width of the sidewalk that should be added as an additional lane|
|bikeLaneWidth|float|The width of the bike lane that should be added as an additional lane|
|width|string|Lane width for all lanes of this edge in meters (used for visualization) *default:* **default**|
|sidewalkWidth|string|The width of the sidewalk that should be added as an additional lane *default:* **default**|
|bikeLaneWidth|string|The width of the bike lane that should be added as an additional lane *default:* **default**|

## laneType
| Attribute | Type | Description |
|-----------|------|-------------|
|speed|non-negative float|The maximum speed allowed on the lane in m/s *default:* **13.89**|
|allow|list of vClasses|Explicitly allows the given vehicle classes (not given will be not allowed) *default:* **all**|
|disallow|list of vClasses|Explicitly disallows the given vehicle classes (not given will be allowed)|
|width|non-negative float|Lane width for all lanes of this type in meters (used for visualization) *default:* **-1**|
|width|string|Lane width for all lanes of this type in meters (used for visualization) *default:* **default**|

## routeDistribution
| Attribute | Type | Description |
Expand Down
1 change: 1 addition & 0 deletions docs/web/docs/duarouter.md
Original file line number Diff line number Diff line change
Expand Up @@ -137,6 +137,7 @@ Files](Basics/Using_the_Command_Line_Applications.md#configuration_files).
| **--weights.interpolate** {{DT_BOOL}} | Interpolate edge weights at interval boundaries; *default:* **false** |
| **--weights.expand** {{DT_BOOL}} | Expand the end of the last loaded weight interval to infinity; *default:* **false** |
| **--weights.minor-penalty** {{DT_FLOAT}} | Apply the given time penalty when computing routing costs for minor-link internal lanes; *default:* **1.5** |
| **--weights.tls-penalty** {{DT_FLOAT}} | Apply the given time penalty when computing routing costs across a traffic light; *default:* **0** |
| **--weights.random-factor** {{DT_FLOAT}} | Edge weights for routing are dynamically disturbed by a random factor drawn uniformly from [1,FLOAT); *default:* **1** |
| **--weight-period** {{DT_TIME}} | Aggregation period for the given weight files; triggers rebuilding of Contraction Hierarchy; *default:* **3600** |
| **--weights.priority-factor** {{DT_FLOAT}} | Consider edge priorities in addition to travel times, weighted by factor; *default:* **0** |
Expand Down
1 change: 1 addition & 0 deletions docs/web/docs/jtrrouter.md
Original file line number Diff line number Diff line change
Expand Up @@ -104,6 +104,7 @@ Files](Basics/Using_the_Command_Line_Applications.md#configuration_files).
| **--routing-threads** {{DT_INT}} | The number of parallel execution threads used for routing; *default:* **0** |
| **--restriction-params** {{DT_STR_LIST}} | Comma separated list of param keys to compare for additional restrictions |
| **--weights.minor-penalty** {{DT_FLOAT}} | Apply the given time penalty when computing routing costs for minor-link internal lanes; *default:* **1.5** |
| **--weights.tls-penalty** {{DT_FLOAT}} | Apply the given time penalty when computing routing costs across a traffic light; *default:* **0** |
| **--max-edges-factor** {{DT_FLOAT}} | Routes are cut off when the route edges to net edges ratio is larger than FLOAT; *default:* **2** |
| **-T** {{DT_STR_LIST}}<br> **--turn-defaults** {{DT_STR_LIST}} | Use STR[] as default turn definition; *default:* **30,50,20** |
| **--sink-edges** {{DT_STR_LIST}} | Use STR[] as list of sink edges |
Expand Down
1 change: 1 addition & 0 deletions docs/web/docs/marouter.md
Original file line number Diff line number Diff line change
Expand Up @@ -157,6 +157,7 @@ configuration:
| **--weights.interpolate** {{DT_BOOL}} | Interpolate edge weights at interval boundaries; *default:* **false** |
| **--weights.expand** {{DT_BOOL}} | Expand the end of the last loaded weight interval to infinity; *default:* **false** |
| **--weights.minor-penalty** {{DT_FLOAT}} | Apply the given time penalty when computing routing costs for minor-link internal lanes; *default:* **1.5** |
| **--weights.tls-penalty** {{DT_FLOAT}} | Apply the given time penalty when computing routing costs across a traffic light; *default:* **0** |
| **--aggregation-interval** {{DT_TIME}} | Defines the time interval when aggregating single vehicle input; Defaults to one hour; *default:* **3600** |
| **--capacities.default** {{DT_BOOL}} | Ignore edge priorities when calculating capacities and restraints; *default:* **false** |
| **--weights.priority-factor** {{DT_FLOAT}} | Consider edge priorities in addition to travel times, weighted by factor; *default:* **0** |
Expand Down
7 changes: 5 additions & 2 deletions docs/web/docs/netconvert.md
Original file line number Diff line number Diff line change
Expand Up @@ -269,6 +269,7 @@ Files](Basics/Using_the_Command_Line_Applications.md#configuration_files).
| **--offset.z** {{DT_FLOAT}} | Adds FLOAT to net z-positions; *default:* **0** |
| **--flip-y-axis** {{DT_BOOL}} | Flips the y-coordinate along zero; *default:* **false** |
| **--roundabouts.guess** {{DT_BOOL}} | Enable roundabout-guessing; *default:* **true** |
| **--roundabouts.guess.max-length** {{DT_FLOAT}} | Structures with a circumference above FLOAT threshold are not classified as roundabout; *default:* **3500** |
| **--roundabouts.visibility-distance** {{DT_FLOAT}} | Default visibility when approaching a roundabout; *default:* **9** |
| **--opposites.guess** {{DT_BOOL}} | Enable guessing of opposite direction lanes usable for overtaking; *default:* **false** |
| **--opposites.guess.fix-lengths** {{DT_BOOL}} | Ensure that opposite edges have the same length; *default:* **true** |
Expand Down Expand Up @@ -373,7 +374,7 @@ Files](Basics/Using_the_Command_Line_Applications.md#configuration_files).
| **--keep-edges.explicit** {{DT_STR_LIST}} | Only keep edges in STR[] or those which are kept due to other keep-edges or remove-edges options |
| **--keep-edges.input-file** {{DT_FILE}} | Only keep edges in FILE (Each id on a single line. Selection files from sumo-gui are also supported) or those which are kept due to other keep-edges or remove-edges options |
| **--remove-edges.input-file** {{DT_FILE}} | Remove edges in FILE. (Each id on a single line. Selection files from sumo-gui are also supported) |
| **--keep-edges.postload** {{DT_BOOL}} | Remove edges after joining; *default:* **false** |
| **--keep-edges.postload** {{DT_BOOL}} | Remove edges after loading, patching and joining; *default:* **false** |
| **--keep-edges.in-boundary** {{DT_STR_LIST}} | Only keep edges which are located within the given boundary (given either as CARTESIAN corner coordinates <xmin,ymin,xmax,ymax> or as polygon <x0,y0,x1,y1,...>) |
| **--keep-edges.in-geo-boundary** {{DT_STR_LIST}} | Only keep edges which are located within the given boundary (given either as GEODETIC corner coordinates <lon-min,lat-min,lon-max,lat-max> or as polygon <lon0,lat0,lon1,lat1,...>) |
| **--keep-edges.by-vclass** {{DT_STR_LIST}} | Only keep edges which allow one of the vclasses in STR[] |
Expand Down Expand Up @@ -422,6 +423,7 @@ Files](Basics/Using_the_Command_Line_Applications.md#configuration_files).
| **--junctions.small-radius** {{DT_FLOAT}} | Default radius for junctions that do not require wide vehicle turns; *default:* **1.5** |
| **--junctions.higher-speed** {{DT_BOOL}} | Use maximum value of incoming and outgoing edge speed on junction instead of average; *default:* **false** |
| **--junctions.minimal-shape** {{DT_BOOL}} | Build junctions with minimal shapes (ignoring edge overlap); *default:* **false** |
| **--junctions.endpoint-shape** {{DT_BOOL}} | Build junction shapes based on edge endpoints (ignoring edge overlap); *default:* **false** |
| **--internal-junctions.vehicle-width** {{DT_FLOAT}} | Assumed vehicle width for computing internal junction positions; *default:* **1.8** |
| **--rectangular-lane-cut** {{DT_BOOL}} | Forces rectangular cuts between lanes and intersections; *default:* **false** |
| **--check-lane-foes.roundabout** {{DT_BOOL}} | Allow driving onto a multi-lane road if there are foes on other lanes (at roundabouts); *default:* **true** |
Expand Down Expand Up @@ -476,6 +478,7 @@ Files](Basics/Using_the_Command_Line_Applications.md#configuration_files).
|--------|-------------|
| **--discard-params** {{DT_STR_LIST}} | Remove the list of keys from all params |
| **--ignore-change-restrictions** {{DT_STR_LIST}} | List vehicle classes that may ignore lane changing restrictions ('all' discards all restrictions); *default:* **authority** |
| **--ignore-widths** {{DT_BOOL}} | Whether lane widths shall be ignored.; *default:* **false** |
| **--osm.skip-duplicates-check** {{DT_BOOL}} | Skips the check for duplicate nodes and edges; *default:* **false** |
| **--osm.elevation** {{DT_BOOL}} | Imports elevation data; *default:* **false** |
| **--osm.layer-elevation** {{DT_FLOAT}} | Reconstruct (relative) elevation based on layer data. Each layer is raised by FLOAT m; *default:* **0** |
Expand All @@ -490,6 +493,7 @@ Files](Basics/Using_the_Command_Line_Applications.md#configuration_files).
| **--osm.stop-output.length.bus** {{DT_FLOAT}} | The default length of a bus stop in FLOAT m; *default:* **15** |
| **--osm.stop-output.length.tram** {{DT_FLOAT}} | The default length of a tram stop in FLOAT m; *default:* **25** |
| **--osm.stop-output.length.train** {{DT_FLOAT}} | The default length of a train stop in FLOAT m; *default:* **200** |
| **--osm.railsignals** {{DT_STR_LIST}} | Specify custom rules for importing railway signals; *default:* **DEFAULT** |
| **--osm.all-attributes** {{DT_BOOL}} | Whether additional attributes shall be imported; *default:* **false** |
| **--osm.extra-attributes** {{DT_STR_LIST}} | List of additional attributes that shall be imported from OSM via osm.all-attributes (set 'all' to import all); *default:* **all** |
| **--osm.speedlimit-none** {{DT_FLOAT}} | The speed limit to be set when there is no actual speed limit in reality; *default:* **39.4444** |
Expand Down Expand Up @@ -527,7 +531,6 @@ Files](Basics/Using_the_Command_Line_Applications.md#configuration_files).
| **--visum.verbose-warnings** {{DT_BOOL}} | Prints all warnings, some of which are due to VISUM misbehaviour; *default:* **false** |
| **--visum.lanes-from-capacity.norm** {{DT_FLOAT}} | The factor for flow to no. lanes conversion; *default:* **1800** |
| **--opendrive.import-all-lanes** {{DT_BOOL}} | Imports all lane types; *default:* **false** |
| **--opendrive.ignore-widths** {{DT_BOOL}} | Whether lane widths shall be ignored.; *default:* **false** |
| **--opendrive.curve-resolution** {{DT_FLOAT}} | The geometry resolution in m when importing curved geometries as line segments.; *default:* **2** |
| **--opendrive.advance-stopline** {{DT_FLOAT}} | Allow stop lines to be built beyond the start of the junction if the geometries allow so; *default:* **0** |
| **--opendrive.min-width** {{DT_FLOAT}} | The minimum lane width for determining start or end of variable-width lanes; *default:* **1.8** |
Expand Down

0 comments on commit 8c21005

Please sign in to comment.