From 91de98974ae26acd9d3315443fb7d58cf29957a6 Mon Sep 17 00:00:00 2001 From: Michael Behrisch Date: Sat, 6 Jan 2024 21:37:20 +0100 Subject: [PATCH] unifying links #2 --- docs/web/docs/Networks/Elevation.md | 2 +- docs/web/docs/Simulation/Traffic_Lights.md | 2 +- .../docs/TraCI/Change_Inductionloop_State.md | 2 +- .../TraCI/Change_Lane_Area_Detector_State.md | 2 +- .../TraCI/Interfacing_TraCI_from_Python.md | 2 +- .../docs/TraCI/Object_Context_Subscription.md | 24 ++++---- .../docs/TraCI/Simulation_Value_Retrieval.md | 60 +++++++++---------- .../web/docs/TraCI/Vehicle_Value_Retrieval.md | 2 +- .../docs/Tutorials/TraCI4Traffic_Lights.md | 2 +- docs/web/docs/Tutorials/TraCIPedCrossing.md | 2 +- 10 files changed, 50 insertions(+), 50 deletions(-) diff --git a/docs/web/docs/Networks/Elevation.md b/docs/web/docs/Networks/Elevation.md index d1b3c74231ba..48ad499cdede 100644 --- a/docs/web/docs/Networks/Elevation.md +++ b/docs/web/docs/Networks/Elevation.md @@ -36,7 +36,7 @@ each edge To calibrate the color range to the elevations found in the network, the *Recalibrate Rainbow* within the gui settings dialog button may be used. -Furthermore, [sumo-gui](../sumo-gui.md) is [available with support for 3D-Visualization](https://sumo.dlr.de/daily/sumo-msvc12extrax64-git.zip) which can be used to visualize elevation profiles as well. +Furthermore, there is an "extra" version of [sumo-gui](../sumo-gui.md) [available with support for 3D-Visualization](../Downloads.md) which can be used to visualize elevation profiles as well. ## Models that use Elevation Data diff --git a/docs/web/docs/Simulation/Traffic_Lights.md b/docs/web/docs/Simulation/Traffic_Lights.md index 0681cf1ee4a4..291a8096a724 100644 --- a/docs/web/docs/Simulation/Traffic_Lights.md +++ b/docs/web/docs/Simulation/Traffic_Lights.md @@ -247,7 +247,7 @@ the input file. TLS Link indices can be access using either - [sumolib](../Tools/Sumolib.md) using - [tls.getConnections()](https://sumo.dlr.de/daily/pydoc/sumolib.net.html#TLS) + [tls.getConnections()](https://sumo.dlr.de/pydoc/sumolib.net.html#TLS) - or [TraCI](../TraCI.md) using [traci.trafficlight.getControlledLinks()](../TraCI/Traffic_Lights_Value_Retrieval.md#structure_of_compound_object_controlled_links) diff --git a/docs/web/docs/TraCI/Change_Inductionloop_State.md b/docs/web/docs/TraCI/Change_Inductionloop_State.md index 804124a45c6d..416de1501f33 100644 --- a/docs/web/docs/TraCI/Change_Inductionloop_State.md +++ b/docs/web/docs/TraCI/Change_Inductionloop_State.md @@ -17,7 +17,7 @@ Changes the state of a induction loop. The values that can be changed and the pa | Variable | ValueType | Description | [Python Method](../TraCI/Interfacing_TraCI_from_Python.md) | |---------------------------|----------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------| -| time (0x22) | double | Persistently overrides the measured time since detection with the given value. Setting a negative value resets the override. | [overrideTimeSinceDetection](https://sumo.dlr.de/daily/pydoc/traci._inductionloop.html#InductionLoopDomain-overrideTimeSinceDetection) | +| time (0x22) | double | Persistently overrides the measured time since detection with the given value. Setting a negative value resets the override. | [overrideTimeSinceDetection](https://sumo.dlr.de/pydoc/traci._inductionloop.html#InductionLoopDomain-overrideTimeSinceDetection) | # compound message details diff --git a/docs/web/docs/TraCI/Change_Lane_Area_Detector_State.md b/docs/web/docs/TraCI/Change_Lane_Area_Detector_State.md index 4749fce10b19..d27a647ae2a7 100644 --- a/docs/web/docs/TraCI/Change_Lane_Area_Detector_State.md +++ b/docs/web/docs/TraCI/Change_Lane_Area_Detector_State.md @@ -17,4 +17,4 @@ Changes the state of a lane area detector. The values that can be changed and th | Variable | ValueType | Description | [Python Method](../TraCI/Interfacing_TraCI_from_Python.md) | |---------------------------|----------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------| -| vehicle number (0x22) | integer | Persistently overrides the number of vehicles on the detector. Setting a negative value resets the override. | [overrideVehicleNumber](https://sumo.dlr.de/daily/pydoc/traci._lanearea.html#LaneAreaDomain-overrideVehicleNumber) | +| vehicle number (0x22) | integer | Persistently overrides the number of vehicles on the detector. Setting a negative value resets the override. | [overrideVehicleNumber](https://sumo.dlr.de/pydoc/traci._lanearea.html#LaneAreaDomain-overrideVehicleNumber) | diff --git a/docs/web/docs/TraCI/Interfacing_TraCI_from_Python.md b/docs/web/docs/TraCI/Interfacing_TraCI_from_Python.md index d3317019167b..291e866aa4bc 100644 --- a/docs/web/docs/TraCI/Interfacing_TraCI_from_Python.md +++ b/docs/web/docs/TraCI/Interfacing_TraCI_from_Python.md @@ -195,7 +195,7 @@ The following filter types are available: - VClass: Only return vehicles of the specified vClasses See the [pydoc -documentation](https://sumo.dlr.de/daily/pydoc/traci._vehicle.html#VehicleDomain-addSubscriptionFilterCFManeuver) +documentation](https://sumo.dlr.de/pydoc/traci._vehicle.html#VehicleDomain-addSubscriptionFilterCFManeuver) for detailed specifications. !!! caution diff --git a/docs/web/docs/TraCI/Object_Context_Subscription.md b/docs/web/docs/TraCI/Object_Context_Subscription.md index 010adb3035fe..b46415398834 100644 --- a/docs/web/docs/TraCI/Object_Context_Subscription.md +++ b/docs/web/docs/TraCI/Object_Context_Subscription.md @@ -117,16 +117,16 @@ Currently, the following context subscription filter types are implemented: | filter name | filter type | parameter value | description | uses context range | | --------- | :---------: | :-----------------: | ----------------- | :----------------------------: | -| [lanes](https://sumo.dlr.de/daily/pydoc/traci._vehicle.html#VehicleDomain-addSubscriptionFilterLanes) | 0x01 | list(byte) | only return vehicles on list of lanes relative to ego vehicle | no | -| [no-opposite](https://sumo.dlr.de/daily/pydoc/traci._vehicle.html#VehicleDomain-addSubscriptionFilterNoOpposite) | 0x02 | - | exclude vehicles on opposite (and other) lanes | yes | -| [downstream distance](https://sumo.dlr.de/daily/pydoc/traci._vehicle.html#VehicleDomain-addSubscriptionFilterDownstreamDistance) | 0x03| double | only return vehicles within the given downstream distance | no | -| [upstream distance](https://sumo.dlr.de/daily/pydoc/traci._vehicle.html#VehicleDomain-addSubscriptionFilterUpstreamDistance) | 0x04 | double | only return vehicles within the given maximal upstream distance | no | -| [leader/follower](https://sumo.dlr.de/daily/pydoc/traci._vehicle.html#VehicleDomain-addSubscriptionFilterLeadFollow) | 0x05 | - | only return leader and follower on the specified lanes (requires 'lanes' filter) | no | -| [turn](https://sumo.dlr.de/daily/pydoc/traci._vehicle.html#VehicleDomain-addSubscriptionFilterTurn) | 0x07 | - | only return foes on upcoming junctions | no | -| [vClass](https://sumo.dlr.de/daily/pydoc/traci._vehicle.html#VehicleDomain-addSubscriptionFilterVClass) | 0x08 | list(string) | only return vehicles of the given vClass(es) | yes | -| [vType](https://sumo.dlr.de/daily/pydoc/traci._vehicle.html#VehicleDomain-addSubscriptionFilterVType) | 0x09 | list(string) | only return vehicles of the given vType(s) | yes | -| [field of vision](https://sumo.dlr.de/daily/pydoc/traci._vehicle.html#VehicleDomain-addSubscriptionFilterFieldOfVision) | 0x0A | double | only return vehicles within field of vision (angle in degrees) | yes | -| [lateral distance](https://sumo.dlr.de/daily/pydoc/traci._vehicle.html#VehicleDomain-addSubscriptionFilterLateralDistance) | 0x0B | double | only return vehicles within the given lateral distance | no | +| [lanes](https://sumo.dlr.de/pydoc/traci._vehicle.html#VehicleDomain-addSubscriptionFilterLanes) | 0x01 | list(byte) | only return vehicles on list of lanes relative to ego vehicle | no | +| [no-opposite](https://sumo.dlr.de/pydoc/traci._vehicle.html#VehicleDomain-addSubscriptionFilterNoOpposite) | 0x02 | - | exclude vehicles on opposite (and other) lanes | yes | +| [downstream distance](https://sumo.dlr.de/pydoc/traci._vehicle.html#VehicleDomain-addSubscriptionFilterDownstreamDistance) | 0x03| double | only return vehicles within the given downstream distance | no | +| [upstream distance](https://sumo.dlr.de/pydoc/traci._vehicle.html#VehicleDomain-addSubscriptionFilterUpstreamDistance) | 0x04 | double | only return vehicles within the given maximal upstream distance | no | +| [leader/follower](https://sumo.dlr.de/pydoc/traci._vehicle.html#VehicleDomain-addSubscriptionFilterLeadFollow) | 0x05 | - | only return leader and follower on the specified lanes (requires 'lanes' filter) | no | +| [turn](https://sumo.dlr.de/pydoc/traci._vehicle.html#VehicleDomain-addSubscriptionFilterTurn) | 0x07 | - | only return foes on upcoming junctions | no | +| [vClass](https://sumo.dlr.de/pydoc/traci._vehicle.html#VehicleDomain-addSubscriptionFilterVClass) | 0x08 | list(string) | only return vehicles of the given vClass(es) | yes | +| [vType](https://sumo.dlr.de/pydoc/traci._vehicle.html#VehicleDomain-addSubscriptionFilterVType) | 0x09 | list(string) | only return vehicles of the given vType(s) | yes | +| [field of vision](https://sumo.dlr.de/pydoc/traci._vehicle.html#VehicleDomain-addSubscriptionFilterFieldOfVision) | 0x0A | double | only return vehicles within field of vision (angle in degrees) | yes | +| [lateral distance](https://sumo.dlr.de/pydoc/traci._vehicle.html#VehicleDomain-addSubscriptionFilterLateralDistance) | 0x0B | double | only return vehicles within the given lateral distance | no | ### Intercompatibility @@ -139,10 +139,10 @@ Consequently, a combination of, e.g., the field-of-vision and lateral distance f - In the [python library](../TraCI/Interfacing_TraCI_from_Python.md#context_subscriptions), all domains support the methods [*subscribeContext* and - *unsubscribeContext*](https://sumo.dlr.de/daily/pydoc/traci.domain.html#Domain) + *unsubscribeContext*](https://sumo.dlr.de/pydoc/traci.domain.html#Domain) - For the python client several [methods for adding context filters for vehicle-to-vehicle context - subscriptions](https://sumo.dlr.de/daily/pydoc/traci._vehicle.html#VehicleDomain-addSubscriptionFilterCFManeuver) + subscriptions](https://sumo.dlr.de/pydoc/traci._vehicle.html#VehicleDomain-addSubscriptionFilterCFManeuver) are included. - In the [C++ library](../TraCI/C++TraCIAPI.md), the method *simulation.subscribeContext* takes an additional argument that diff --git a/docs/web/docs/TraCI/Simulation_Value_Retrieval.md b/docs/web/docs/TraCI/Simulation_Value_Retrieval.md index 2046582b8c28..8af0ac6afa9b 100644 --- a/docs/web/docs/TraCI/Simulation_Value_Retrieval.md +++ b/docs/web/docs/TraCI/Simulation_Value_Retrieval.md @@ -31,187 +31,187 @@ value is also shown in the table.

