AGVC SDK  0.8.0
Map(地图模块)

AGVC自定义地图的创建、切换、删除、数据读写等核心功能 更多...

函数

std::vector< Headeragvc_interface::AgvcInterface::getMapList ()
 获取agv所有地图的信息头
Header agvc_interface::AgvcInterface::getCurrentMapHeader ()
 查询当前agv地图的信息头
OccupancyGridMap agvc_interface::AgvcInterface::getGridMapFromAgv (const Header &map_header)
 获取指定栅格地图信息
Base64PngMap agvc_interface::AgvcInterface::getBase64PngMapFromAgv (const Header &map_header)
 获取Base64编码的png地图信息
Base64PngMap agvc_interface::AgvcInterface::previewPngMapFromAgv (const Header &map_header, const int &image_width_px=0, const int &image_height_px=0)
 获取预览图,可指定预览图的长和宽
int agvc_interface::AgvcInterface::sendGridMapToAgv (const OccupancyGridMap &map)
 将栅格地图信息发送给agv
int agvc_interface::AgvcInterface::sendBase64PngMapToAgv (const Base64PngMap &map)
 将Base64编码的Png地图发送给agv
int agvc_interface::AgvcInterface::saveMap (const Header &map_header)
 建图完成后,调用该接口保存地图
int agvc_interface::AgvcInterface::switchMap (const Header &map_header)
 切换指定地图
int agvc_interface::AgvcInterface::deleteMap (const Header &map_header)
 删除一张指定地图
int agvc_interface::AgvcInterface::deleteMaps (const std::vector< Header > &map_headers)
 删除多张指定地图
std::vector< MapVirtualAreaagvc_interface::AgvcInterface::getAllMapVirtualArea ()
 查询当前地图的虚拟区域
std::vector< MapVirtualAreaagvc_interface::AgvcInterface::getAllMapVirtualAreaOfTargetMap (const Header &map_header)
 查询目标地图的虚拟区域
int agvc_interface::AgvcInterface::addMapVirtualArea (const MapVirtualArea &map_virtual_area)
 添加/修改一个虚拟区域
int agvc_interface::AgvcInterface::addMapVirtualAreas (const std::vector< MapVirtualArea > &map_virtual_areas)
 添加/修改多个虚拟区域
int agvc_interface::AgvcInterface::deleteMapVirtualArea (const Header &virtual_area_header)
 删除指定虚拟区域
int agvc_interface::AgvcInterface::deleteMapVirtualAreas (const std::vector< Header > &virtual_areas_header)
 删除多个指定虚拟区域
MapAllInfo agvc_interface::AgvcInterface::getGridMapAllInfo (const Header &map_header)
 获取指定地图的栅格地图数据、路径、站点、虚拟区信息
MapAllInfo agvc_interface::AgvcInterface::getPngMapAllInfo (const Header &map_header)
 获取指定地图的Base64地图数据、路径、站点、虚拟区信息
int agvc_interface::AgvcInterface::setGridMapAllInfo (const MapAllInfo &map_all_info, const Header &command_header={ "99999", "99999", 1, "99999" })
 设置栅格地图、路径、站点、虚拟区信息
int agvc_interface::AgvcInterface::setPngMapAllInfo (const MapAllInfo &map_all_info, const Header &command_header={ "99999", "99999", 1, "99999" })
 设置Base64格式地图、路径、站点、虚拟区信息
int agvc_interface::AgvcInterface::deleteMapAllInfo (const Header &map_header)
 删除指定地图的全部信息(地图数据、站点、路径、虚拟区信息)

详细描述

AGVC自定义地图的创建、切换、删除、数据读写等核心功能

函数说明

◆ addMapVirtualArea()

int agvc_interface::AgvcInterface::addMapVirtualArea ( const MapVirtualArea & map_virtual_area)

添加/修改一个虚拟区域

参数
[in]map_virtual_area待添加/修改的虚拟区域信息
返回
10100000:添加/修改虚拟区域成功 else:添加/修改虚拟区域失败

◆ addMapVirtualAreas()

