本页提供了基于Windows平台开发SLAMWARE SDK的API参考。
...
本页内容
Table of Contents | ||||||
---|---|---|---|---|---|---|
|
...
Note | ||||
---|---|---|---|---|
| ||||
基于Slamware SDK进行应用开发,您的开发环境需满足如下条件:
|
SDK内容
目录结构
Slamware SDK包含了大量您开发过程中可能会用到的资源、代码、和项目文件,其目录结构组织如下:
目录 | 说明 |
---|---|
bin | 预编译的工具 |
deps | |
dll | 动态链接库文件 |
docs | 参考文档 |
include | SDK相关的头文件 |
lib | 预编译的库文件 |
samples | 样例程序 |
workspaces | 项目文件 |
图表 1-1 SLAMWARE SDK 目录结构
头文件结构
在include目录下,我们包含了Slamware SDK以及它所依赖的所有库的头文件:
目录 | 说明 |
---|---|
boost | Boost 1.53.0 |
Eigen | Eigen矩阵库 |
json | |
rpos | Slamware SDK相关的头文件 |
图表 1-2 SLAMWARE SDK 头文件组织结构
...
要基于Slamware SDK进行应用开发,需要您的开发环境满足如下条件:
- 您的计算机应当安装Visual Studio 2010 SP1(由于我们提供的预编译库采用Visual Studio 2010 SP1进行编译,所以不可使用Visual Studio 2012或者2013进行开发)
创建项目工程
新建工程
步骤1 打开Visual Studio 2010并新建项目
Anchor
- 选择Visual C++项目,并选择Win32 Console Application(Win32控制台应用程序)项目类型
- 在Name(名称)中输入项目名称
- 点击OK(确定)
步骤2 设定应用程序选项
Anchor
点击Next(下一步)
图表3-3项目设置
- Application Type(应用程序类型)选择Console Application(命令行应用程序)
- Additional options(附加选项)勾选Empty options(附加选项)勾选Empty Project(空项目)
- 点击Finish完成项目创建
...
在Solution Explorer(解决方案)中右键单击您刚刚创建的项目,并单击Properties(属性)菜单,打开属性面板:
图表3-4 项目属性页
步骤2 配置VC++目录
在左侧列表中,选择VC++ Directories(VC++目录)
图表3-5 VC++目录
- 选中右侧的Include Directories(包含目录),并点击下拉按钮
- 选择<Edit…>(<编辑…>)
- 将第一种中提到的SDK中的include目录加入到列表中将第一章节中提到的SDK中的include目录加入到列表中
图表3-6 包含目录
- 选中右侧的Library Directories(库目录),并点击下拉按钮
- 选择<Edit…>(<编辑…>)
- 将第一种中提到的SDK中的lib目录加入到列表中
图表3-7 库目录
完成后,您的项目属性页应当与下图相似:
图表3-8 完成配置的属性页
点击OK(确定)完成配置。
Hello World
步骤1 创建源文件
在Solution Explorer中您的项目下的Source Files目录上,右键单机,并在菜单中选择Add(添加)->New Item(新项目) Anchor
选择C++ File (.cpp),并将文件命名成main.cpp
步骤2 添加代码
在弹出的编辑器中输入如下代码:
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
#include <rpos/robot_platforms/slamware_core_platform.h> |
...
#include <iostream> |
...
using namespace std; |
...
using namespace rpos::robot_platforms; |
...
int main(int argc, char* argv[]) { SlamwareCorePlatform platform = SlamwareCorePlatform::connect("192.168.111.1", 1445); |
...
cout << "Base version: " << platform.getSDPVersion() << endl; |
...
return 0; |
...
} |
步骤3 编译运行
在Visual Studio的主菜单中,单击Debug(调试)->Start Debugging(开始调试)即可编译运行您的程序。
API参考
概览
对象 | 说明 |
---|---|
rpos::core::Location类 | 位置 |
rpos::core::Rotation类 | 旋转姿态 |
rpos::core::Pose类 | 姿态 |
rpos::core::Action类 | 动作 |
rpos::core::ActionStatus枚举 | 动作执行状态 |
rpos::core::Feature类 | 特征类 |
rpos::core::RectangleF类 | 矩形(float型) |
rpos::core::Vector2f类 | 二维向量(float型) |
rpos::core::Vector2i类 | 二维向量(int型) |
rpos::core::LaserPoint类 | 激光雷达扫描点 |
rpos::core::RobotPlatform类 | 机器人平台基类 |
rpos::robot::heading::HeadingMode枚举 | 机器人移动时头朝向的方式 |
rpos::robot::heading::RobotHeading类 | 机器人头朝向某个物体或者方向的设置 |
rpos::robot::option::MoveOption结构体 | 存储机器人运行时的设置。 |
rpos::actions::MoveAction类 | 移动动作 |
rpos::features::ArtifactProvider类 | 器物功能特征,包括了虚拟墙功能。 |
rpos::features::LocationProvider类 | 定位功能特征。 |
rpos::features::MotionPlanner类 | 路径规划功能特征。 |
rpos::features::SweepMotionPlanner类 | 清扫路径规划功能特征类。 |
rpos::features::SystemResource类 | 系统资源功能特征类。 |
rpos::features::location_provider::Map类 | 地图基类。 |
rpos::features::location_provider::MapType枚举 | MapType枚举表示地图的类型。 |
rpos::features::location_provider::BitmapMap类 | 位图地图。 |
rpos::features::location_provider::BitmapMapPixelFormat枚举 | BitmapMapPixelFormat枚举表示位图地图的像素格式。 |
rpos::features::motion_planner::Path类 | 代表一条路径。 |
rpos::features::system_resource::LaserScan类 | 代表一次激光扫描数据。 |
rpos::robot_platforms::SlamwareCorePlatform类 | Slamware CORE对象 |
图表4-1 API 概览
rpos::core::Location类
概览
Location类用于表示三维空间中的一个坐标,由x,y,z三个成员组成,遵循右手坐标系。
头文件
rpos/core/pose.h
构造器
Location()
创建一个Location对象,并自动将x、y、z都设为0。
Location(double x, double y, double z)
创建一个Location对象,将x、y、z设定为相应的值。
Location(const Location&)
拷贝构造函数。
运算符
Location& operator=(const Location&)
赋值运算符。
方法
double x() const、double& x()
...
x属性。
示例
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
Location location;
std::cout<<location.x()<<std::endl; // output 0
location.x() = 10;
std::cout<<location.x()<<std::endl; // output 10 |
double y()
...
const、double& y()
y属性,用法请参见x属性。
double z()
...
const、double& z()
...
z属性,用法请参见x属性。
rpos::core::Rotation类
表示物体在三维坐标系中的旋转姿态。Rotation使用弧度作为角度单位。
头文件
rpos/core/pose.h
构造器
Rotation()
创建一个Rotation对象,并将yaw,pitch,roll都设定为0。
Rotation(double yaw, double pitch, double roll)
创建一个Rotation对象,并将yaw,pitch,roll都设定为相应值。
Rotation(const Rotation&)
拷贝构造函数。
运算符
Rotation
Location()构造器
创建一个Location对象,并自动将x、y、z都设为0。
Location(double x, double y, double z)构造器
创建一个Location对象,将x、y、z设定为相应的值。
Location(const Location&)构造器
拷贝构造函数。
...
& operator=(const
...
Rotation&)
...
运算
赋值运算符。
属性
double
...
yaw() const、double&
...
yaw()属性
x属性。
示例
Location location;
std::cout<<location.x()<<std::endl; // output 0
location.x() = 10;
std::cout<<location.x()<<std::endl; // output 10
...
摇摆角(单位:弧度),遵循Tait-Bryan angles规则,请参见维基百科关于欧拉角的定义
用法请参见Location::x()的示例。
double pitch() const、double&
...
pitch()属性
...
俯仰角。
double
...
roll()
...
const, double&
...
roll()属性
z属性,用法请参见x属性。
rpos::core::Rotation类
概览
Rotation类用以表示物体在三维坐标系中的旋转姿态。Rotation使用弧度作为角度单位。
头文件
rpos/core/pose.h
构造器
翻滚角。
[Rotation()
#_Rotation()构造器][Rotation(double yaw, double pitch, double roll) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
#_Rotation(double_yaw,_double][Rotation(const Rotation&) | #_Rotation(const_Rotation&)构造器]运算符 | #_Rotation&_operator=(const_Rotation&]方法 Rotation()构造器创建一个Rotation对象,并将yaw,pitch,roll都设定为0。 Rotation(double yaw, double pitch, double roll)构造器创建一个Rotation对象,并将yaw,pitch,roll都设定为相应值。 Rotation(const Rotation&)构造器拷贝构造函数。 Rotation& operator=(const Rotation&)运算符赋值运算符。 double yaw() const、double& yaw()属性摇摆角(单位:弧度),遵循Tait-Bryan angles规则,请参见维基百科内容: double pitch() const、double& pitch()属性俯仰角。 double roll() const, double& roll()属性翻滚角。 rpos::core::Pose类概览Pose包含了Location和Rotation数据,即对象在三维空间中的完整姿态。 头文件rpos/core/pose.h 构造器[Pose() | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
#_Pose()构造器][Pose(const Location&, const Rotation&) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
#_Pose(const_Location&,_const][Pose(const Location&) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
#_Pose(const_Location&)构造器][Pose(const Rotation&) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
#_Pose(const_Rotation&)构造器][Pose(const Pose&) | #_Pose(const_Pose&)构造器]运算符 | #_Pose&_operator=(const_Pose&)运算符]方法
| #_double_roll()_const,_1]Pose()构造器 Pose(const Location&, const Rotation&)构造器构造一个location和rotation为对应值的Pose对象。 Pose(const Location&)构造器构造一个location为对应值,yaw、pitch、roll皆为0的Pose对象。 Pose(const Rotation&)构造器构造一个rotation为对应值,x、y、z皆为0的Pose对象。 Pose(const Pose&)构造器拷贝构造函数。 Pose& operator=(const Pose&)运算符赋值运算符。 const Location& location() const、Location& location()属性位置,详见Location类。 const Rotation& rotation() const、Rotation& rotation()属性旋转,详见Rotation类。 double x() const、double& x()属性x属性。 示例Location location; double y() const、double& y()属性y属性,用法请参见x属性。 double z() const、double& z()属性z属性,用法请参见x属性。 double yaw() const、double& yaw()属性摇摆角(单位:弧度),遵循Tait-Bryan angles规则,请参见维基百科内容: double pitch() const、double& pitch()属性俯仰角。 double roll() const, double& roll()属性翻滚角。 rpos::core::Action类概览Action类表示一个动作。 头文件rpos/core/action.h 构造器运算符Action& operator=(const Action&) 方法ActionStatus getStatus() Action(const Action&)构造器拷贝构造函数。 Action& operator=(const Action&)运算符赋值运算符。 ActionStatus getStatus()获得当前动作状态,返回值详见ActionStatus枚举。 void cancel()取消当前动作。 ActionStatus waitUntilDone()等待动作完成或出错,返回值为动作结束时的动作状态,详见ActionStatus枚举。 template<class ActionT> ActionT cast()将rpos::core::Action的对象转换成子类的对象 示例rpos::core::Action someAction = robotPlatform.startSomeAction(); rpos::core::ActionStatus枚举概览ActionStatus枚举表示动作的状态。 头文件rpos/core/action.h 枚举项ActionStatusWaitingForStart ActionStatusWaitingForStart动作正在等待开始 ActionStatusRunning动作正在进行 ActionStatusFinished动作已经完成 ActionStatusPaused动作已经暂停 ActionStatusStopped动作已经停止(取消) ActionStatusError动作执行过程中出现错误 rpos::core::Feature类概览Feature类表示一个特征,即一个特定的功能集合。 头文件rpos/core/feature.h 构造器运算符Feature& operator=(const Feature&) Feature(const Feature&)构造器拷贝构造函数 Feature& operator=(const Feature&)运算符赋值运算符 rpos::core::RectangleF类概览RectangleF类表示一个矩形,其坐标参数的类型为float。 头文件rpos/core/geometory.h 构造器RectangleF() 运算符RectangleF& operator=(const RectangleF&) 方法[const Vector2f& position() | #_const_Vector2f&_position()、Vector2f] | #_const_Vector2f&_size()、Vector2f&] | #_float_x()_const、float&] | #_float_y()_const、float&] | #_float_width()_const、float&] | #_float_height()_const、float&]
创建一个x、y、width、height都为0的矩形。
创建一个位置和大小为指定值的矩形。
创建一个位置和大小为指定值的矩形。
拷贝构造函数
赋值运算符
矩形的位置(左上角)
矩形的大小
矩形左上角的x坐标
矩形左上角的y坐标
矩形的宽度
矩形的高度
矩形左侧的x坐标
矩形右侧的x坐标(right=x+width)
矩形顶部的y坐标
矩形底部的y坐标(bottom=y+height)
判断点是否在矩形的范围内
判断矩形是否是全空的(即width() < epsilon或height()<epsilon)
判断目标矩形是否完全在本矩形的区域内
计算本矩形和目标矩形重合的部分,并将本矩形设定为该重合部分矩形。
概览二维向量,元素数据类型为float型。 头文件rpos/core/geometry.h 构造器Vector2f() 运算符Vector2f& operator=(const Vector2f&) 方法[float x() const | #_float_x()_const、float&_1] | #_float_y()_const、float&_1]
构造一个新的向量,其x、y的值是不确定的。
构造一个x、y为指定的值的向量。
拷贝构造函数。
赋值运算符。
二维向量的x分量。
二维向量的y分量。
概览二维向量,元素数据类型为int型。 头文件rpos/core/geometry.h 构造器Vector2i() 运算符Vector2i& operator=(const Vector2i&) 方法int x() const
概览激光雷达测距的单点数据,包括了距离、角度、是否有效等信息。 头文件rpos/core/laser_point.h 构造器LaserPoint() 运算符LaserPoint& operator=(const LaserPoint&) 方法[float distance() const | #_float_distance()_const、float&] | #_float_angle()_const、float&] | #_bool_valid()_const、bool&]
创建一个新的LaserPoint对象。
创建一个距离、角度、有效性为指定值的LaserPoint对象。
拷贝构造函数
赋值运算符
距离数据(单位:米)
本次测量的角度(单位:弧度)
本次测量是否有效
概览机器人平台是一系列设备组合而成的整体,提供一系列的特征从而提供功能。RobotPlatform类是所有机器人平台的基类。 头文件rpos/core/robot_platform.h 构造器RobotPlatform(const RobotPlatform&) 运算符RobotPlatform& operator=(const RobotPlatform&) 方法std::vector<Feature> getFeatures()
拷贝构造函数。
赋值运算符。
获得该机器人平台提供的所有特征。
将RobotPlatform对象转换成子类对象,示例请参考rpos::core::Action::cast<>。
概览HeadingMode枚举表示机器人移动时头朝向的方式 头文件rpos/features/motion_planner/move_heading.h 枚举项HeadingModeAuto,
机器人按照自己的方式随意行走。
机器人行走时头与前进方向成固定角度。
机器人行走时头始终朝向某个物体或者某点。
机器人行走时头始终朝向某个固定的方向。
概览RobotHeading类表示机器人在行走的时候的头朝向某个物体或者方向的设置 头文件rpos/features/motion_planner/move_heading.h 构造器RobotHeading() 运算符[RobotHeading& operator=(const RobotHeading&) | #_RobotHeading&_operator=(const_Robot]方法
构造函数。
构造函数。
赋值运算符。
获取机器人行走时头朝向的角度或者物体的位置 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
朝向 | 值 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Pose值不可用 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Pose的Rotation参数可用 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Pose的Location参数可用 |
...
rpos::robot::option::MoveOption结构体
概览
MoveOption结构体存储机器人运行时的设置。
...
rpos::actions::MoveAction类
概览
MoveAction类表示一个移动的动作,它包含了当前机器人规划的路径、检查点列表、移动的进程。
...
MoveAction(boost::shared_ptr<rpos::actions::detail::MoveActionImpl>)
MoveAction(const MoveAction&)
运算符
MoveAction& operator=(const MoveAction&)
...
rpos::features::ArtifactProvider类
概览
器物功能特征,包括了虚拟墙功能。
头文件
rpos/features/artifact_provider.h
...
ArtifactProvider(boost::shared_ptr<detail::ArtifactProviderImpl>)
ArtifactProvider(const ArtifactProvider&)
运算符
ArtifactProvider& operator=(const ArtifactProvider&)
...
#_std::vector<rpos::core::Line>_getWa][bool addWall(const rpos::core::Line&) | ||||
#_bool_addWall(const_rpos::core::Line][bool addWalls(const std::vector<rpos::core::Line>&) | ||||
#_bool_addWalls(const_std::vector<rpo][bool clearWallById(const rpos::core::SegmentID&) | ||||
#_bool_clearWallById(const_rpos::core][bool clearWalls() | #_bool_clearWalls()]ArtifactProvider(boost::shared_ptr<detail::ArtifactProviderImpl>)构造器 ArtifactProvider(const ArtifactProvider&)构造器拷贝构造函数。 ArtifactProvider& operator=(const ArtifactProvider&)运算符赋值运算符。 std::vector<rpos::core::Line> getWalls()获取系统中所有的虚拟墙。 bool addWall(const rpos::core::Line&)添加虚拟墙。 bool addWalls(const std::vector<rpos::core::Line>&)添加虚拟墙。 bool clearWallById(const rpos::core::SegmentID&)清除指定的虚拟墙。 bool clearWalls()清除所有的虚拟墙。 rpos::features::LocationProvider类概览定位功能特征,包括了自动建图和定位的功能(亦即SLAM功能)。 头文件rpos/features/location_provider.h 父类构造器LocationProvider(boost::shared_ptr<detail::LocationProviderImpl>) 运算符LocationProvider& operator=(const LocationProvider&) 方法std::vector<rpos::features::location_provider::MapType> getAvailableMaps() | #_location_provider::Map_getMap(locat] | #_bool_setMap(_const_1] | #_core::RectangleF_getKnownArea(locat] |
#_bool_clearMap()_1][rpos::core::Location getLocation() | ||||
#_core::Location_getLocation()][rpos::core::Pose getPose() | ||||
#_rpos::core::Pose_getPose()][bool setPose(const rpos::core::Pose&) | ||||
#_bool_setPose(const_rpos::core::Pose][bool getMapLocalization() | ||||
#_bool_getMapLocalization()_2][bool setMapLocalization(bool) | ||||
#_bool_setMapLocalization(bool)_2][bool getMapUpdate() | ||||
#_bool_getMapUpdate()_2][bool setMapUpdate(bool) | #_bool_setMapUpdate(bool)_2]LocationProvider(boost::shared_ptr<detail::LocationProviderImpl>)构造器 LocationProvider(const LocationProvider&)构造器拷贝构造函数。 LocationProvider& operator=(const LocationProvider&)运算符赋值运算符。 std::vector< rpos::features::location_provider::MapType> getAvailableMaps()获得该定位功能特征提供的所有地图类型。 rpos::features::location_provider::Map getMap(rpos::features::location_provider::MapType, rpos::core::RectangleF, rpos::features::location_provider::MapKind)获得该定位功能特征提供的指定地图类型指定区域的地图数据。 bool setMap(const rpos::features::location_provider::Map&,rpos::features::location_provider::MapType,rpos::features::location_provider::MapKind)上载指定地图类型指定区域的地图数据到该定位功能特征,返回是否成功。 rpos::core::RectangleF getKnownArea(rpos::features::location_provider::MapType, rpos::features::location_provider::MapKind)获得指定地图类型的地图中,已经完成建图的区域。 bool clearMap()清除地图数据。 rpos::core::Location getLocation()获得机器人在上述地图坐标系统中的坐标。 rpos::core::Pose getPose()获得机器人在上述地图坐标系统中的姿态。 bool setPose(const rpos::core::Pose&)上载当前机器人的姿态到上述地图坐标系统中,返回是否成功。 bool getMapLocalization()获得机器人是否启用定位功能。 bool setMapLocalization(bool)设置机器人是否启用定位功能。 bool getMapUpdate()获取机器人是否启用地图更新功能。 bool setMapUpdate(bool)设置机器人是否启用地图更新功能。 rpos::features::MotionPlanner类概览路径规划功能特征,包括了动态路径规划功能和自动壁障功能。 头文件rpos/features/motion_planner.h 父类构造器MotionPlanner(boost::shared_ptr<detail::MotionPlannerImpl>) 运算符MotionPlanner& operator=(const MotionPlanner&) 方法[rpos::actions::MoveAction moveTo( | |||
#_rpos::actions::MoveAction_moveTo(_c_1][rpos::actions::MoveAction moveTo(const rpos::core::Location&, bool,bool) | ||||
#_rpos::actions::MoveAction_moveTo(co_1][rpos::actions::MoveAction getCurrentAction() | ||||
#_rpos::actions::MoveAction_getCurren_1][rpos::features::motion_planner::Path searchPath(const rpos::core::Location&) | #_rpos::features::motion_planner::Pat_3]MotionPlanner(boost::shared_ptr<detail::MotionPlannerImpl>)构造器 MotionPlanner(const MotionPlanner&)构造器拷贝构造函数。 MotionPlanner& operator=(const MotionPlanner&)运算符赋值运算符。 rpos::actions::MoveAction moveTo( const std::vector<rpos::core::Location>&, bool, bool)让机器人沿着路径移动(机器人会逐一走过路径中的节点,在节点之间尽量走圆滑的曲线,如果遇到障碍物,机器人会自动避开)。 参数 | |||
名称 | 类型 | 说明 | ||
locations | const std::vector | 期望机器人经过的点 | ||
appending | bool | 如果机器人正在执行其他的移动动作,该参数决定新的点是追加或是替换既有节点 | ||
isMilestone | bool | 当这个参数为true时,机器人会将上述点视作关键点,通过路径搜索的方式前往目的地;当参数为false时,会被视作普通点,不会启用路径搜索功能。 |
...
rpos::features::SweepMotionPlanner类
概览
清扫路径规划功能特征类。该类中的功能主要针对扫地机专属版本Slamware Core所提供的清扫和自动回充功能。
...
SweepMotionPlanner(boost::shared_ptr<detail::SweepMotionPlannerImpl>)
SweepMotionPlanner(const SweepMotionPlanner&)
运算符
SweepMotionPlanner& operator=(const SweepMotionPlanner&)
...
#_rpos::actions::SweepMoveAction_star_2][rpos::actions::SweepMoveAction sweepSpot(const rpos::core::Location& location) | ||||||||
#_rpos::actions::SweepMoveAction_swee_1][rpos::actions::MoveAction goHome() | #_rpos::actions::MoveAction_goHome()_2]SweepMotionPlanner(boost::shared_ptr<detail::SweepMotionPlannerImpl>)构造器 SweepMotionPlanner(const SweepMotionPlanner&)构造器拷贝构造函数。 SweepMotionPlanner& operator=(const SweepMotionPlanner&)运算符赋值运算符。 rpos::actions::SweepMoveAction startSweep()让机器人进行清扫。(此接口仅适用于扫地机版本) rpos::actions::SweepMoveAction sweepSpot(const rpos::core::Location& location)让机器人定点打扫。(此接口仅适用于扫地机版本) rpos::actions::MoveAction goHome()让机器人回家充电。 rpos::features::system_resource::DeviceInfo类概览获取设备信息。设备信息包括设备ID,制造商,型号,硬件版本,软件版本。 头文件rpos/features/device_info.h 构造器DeviceInfo() | #_DeviceInfo(const_DeviceInfo&)]运算符 方法[std::string deviceID() const、std::string& deviceID(); | ||||||
#_std::string_deviceID()_const、std::s][int manufacturerID() const、int& manufacturerID(); | ||||||||
#_int_manufacturerID()_const、int&][std::string manufacturerName() const、std::string& manufacturerName(); | ||||||||
#_std::string_manufacturerName()_cons][int modelID() const、int& modelID(); | ||||||||
#_int_modelID()_const、int&]std::string modelName() const、std::string& modelName(); | ||||||||
#_std::string_hardwareVersion()_const_1][std::string softwareVersion() const、std::string& softwareVersion(); | #_std::string_softwareVersion()_const]DeviceInfo() DeviceInfo(const DeviceInfo&)构造一个特定设备信息的函数。 DeviceInfo& operator=(const DeviceInfo&)赋值运算符。 std::string deviceID() const、std::string& deviceID();deviceID属性。 int manufacturerID() const、int& manufacturerID();manufacturerID属性。 std::string manufacturerName() const、std::string& manufacturerName();manufacturerName属性。 int modelID() const、int& modelID();modelID属性。 std::string modelName() const、std::string& modelName();modelName属性。 std::string hardwareVersion() const、std::string& hardwareVersion();硬件版本属性。 std::string softwareVersion() const、std::string& softwareVersion();软件版本属性。 rpos::features::SystemResource类概览系统资源功能特征类。该类提供了对原始激光扫描数据、电源管理系统等相关资源的访问API。 头文件rpos/features/system_resource.h 父类构造器SystemResource(boost::shared_ptr<detail::SystemResourceImpl>) 运算符SystemResource& operator=(const SystemResource&) 方法int getBatteryPercentage() SystemResource(boost::shared_ptr<detail::SystemResourceImpl>)构造器该构造器仅限SDK内部使用。 SystemResource(const SystemResource&)构造器拷贝构造函数。 SystemResource& operator=(const SystemResource&)运算符赋值运算符。 int getBatteryPercentage()获得电池电量,返回值的单位是百分比。比如电池剩余为56%,则该返回值为56。 bool getBatteryIsCharging()电池是否处于充电状态。 bool getDCIsConnected()外部电源是否连接。 int getBoardTemperature()系统温度。 std::string getSDPVersion()底盘的版本号。 rpos::features::system_resource::LaserScan getLaserScan()获取原始激光扫描数据。 rpos::features::location_provider::Map类概览地图基类,泛指定位功能获得的地图。 头文件rpos/features/location_provider.h 构造器Map(boost::shared_ptr<detail::MapImpl>) 运算符方法rpos::core::RectangleF getMapArea() | #_void_setMapData(float,_float,] Map(boost::shared_ptr<detail::MapImpl>)构造器该构造器仅限SDK内部使用。 Map(const Map&)构造器拷贝构造函数。 Map& operator=(const Map&)运算符赋值运算符。 rpos::core::RectangleF getMapArea()获得这张地图所包含的区域。 rpos::core::Vector2f getMapPosition()获得这张地图左上角的坐标。 rpos::core::Vector2i getMapDimension()获得地图的尺寸(两个维度的像素个数) rpos::core::Vector2f getMapResolution()获得地图的分辨率(在各个维度上,每个像素代表多少米) rpos::system::types::timestamp_t getMapTimestamp()获得地图生成的时间。 void setMapData(float, float, int, int, float, const std::vector<_u8>&, rpos::system::types::_u64)设置地图数据。 std::vector<_u8>& getMapData()获得地图数据。 template<class MapT> MapT cast()将地图转换成特定类型的子类对象。 rpos::features::location_provider::MapType枚举概览MapType枚举表示地图的类型。 头文件rpos/features/location_provider.h 枚举项MapTypeBitmap8Bit每像素8位的位图。 rpos::features::location_provider::BitmapMap类概览位图地图。 头文件rpos/features/location_provider.h 父类继承自[rpos::features::location_provider::Map类 | #_rpos::features::location_provider::]构造器 | |||||
#_BitmapMap(boost::shared_ptr<detail:_1]BitmapMap(const BitmapMap&) 运算符BitmapMap& operator=(const BitmapMap&) 方法BitmapMapPixelFormat getMapFormat() 继承自rpos::features::location_provider::Map类的方法
rpos::core::Vector2f getMapPosition() rpos::core::Vector2i getMapDimension() rpos::core::Vector2f getMapResolution() rpos::system::types::timestamp_t getMapTimestamp()[ void setMapData(float, float, int, int, float, const std::vector<_u8>&, rpos::system::types::_u64) | #_void_setMapData(float,_float,] BitmapMap(boost::shared_ptr<detail::BitmapMapImpl>)构造器该构造器仅限SDK内部使用。 BitmapMap(const BitmapMap&)构造器拷贝构造函数。 BitmapMap& operator=(const BitmapMap&)运算符赋值运算符。 BitmapMapPixelFormat getMapFormat()获得地图的像素格式。 rpos::features::location_provider::BitmapMapPixelFormat枚举概览BitmapMapPixelFormat枚举表示位图地图的像素格式。 头文件rpos/features/location_provider.h 枚举项BitmapMapPixelFormat8Bit位图中的每个像素占用1个字节。 rpos::features::motion_planner::Path类概览Path对象是一系列Location对象的集合,代表一条路径。 头文件rpos/features/motion_planner.h 构造器Path(const std::vector<rpos::core::Location>&) 运算符方法std::vector<rpos::core::Location>& getPoints() Path(const std::vector<rpos::core::Location>&)构造器创建一个由一系列点组成的路径。 Path(const Path&)构造器拷贝构造函数。 Path& operator=(const Path&)运算符赋值运算符。 std::vector<rpos::core::Location>& getPoints()获得路径中的所有点。 rpos::features::system_resource::LaserScan类概览LaserScan对象是一系列LaserPoint对象的集合,代表一次激光扫描的数据。 头文件rpos/features/system_resource.h 构造器LaserScan(const std::vector<rpos::core::LaserPoint>&) 运算符LaserScan& operator=(const LaserScan&) 方法std::vector<rpos::core::LaserPoint>& getLaserPoints() LaserScan(const std::vector<rpos::core::LaserPoint>&)构造器创建一个由一系列激光扫描点组成的扫描数据。 LaserScan(const LaserScan&)构造器拷贝构造函数。 LaserScan& operator=(const LaserScan&)运算符赋值运算符。 std::vector<rpos::core::LaserPoint>& getLaserPoints()获取激光扫描数据。 rpos::robot_platforms::SlamwareCorePlatform类概览SlamwareCorePlatform对象代表一个基于Slamware的机器人,用以获取设备的状态、控制设备的行为。 头文件rpos/robot_platforms/slamware_core_platform.h 父类构造器SlamwareCorePlatform(boost::shared_ptr<detail::SlamwareCorePlatformImpl>) 运算符SlamwareCorePlatform& operator=(const SlamwareCorePlatform&) 静态方法SlamwareCorePlatform connect(const std::string&, int, int) 方法void disconnect() | #_features::location_provider::Map_ge] | ||||||
#_bool_setMap(_const_3][bool setMap( const core::Pose&, | #_bool_setMap(_const_2] | #_core::RectangleF_getKnownArea(featu] | ||||||
#_rpos::core::Location_getLocation()]rpos::core::Pose getPose() | ||||||||
#_bool_getMapLocalization()_1][bool setMapLocalization(bool) | ||||||||
#_bool_setMapLocalization(bool)_1][bool getMapUpdate() | ||||||||
#_bool_getMapUpdate()_1][bool setMapUpdate(bool) | ||||||||
#_bool_setMapUpdate(bool)_1]int getLocalizationQuality() | ||||||||
#_actions::MoveAction_getCurrentActio]rpos::actions::MoveAction moveTo(const rpos::core::Location&, rpos::robot::option::MoveOption&) | ||||||||
#_rpos::actions::MoveAction_rotateTo(_1]rpos::actions::MoveAction rotate(const rpos::core::Rotation&) | ||||||||
#_rpos::actions::MoveAction_getCurren]rpos::features::motion_planner::Path searchPath(const rpos::core::Location& location) | ||||||||
#_rpos::actions::SweepMoveAction_star][rpos::actions::SweepMoveAction sweepSpot(const rpos::core::Location& location) | ||||||||
#_rpos::actions::SweepMoveAction_swee][rpos::actions::MoveAction goHome() | ||||||||
#_rpos::actions::MoveAction_goHome()_3][int getBatteryPercentage() | ||||||||
#_int_getBatteryPercentage()]bool getBatteryIsCharging() | ||||||||
#_rpos::features::system_resource::La][bool restartModule(rpos::features::system_resource::RestartMode mode = rpos::features::system_resource::RestartModeSoft) | ||||||||
#_bool_restartModule(rpos::features::_1][bool setSystemParameter(const std::string& param, const std::string& value) | ||||||||
#_bool_setSystemParameter(const_std::][std::string getSystemParameter(const std::string& param) | ||||||||
#_std::string_getSystemParameter(cons][ rpos::features::system_resource::DeviceInfo getDeviceInfo() | ||||||||
#_rpos::features::system_resource::De_2]void startCalibration( rpos::features::system_resource::CalibrationType type) | ||||||||
#_bool_getSensors(std::vector<ImpactS][bool getSensorValues(std::map<features::impact_sensor::impact_sensor_id_t, features::impact_sensor::ImpactSensorValue>& values) | ||||||||
#_bool_getSensorValues(std::map<impac][bool getSensorValues(const std::vector<features::impact_sensor::impact_sensor_id_t>& sensorIds, std::vector<features::impact_sensor::ImpactSensorValue>& values) | ||||||||
#_bool_getSensorValues(const_std::vec][bool getSensorValue(features::impact_sensor::impact_sensor_id_t sensorId, features::impact_sensor::ImpactSensorValue& value) | #_bool_getSensorValue(features::impac]继承自rpos::core::RobotPlatform类的方法 SlamwareCorePlatform(boost::shared_ptr<detail::SlamwareCorePlatformImpl>)构造器该构造器仅限SDK内部使用。 SlamwareCorePlatform(const SlamwareCorePlatform&)构造器拷贝构造函数。 SlamwareCorePlatform& operator=(const SlamwareCorePlatform&)运算符赋值运算符。 SlamwareCorePlatform connect(const std::string&, int, int)连接到指定的Slamware设备。 参数 | |||||||
名称 | 类型 | 说明 | ||||||
host | const std::string& | Slamware Core的IP地址 | ||||||
port | int | Slamware Core的端口(通常为1445) | ||||||
timeout_in_ms | int | 连接超时时间,单位为毫秒 |
...
获取指定传感器的数据。返回值为ImpactSensorValue。
void setCompositeMap(const rpos::robot_platforms::objects::CompositeMap& , const core::Pose& )
设置地图信息。
rpos::robot_platforms::objects::CompositeMap getCompositeMap()
获取地图信息。