current simulation time (0x66)

double

Returns the current simulation time (in s)

-

getTime

+

getTime

current simulation time (0x70) (deprecated)

int

Returns the current simulation time (in ms)

-

getCurrentTime

+

getCurrentTime

number of loaded vehicles (id 0x71)

int

The number of vehicles which were loaded in this time step.

-

getLoadedNumber

+

getLoadedNumber

ids of loaded vehicles (id 0x72)

stringList

A list of ids of vehicles which were loaded in this time step.

-

getLoadedIDList

+

getLoadedIDList

number of departed vehicles (id 0x73)

int

The number of vehicles which departed (were inserted into the road network) in this time step.

-

getDepartedNumber

+

getDepartedNumber

ids of departed vehicles (id 0x74)

stringList

A list of ids of vehicles which departed (were inserted into the road network) in this time step.

-

getDepartedIDList

+

getDepartedIDList

number of vehicles that start to teleport
(id 0x75)

int

The number of vehicles which started to teleport in this time step.

-

getStartingTeleportNumber

+

getStartingTeleportNumber

ids of vehicles that start to teleport (id 0x76)

stringList

A list of ids of vehicles which started to teleport in this time step.

-

getStartingTeleportIDList

+

getStartingTeleportIDList

number of vehicles that end being teleported
(id 0x77)

