C++_Python 接口语言支持 ¶
注意
算法接入教程请查看 C++算法接入 和 Python算法接入 。
-
API调用参考示例 API调用参考示例
2. API 汇总列表 ¶
| 类别 | 接口 | 功能 | C++ API | Python API | |
|---|---|---|---|---|---|
| 基 础 服 务 类 |
ServiceAPI
20个 |
截取节点信息 | 节点通信数据发送 API | SendRouteMessage | |
| 节点通信数据接收 API | ReceiveRouteMessageCB | ||||
| 选择车辆并初始化 | 初始化 SimOne API | InitSimOneAPI | SoInitSimOneAPI | ||
| 多车版本-初始化 SimOne API | InitSimOneAPIEx | SoInitSimOneAPIEx | |||
| 初始化 SimOne API 带超时 | InitSimOneAPIWithTimeOut | SoInitSimOneAPIWithTimeOut | |||
| 多车版本 - 初始化 SimOne API 带超时 | InitSimOneAPIExWithTimeOut | SoInitSimOneAPIExWithTimeOut | |||
| 设置日志格式 | 日志设置接口 | SetLogOut | SoSetLogOut | ||
| 获取主车状态 | 获取主车状态信息 | GetMainVehicleStatus | SoGetMainVehicleStatus | ||
| 获取主车状态信息回调的函数 | SetMainVehicleStatusUpdateCB | SoAPISetMainVehicleStatusUpdateCB | |||
| 获取案例信息 | 获取当前库的版本号 | GetVersion | SoAPIGetVersion | ||
| 获取案例详情 | GetCaseInfo | SoAPIGetCaseInfo | |||
| 获取案例运行状态 | GetCaseRunStatus | SoGetCaseRunStatus | |||
| 获取主车信息列表 | GetMainVehicleList | SoGetCaseRunStatus | |||
| 获取高精度地图元数据信息 | GetHDMapData | SoGetHDMapData | |||
| 案例控制 | 等待并获取当前帧值 | Wait | SoAPIWait | ||
| 进行下一帧 | NextFrame | SoAPINextFrame | |||
| 暂停,用于非帧同步调试 | Pause | SoAPIPause | |||
| 继续,用于非帧同步调试 | Continue | SoAPIContinue | |||
| 自动回调帧数据 | 仿真场景中每帧的回调函数 | SetFrameCB | SoAPISetFrameCB | ||
| 退出 | 退出 API 节点 | TerminateSimOneAPI | SoTerminateSimOneAPI | ||
| 传 感 器 类 |
SensorAPI
19个 |
GPS | 获取主车 GPS 信息 | GetGps | SoGetGps |
| 主车 GPS 更新回调 | SetGpsUpdateCB | SoApiSetGpsUpdateCB | |||
| 真值 | 获得仿真场景中的物体真值信息 | GetGroundTruth | SoGetGroundTruth | ||
| 获得仿真场景中的物体真值信息更新回调 | SetGroundTruthUpdateCB | SoApiSetGroundTruthUpdateCB | |||
| 毫米波雷达 | 获得毫米波雷达目标信息 | GetRadarDetections | SoGetRadarDetections | ||
| 毫米波雷达目标信息更新回调 | SetRadarDetectionsUpdateCB | SoApiSetRadarDetectionsUpdateCB | |||
| 超声波雷达 | 获得一个超声波雷达信息 | GetUltrasonicRadar | SoGetUltrasonicRadar | ||
| 获得所有超声波雷达信息 | GetUltrasonicRadars | SoGetUltrasonicRadars | |||
| 超声波雷达真值信息更新回调 | SetUltrasonicRadarsCB | SoApiSetUltrasonicRadarsCB | |||
| 目标级传感器 | 获取传感器检测到物体的对应真值(支持的传感器包括目标级相机/目标级激光雷达/完美传感器) | GetSensorDetections | SoGetSensorDetections | ||
| 传感器真值信息更新回调(支持的传感器包括目标级相机/目标级激光雷达/完美传感器) | SetSensorDetectionsUpdateCB | SoApiSetSensorDetectionsUpdateCB | |||
| 获得仿真场景中的交通灯真值 | GetTrafficLight | SoGetTrafficLights | |||
| 获取传感器检测到车道与车道线数据(仅目标级相机和融合传感器支持) | GetSensorLaneInfo | SoGetSensorLaneInfo | |||
| 获取传感器检测到车道与车道线数据回调 | SetSensorLaneInfoCB | SoApiSetSensorLaneInfoCB | |||
| 获取传感器检测到地面喷漆信息(包括车道停止线/地面箭头/人行横道线) | GetSensorRoadMarkInfo | SoGetSensorRoadMarkInfo | |||
| 获取传感器检测到地面喷漆信息(包括车道停止线/地面箭头/人行横道线数据回调) | SetSensorRoadMarkInfoCB | SoApiSetSensorRoadMarkInfoCB | |||
| 配置信息 | 获得所有传感器的配置信息(Id/类型/频率/位置和朝向等) | GetSensorConfigurations | SoGetSensorConfigurations | ||
| 环境 | 获取当前环境相关信息(天气/光照/地面等) | GetEnvironment | SoGetEnvironment | ||
| 设置当前环境相关信息(天气/光照/地面等) | SetEnvironment | SoSetEnvironment | |||
|
StreamingAPI
4个 |
物理级传感器流式传输 | 实时获取图像数据(图像格式包括 RGB/JPEG/Segmentation/H.265 等) | GetStreamingImage | SoGetStreamingImage | |
| 设置实时图像数据更新回调(图像格式包括 RGB/JPEG/Segmentation/H.265 等) | SetStreamingImageUpdateCB | SoApiSetStreamingImageUpdateCB | |||
| 实时获取 SimOne_Streaming_Point_Cloud 格式点云数据 | GetStreamingPointCloud | SoGetStreamingPointCloud | |||
| 设置点云数据更新回调 | SetStreamingPointCloudUpdateCB | SoApiSetStreamingPointCloudUpdateCB | |||
|
V2XAPI
2个 |
V2X | 获得对应车辆编号 V2X 中的 UPER 编码之后的 V2X 消息 | GetV2XInfo | SoGetV2XInfo | |
| 获得对应车辆编号 V2X 中的 UPER 编码之后的 V2X 消息更新回调 | SetV2XInfoUpdateCB | SoApiSetV2XInfoUpdateCB | |||
| 控 制 通 信 类 |
PNCAPI
15个 |
选择车辆并初始化 | 注册 SimOne_Data_Gps 包含的状态以外的主车状态信息 | RegisterVehicleState | SoRegisterVehicleState |
| 设置主车控制器的名字 | SetDriverName | SoSetDriverName | |||
| 车辆位置与状态 | 设置主车位置 | SetPose | SoSetPose | ||
| 重置主车状态 | SetVehicleToInitState | SoSetVehicleToInitState | |||
| 车辆控制 | 主车控制 | SetDrive | SoSetDrive | ||
| 主车控制模式 | SetDriveMode | SoGetControlMode | |||
| 轨迹与规划控制 | 预测轨迹设置 | SetTrajectory | |||
| 主车控制(通过规划轨迹) | SetDriveTrajectory | SoSetDriveTrajectory | |||
| 获取状态 | 获取通过 RegisterVehicleState 注册的主车状态信息 | GetVehicleState | SoGetVehicleState | ||
| 获取车辆控制模式 | GetControlMode | SoGetControlMode | |||
| 获取 SimOneDriver 控制信号 | GetDriverControl | SoGetDriverControl | |||
| 获取案例主车路径点 | GetWayPoints | SoGetWayPoints | |||
| 事件与信息设置 | 设置主车预警消息 | SetVehicleEvent | SoSetVehicleEvent | ||
| 设置车辆信号灯状态 | SetSignalLights | SoSetSignalLights | |||
| 场景事件回调 | SetScenarioEventCB | SoAPISetScenarioEventCB | |||
| 高 精 地 图 运 行 时 类 |
HDMapAPI
50个 暂无PythonAPI |
加载 | 标记高精地图已经初始化完成 | setHdmapLoad | |
| 加载高精度地图 | LoadHDMap | ||||
| 获取车道相关信息 | 获取最接近输入点的车道,所属车道优先 | GetNearMostLane | 车道检测 | ||
| 获取临近车道列表 | GetNearLanes | ||||
| 获取视野范围内所有车道 | GetNearLanesWithAngle | ||||
| 获取离最近车道左右边缘线的距离 | GetDistanceToLaneBoundary | 车道信息获取 | |||
| 获取车道信息(包含车道 ID,左右边缘线,虚拟中心线) | GetLaneSample | ||||
| 获取车道连接信息 | GetLaneLink | ||||
| 获取车道类型 | GetLaneType | ||||
| 获取车道宽度 | GetLaneWidth | ||||
| 获取输入点投影到指定车道中心线上的点和切线方向 | GetLaneMiddlePoint | ||||
| 获取当前车辆位置所在车道的信息 | GetLaneSampleByLocation | ||||
| 获取前方一定距离内的所有车道信息(包括车道ID、左右边缘线、虚拟中心线) | GetForwardLaneSample | ||||
| 获取前方车道信息 | GetForwardLaneInfo | ||||
| 根据指定车道 ID 和局部坐标获取输入点左右两侧车道标线信息 | GetRoadMark | 车道线获取 | |||
| 获取所有车道线信息列表 | GetLaneData | ||||
| 获取指定车道线所在 Section 的所有车道线 ID 列表 | GetSectionLaneList | ||||
| 获取路网指定坐标点的高程列表 | GetHeights | 地图数据获取 | |||
| 获取道路长度 | GetRoadLength | ||||
| 获取车道长度 | GetLaneLength | ||||
| 获取所有车道线信息列表 | GetLaneLineInfo | ||||
| 获取 section 列表 | GetSectionList | ||||
| 通过类型获取车道信号列表 | GetSignalListOnLaneByType | 导航数据获取 | |||
| 获取指定道路 ID 车道名称列表 | GetLaneList | ||||
| 获取路口相关信息 | 获取所有交叉路口 ID 列表 | GetJunctionList | |||
| 获取指定十字路口详细信息 | GetJunction | ||||
| 获取拓扑信息 | GetTopoGraph | ||||
| 获取交通标志相关信息 | 获取地图中信号灯列表 | GetTrafficLightList | 交通信号灯 | ||
| 获取指定车道绑定的信号灯列表 | GetSpecifiedLaneTrafficLightList | ||||
| 获取地图中交通标志列表 | GetTrafficSignList | 交通标志 | |||
| 获取指定车道关联交通标志列表 | GetSpecifiedLaneTrafficSignalList | ||||
| 获取指定车道所在道路上的网状线列表 | GetCrossHatchList | 网状线信息获取 | |||
| 获取交通灯给定作用车道的关联停止线列表 | GetStoplineList | 停止线 | |||
| 获取给定车道的关联停止线列表 | GetSpecifiedLaneStoplineList | ||||
| 获取交通灯给定作用车道的关联人行横道线列表 | GetCrosswalkList | 人行横道 | |||
| 获取给定车道的关联人行横道线列表 | GetSpecifiedLaneCrosswalkList | ||||
| 获取地图中停车位列表 | GetParkingSpaceList | 停车位信息获取 | |||
| 获取地图指定点前方停车位列表 | GetParkingSpaceIds | ||||
| 判断元素是否存在 | 查询指定车道是否存在于地图中 | ContainsLane | |||
| 判断位置是否与车道线重叠 | IsOverlapLaneLine | ||||
| 判断指定道路是否是双向道路 | IsTwoSideRoad | ||||
| 判断车道是否为机动车道 | IsDriving | ||||
| 判断车道是否在交叉路口内 | IsInJunction | ||||
| 判断坐标点是否在车道内 | IsInsideLane | ||||
| 定位 | 获取相对于车道虚拟中心线的 ST 坐标 | GetLaneST | |||
| 获取相对于道路参考线的 ST 坐标 | GetRoadST | ||||
| 根据车道 ST 坐标获取局部坐标 | GetInertialFromLaneST | ||||
| 路由 | 获取路网路径规划 | GenerateRoute | |||
| 获取路网路径规划详细信息 | GenerateRoute_V2 | ||||
| 获取规划路径所途径道路的 ID 列表 | Navigate | ||||
| 评 价 算 法 类 |
EvaluationAPI
6个 |
存储数据 | 初始化评价服务 | InitEvaluationService | SoInitEvaluationService |
| 初始化评价服务,本地存储数据 | InitEvaluationServiceWithLocalData | SoInitEvaluationServiceWithLocalData | |||
| 保存评价算法所需的各类信息(JSON 格式) | SaveEvaluationRecord | SoSaveEvaluationRecord | |||
| 添加信号 | 添加评价算法所需的各类信息(JSON 格式) | AddEvaluationRecord | SoAddEvaluationRecord | ||
| 判定 | 场景判定事件回调 | SetJudgeEventCB | SoSetJudgeEventCB | ||
| 发送场景判定事件 | AddJudgeEvent | SoAddJudgeEvent | |||