Skip to content

Commit 768f012

Browse files
committed
chore: Update Longitudinal_control.md with additional details for requestSpeedChange API
1 parent f9eb189 commit 768f012

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

docs/developer_guide/Longitudinal_control.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,12 +20,18 @@ traffic_simulator has various ways to control the longitudinal behavior of the n
2020
## Details
2121
### requestSpeedChange
2222
By using `API::requestSpeedChange`, you can change the speed of the npc.
23+
MiscObjectEntity can not be controlled by this API.
2324

2425
| Value | Type | Description |
2526
| ------------ | ------ | ----------------------------------------------------------- |
2627
| name | string | Name of the npc. |
2728
| target_speed | double | Target speed of the npc. |
2829
| continuous | bool | If true the npc will keep the speed until the next command. |
30+
#### EgoEntity
31+
`target_speed` will be set to the target speed of the EgoEntity only before the scenario starts.
32+
33+
#### Other entity
34+
The function will append the job to change the target_speed of the npc to the job queue. If `continuous` is set to `false`, the job will be deleted after the velocity has reached the target speed. If set to `true`, the npc will keep the speed until the next longitudinal control command.
2935

3036
| Value | Type | Description |
3137
| ------------ | ------------------------ | ----------------------------------------------------------- |
@@ -34,6 +40,10 @@ By using `API::requestSpeedChange`, you can change the speed of the npc.
3440
| transition | speed_change::Transition | Transition type. |
3541
| constraint | speed_change::Constraint | Constraint type. |
3642
| continuous | bool | If true the npc will keep the speed until the next command. |
43+
#### EgoEntity
44+
`target_speed` will be set to the target speed of the EgoEntity only before the scenario starts.
45+
46+
#### Other entity
3747

3848
| Value | Type | Description |
3949
| ------------ | --------------------------------- | ----------------------------------------------------------- |

0 commit comments

Comments
 (0)