Wait for a parameter study
cm_study_waitWaits up to a timeout for a CarMaker study run to finish or the study to end, returning only rows not returned by earlier calls. Call again while the study is running to poll progress.
Instructions
Wait until another run of the study has finished or the study has ended, at most timeout_s, and return the rows no earlier call returned (cm_study_status has the whole table and rank_by). Call it again while state is 'running'. Use this for studies instead of cm_wait_end.
Tool call template
This tool declares no required parameters. Add optional parameters from the input schema as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {},
"name": "cm_study_wait"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| study | No | Study id (default: the latest) | |
| detail | No | brief: per run label, valid, end status, sector or split times, abort reason. compact: also time, distance, result file and min / max / mean / last of the quantities. full: also every run's keys, workspace values and all statistics | brief |
| timeout_s | No | Longest time to wait in s, at most 50 (larger values are cut to 50); call again if not finished | |
| until_done | No | Return only when the study has ended (or at timeout_s) |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||