int

The number of vehicles which ended to be teleported in this time step.

-

getEndingTeleportNumber

+

getEndingTeleportNumber

ids of vehicles that end being teleported
(id 0x78)

stringList

A list of ids of vehicles which ended to be teleported in this time step.

-

getEndingTeleportIDList

+

getEndingTeleportIDList

number of arrived vehicles (id 0x79)

int

The number of vehicles which arrived (have reached their destination and are removed from the road network) in this time step.

-

getArrivedNumber

+

getArrivedNumber

ids of arrived vehicles (id 0x7a)

stringList

A list of ids of vehicles which arrived (have reached their destination and are removed from the road network) in this time step.

-

getArrivedIDList

+

getArrivedIDList

network bounding box (id 0x7c)

2D polygon

The lower left and the upper right corner of the bounding box of the simulation network.

-

getNetBoundary

+

getNetBoundary

minimum number of vehicles that are still expected to leave the net (id 0x7d)

int

The number of vehicles which are in the net plus the ones still waiting to start. This number may be smaller than the actual number of vehicles still to come because of delayed route file parsing.

-

getMinExpectedNumber

+

getMinExpectedNumber

number of vehicles that begin a stop (id 0x68)

int

The number of vehicles that halted on a scheduled stop in this time step.

-

getStopStartingVehiclesNumber