int agvc_interface::AgvcInterface::addMapVirtualAreas ( const std::vector< MapVirtualArea > & map_virtual_areas)

添加/修改多个虚拟区域

参数
[in]map_virtual_areas待添加的虚拟区域信息
返回
10100000:添加/修改虚拟区域成功 else:添加/修改虚拟区域失败

◆ deleteMap()

int agvc_interface::AgvcInterface::deleteMap ( const Header & map_header)

删除一张指定地图

参数
[in]map_header指定地图的信息头(命令id,名称,时间,地图id)
返回
10100000:删除地图成功 else:删除地图失败

◆ deleteMapAllInfo()

int agvc_interface::AgvcInterface::deleteMapAllInfo ( const Header & map_header)

删除指定地图的全部信息(地图数据、站点、路径、虚拟区信息)

参数
[in]map_header指定地图信息头(命令id,地图名称,时间,地图id)
返回
10100000:删除成功 else:删除失败

◆ deleteMaps()

int agvc_interface::AgvcInterface::deleteMaps ( const std::vector< Header > & map_headers)

删除多张指定地图

参数
[in]map_headers多个指定地图的信息头(命令id,名称,时间,地图id)
返回
10100000:删除地图成功 else:删除地图失败

◆ deleteMapVirtualArea()

int agvc_interface::AgvcInterface::deleteMapVirtualArea ( const Header & virtual_area_header)

删除指定虚拟区域

参数
[in]virtual_area_header指定虚拟区域信息头(命令id,虚拟区域名称,时间,所在地图id)
返回
10100000:删除虚拟区域成功 else:删除虚拟区域失败

◆ deleteMapVirtualAreas()

int agvc_interface::AgvcInterface::deleteMapVirtualAreas ( const std::vector< Header > & virtual_areas_header)

删除多个指定虚拟区域

参数
[in]virtual_areas_header指定虚拟区域信息头(命令id,虚拟区域名称,时间,所在地图id)
返回
10100000:删除虚拟区域成功 else:删除虚拟区域失败

◆ getAllMapVirtualArea()

std::vector< MapVirtualArea > agvc_interface::AgvcInterface::getAllMapVirtualArea ( )

查询当前地图的虚拟区域

返回
当前地图的虚拟区域信息

◆ getAllMapVirtualAreaOfTargetMap()

std::vector< MapVirtualArea > agvc_interface::AgvcInterface::getAllMapVirtualAreaOfTargetMap ( const Header & map_header)

查询目标地图的虚拟区域

参数
[in]map_header指定地图header(命令id,名称,时间,地图id)
返回
指定地图的所有虚拟区域

◆ getBase64PngMapFromAgv()

Base64PngMap agvc_interface::AgvcInterface::getBase64PngMapFromAgv ( const Header & map_header)

获取Base64编码的png地图信息

注意
1.异步接口
参数
[in]map_header指定地图的信息头(本次异步命令id,名称,时间,地图id)
注解
map_id为"current_map"时,可特指为当前地图
返回
Base64编码的png地图信息

◆ getCurrentMapHeader()

Header agvc_interface::AgvcInterface::getCurrentMapHeader ( )

查询当前agv地图的信息头

返回
当前地图的信息头(命令id,名称,时间,地图id)

◆ getGridMapAllInfo()

MapAllInfo agvc_interface::AgvcInterface::getGridMapAllInfo ( const Header & map_header)

获取指定地图的栅格地图数据、路径、站点、虚拟区信息

注意
1.异步接口
参数
[in]map_header指定地图信息头(本次异步命令id,地图名称,时间,地图id)
注解
map_id为"current_map"时,可特指为当前地图
返回
栅格地图上的全部信息

◆ getGridMapFromAgv()

OccupancyGridMap agvc_interface::AgvcInterface::getGridMapFromAgv ( const Header & map_header)

获取指定栅格地图信息

参数
[in]map_header指定地图的信息头(本次异步命令id,名称,时间,地图id)
注解
map_id为"current_map"时,可特指为当前地图
返回
指定栅格地图信息

