用例控制 Case Control¶
说明 / Overview
获取用例运行信息,以及暂停 / 继续仿真运行的接口。
Interfaces for retrieving use case runtime information and pausing/resuming simulation.
GetCaseInfo¶
bool GetCaseInfo(SimOne_Data_CaseInfo *pCaseInfo)
获取案例详情
Get the details of the case.
此函数用于获取当前模拟案例的详细信息
This function is used to retrieve detailed information about the current simulation case.
This function is used to retrieve detailed information about the current simulation case.
Parameters:
| 名称 | 类型 | 描述 | 默认 |
|---|---|---|---|
pCaseInfo |
SimOne_Data_CaseInfo * |
指向案例信息结构的指针,包括案例名称、案例ID、任务ID和会话ID Pointer to the case information structure, including case name, case ID, task ID, and session ID. |
— |
Returns:
| 类型 | 描述 |
|---|---|
bool |
成功获取返回true,否则返回false Returns true if information is successfully retrieved, false otherwise. |
GetWebTaskInfo¶
bool GetWebTaskInfo(SimOne_Web_TaskServerInfo *info)
获取Web任务服务器信息
Get Web Task Server Information.
此函数用于获取Web任务服务器的相关信息,如令牌、IP地址和端口号
This function is used to retrieve information about the Web Task Server, such as token, IP address, and port number.
This function is used to retrieve information about the Web Task Server, such as token, IP address, and port number.
Parameters:
| 名称 | 类型 | 描述 | 默认 |
|---|---|---|---|
info |
SimOne_Web_TaskServerInfo * |
指向Web任务服务器信息结构的指针,包括令牌、IP地址和端口号 Pointer to the Web Task Server information structure, including token, IP address, and port number. |
— |
Returns:
| 类型 | 描述 |
|---|---|
bool |
成功获取返回true,否则返回false Returns true if information is successfully retrieved, false otherwise. |
GetCaseRunStatus¶
ESimOne_Case_Status GetCaseRunStatus()
获取案例运行状态
Get the status of the case (running, stopped).
此函数用于检索当前模拟案例的运行状态,如运行中或已停止
This function is used to retrieve the running status of the current simulation case, such as running or stopped.
This function is used to retrieve the running status of the current simulation case, such as running or stopped.
Returns:
| 类型 | 描述 |
|---|---|
ESimOne_Case_Status |
返回案例的运行状态,如停止或运行中 Returns the running status of the case, such as Stopped or Running. |