+

getStopStartingVehiclesNumber

ids of vehicles that begin a stop (id 0x69)

stringList

A list of ids of vehicles that halted on a scheduled stop in this time step.

-

getStopStartingVehiclesIDList

+

getStopStartingVehiclesIDList

number of vehicles that end a stop (id 0x6a)

int

The number of vehicles that begin to continue their journey, leaving a scheduled stop in this time step.

-

getStopEndingVehiclesNumber

+

getStopEndingVehiclesNumber

ids of vehicles that end a stop (id 0x6b)

stringList

A list of ids of vehicles that begin to continue their journey, leaving a scheduled stop in this time step.

-

getStopEndingVehiclesIDList

+

getStopEndingVehiclesIDList

number of vehicles involved in a collision (id 0x80)

int

The number of vehicles that were involved in a collision in this time step.

-

getCollidingVehiclesNumber

+

getCollidingVehiclesNumber

ids of vehicles involved in a collision (id 0x81)

stringList

A list of ids of vehicles that were involved in a collision in this time step.

-

getCollidingVehiclesIDList

+

getCollidingVehiclesIDList

number of vehicles that begin to be parked
(id 0x6c)

int

The number of vehicles that enter a parking position in this time step.

-

getParkingStartingVehiclesNumber

+

getParkingStartingVehiclesNumber