◆ getMapList()

std::vector< Header > agvc_interface::AgvcInterface::getMapList ( )

获取agv所有地图的信息头

返回
所有地图的信息头(命令id,名称,时间,地图id)

◆ getPngMapAllInfo()

MapAllInfo agvc_interface::AgvcInterface::getPngMapAllInfo ( const Header & map_header)

获取指定地图的Base64地图数据、路径、站点、虚拟区信息

注意
1.异步接口
参数
[in]map_header指定地图信息头(本次异步命令id,地图名称,时间,地图id)
注解
map_id为"current_map"时,可特指为当前地图
返回
base64地图上的全部信息

◆ previewPngMapFromAgv()

Base64PngMap agvc_interface::AgvcInterface::previewPngMapFromAgv ( const Header & map_header,
const int & image_width_px = 0,
const int & image_height_px = 0 )

获取预览图,可指定预览图的长和宽

注意
1.异步接口
参数
[in]map_header指定地图的信息头(本次异步命令id,名称,时间,地图id)
[in]image_width_px地图的宽度(像素),默认值为0 返回缩略图数据为空
[in]image_height_px地图的高度(像素),默认值为0 返回缩略图数据为空
注解
map_id为"current_map"时,可特指为当前地图
返回
Base64编码的png缩略图

◆ saveMap()

int agvc_interface::AgvcInterface::saveMap ( const Header & map_header)

建图完成后,调用该接口保存地图

注意
1.异步接口; 2.控制权限制
参数
[in]map_header地图信息头(本次异步命令id,名称,时间,地图id)
返回
10100000:保存地图成功 10100201:异步接口运行中 10120202:无控制权 else:保存地图失败

◆ sendBase64PngMapToAgv()

int agvc_interface::AgvcInterface::sendBase64PngMapToAgv ( const Base64PngMap & map)

将Base64编码的Png地图发送给agv

注意
1.异步接口
参数
[in]mapBase64编码的Png地图
返回
10100000:发送地图成功 10100201:发送地图中 else:发送地图失败

◆ sendGridMapToAgv()

int agvc_interface::AgvcInterface::sendGridMapToAgv ( const OccupancyGridMap & map)

将栅格地图信息发送给agv

注意
1.异步接口
参数
[in]map栅格地图信息
返回
10100000:发送地图成功 10100201:发送地图中 else:发送地图失败

◆ setGridMapAllInfo()

int agvc_interface::AgvcInterface::setGridMapAllInfo ( const MapAllInfo & map_all_info,
const Header & command_header = { "99999", "99999", 1, "99999" } )

设置栅格地图、路径、站点、虚拟区信息

注意
1.异步接口; 2.控制权限制
参数
[in]map_all_info栅格地图上的全部信息
[in]command_headerid字段代表下发本次命令的id;其他字段无特殊含义
注解
请保证数据下发的可行性(agv不会对数据进行校验)
返回
10100000:上传全部地图信息成功 10100201:异步接口运行中 10120202:无控制权 else:上传全部地图信息失败

◆ setPngMapAllInfo()

int agvc_interface::AgvcInterface::setPngMapAllInfo ( const MapAllInfo & map_all_info,
const Header & command_header = { "99999", "99999", 1, "99999" } )

设置Base64格式地图、路径、站点、虚拟区信息

注意
1.异步接口; 2.控制权限制
参数
[in]map_all_infoBase64格式地图上的全部信息
[in]command_headerid字段代表下发本次命令的id;其他字段无特殊含义
注解
请保证数据下发的可行性(agv不会对数据进行校验)
返回
10100000:上传全部地图信息成功 10100201:异步接口运行中 10120202:无控制权 else:上传全部地图信息失败

◆ switchMap()

int agvc_interface::AgvcInterface::switchMap ( const Header & map_header)

切换指定地图

注意
1.异步接口; 2.控制权限制
参数
[in]map_header指定地图的信息头(本次异步命令id,名称,时间,地图id)
返回
10100000:切换地图成功 10100201:异步接口运行中 10120202:无控制权 else:切换地图失败