ids of vehicles that begin to be parked
(id 0x6d)

stringList

A list of ids of vehicles that enter a parking position in this time step.

-

getParkingStartingVehiclesIDList

+

getParkingStartingVehiclesIDList

number of vehicles that end to be parked
(id 0x6e)

int

The number of vehicles that begin to continue their journey, leaving a scheduled parking in this time step.

-

getParkingEndingVehiclesNumber

+

getParkingEndingVehiclesNumber

ids of vehicles that end being parked (id 0x6f)

stringList

A list of ids of vehicles that begin to continue their journey, leaving a scheduled parking in this time step.

-

getParkingEndingVehiclesIDList

+

getParkingEndingVehiclesIDList

bus stop waiting (id 0x67)

int

Get the total number of waiting persons at the named bus stop.

-

getBusStopWaiting

+

getBusStopWaiting

bus stop waiting ids (id 0xef)

stringList

Get the ids of waiting persons at the named bus stop.

-

getBusStopWaitingIDList

+

getBusStopWaitingIDList

delta T (id 0x7b)

double

Returns the length of one simulation step in seconds.

-

getDeltaT

+

getDeltaT

parameter (0x7e)

string

Returns the value for the given string parameter.

-

getParameter

+

getParameter

scale (id 0x8e)

double

Returns the traffic scaling factor.

-

getScale

+

getScale

option (0x3f)

string

Returns the value of one of the global SUMO options.

-

getOption

+

getOption

diff --git a/docs/web/docs/TraCI/Vehicle_Value_Retrieval.md b/docs/web/docs/TraCI/Vehicle_Value_Retrieval.md index 5e58125b01d2..f9a3464874bb 100644 --- a/docs/web/docs/TraCI/Vehicle_Value_Retrieval.md +++ b/docs/web/docs/TraCI/Vehicle_Value_Retrieval.md @@ -595,7 +595,7 @@ Return the lane change state for the vehicle.

byte , see below

stringList see below

Returns a list of IDs for neighboring vehicle relevant to lane changing (>1 elements only possible for sublane model)

-

getNeighbors, getLeftFollowers, getLeftLeaders, getRightFollowers, getRightLeaders

+

getNeighbors, getLeftFollowers, getLeftLeaders, getRightFollowers, getRightLeaders

followSpeed (0x1c)

diff --git a/docs/web/docs/Tutorials/TraCI4Traffic_Lights.md b/docs/web/docs/Tutorials/TraCI4Traffic_Lights.md index 3dd5774e8486..acaf24e37697 100644 --- a/docs/web/docs/Tutorials/TraCI4Traffic_Lights.md +++ b/docs/web/docs/Tutorials/TraCI4Traffic_Lights.md @@ -62,7 +62,7 @@ makes use of the TraCI python API bundled with SUMO. A description of the API can be found at [TraCI/Interfacing_TraCI_from_Python](../TraCI/Interfacing_TraCI_from_Python.md). For a detailed list of available functions see the [pydoc generated -documentation](https://sumo.dlr.de/daily/pydoc/traci.html). +documentation](https://sumo.dlr.de/pydoc/traci.html). # Simulation diff --git a/docs/web/docs/Tutorials/TraCIPedCrossing.md b/docs/web/docs/Tutorials/TraCIPedCrossing.md index 9143fd1ed5a6..bf5c007db626 100644 --- a/docs/web/docs/Tutorials/TraCIPedCrossing.md +++ b/docs/web/docs/Tutorials/TraCIPedCrossing.md @@ -47,7 +47,7 @@ makes use of the TraCI python API bundled with SUMO. A description of the API can be found at [TraCI/Interfacing_TraCI_from_Python](../TraCI/Interfacing_TraCI_from_Python.md). For a detailed list of available functions see the [pydoc generated -documentation](https://sumo.dlr.de/daily/pydoc/traci.html). +documentation](https://sumo.dlr.de/pydoc/traci.html). ## Traffic light control