本页提供了基于Windows平台开发SLAMWARE SDK的API参考。

...

本页内容

...

SDK内容

目录结构

Slamware SDK包含了大量您开发过程中可能会用到的资源、代码、和项目文件，其目录结构组织如下：

头文件结构

在include目录下，我们包含了Slamware SDK以及它所依赖的所有库的头文件：

创建项目工程

新建工程

步骤1 打开Visual Studio 2010并新建项目

Image Added

1. 选择Visual C++项目，并选择Win32 Console Application（Win32控制台应用程序）项目类型
2. 在Name（名称）中输入项目名称
3. 点击OK（确定）

步骤2 设定应用程序选项

Image Added
点击Next（下一步）
Image Added

1. Application Type（应用程序类型）选择Console Application（命令行应用程序）
2. Additional  options（附加选项）勾选Empty Project（空项目）
3. 点击Finish完成项目创建

配置编译选项

步骤1 打开项目属性面板

在Solution Explorer（解决方案）中右键单击您刚刚创建的项目，并单击Properties（属性）菜单，打开属性面板：
Image Added

步骤2 配置VC++目录

在左侧列表中，选择VC++ Directories（VC++目录）
Image Added

1. 选中右侧的Include Directories（包含目录），并点击下拉按钮
2. 选择<Edit…>（<编辑…>）
3. 将第一章节中提到的SDK中的include目录加入到列表中

Image Added

1. 选中右侧的Library Directories（库目录），并点击下拉按钮
2. 选择<Edit…>（<编辑…>）
3. 将第一种中提到的SDK中的lib目录加入到列表中

Image Added
完成后，您的项目属性页应当与下图相似：
Image Added
点击OK（确定）完成配置。

Hello World

步骤1 创建源文件

在Solution Explorer中您的项目下的Source Files目录上，右键单机，并在菜单中选择Add（添加）->New Item（新项目）
Image Added
选择C++ File (.cpp)，并将文件命名成main.cpp

步骤2 添加代码

在弹出的编辑器中输入如下代码：

#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类

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属性

示例

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& operator=(const Rotation&)

赋值运算符

方法

double yaw() const、double& yaw()

摇摆角（单位：弧度），遵循Tait-Bryan angles规则，请参见维基百科相关定义。用法请参见Location::x()的示例

double pitch() const、double& pitch()

俯仰角

double roll() const, double& roll()

翻滚角

rpos::core::Pose类

Pose包含了Location和Rotation数据，即对象在三维空间中的完整姿态

头文件

pos/core/pose.h

构造器

Pose()

构造一个x、y、z、yaw、pitch、roll都为0的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;
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属性

double yaw() const、double& yaw()

摇摆角（单位：弧度），遵循Tait-Bryan angles规则，请参见维基百科相关定义

用法请参见Location::x()的示例

double pitch() const、double& pitch()

俯仰角

double roll() const, double& roll()

翻滚角

rpos::core::Action类

rpos/core/action.h

构造器

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::actions::MoveAction moveAction = someAction.cast<rpos::actions::MoveAction>;

rpos/core/action.h

rpos::core::Feature类

Feature类表示一个特征，即一个特定的功能集合

头文件

rpos/core/feature.h

构造器

拷贝构造函数

运算符

赋值运算符

rpos::core::RectangleF类

RectangleF类表示一个矩形，其坐标参数的类型为float

头文件

rpos/core/geometory.h

构造器

RectangleF()构造器

创建一个x、y、width、height都为0的矩形

RectangleF(Vector2f position, Vector2f size)

创建一个位置和大小为指定值的矩形

RectangleF(float x, float y, float width, float height)

创建一个位置和大小为指定值的矩形

RectangleF(const RectangleF&)

拷贝构造函数

运算符

RectangleF& operator=(const RectangleF&)

赋值运算符

方法

const Vector2f& position()、Vector2f& position()

矩形的位置（左上角）

const Vector2f& size()、Vector2f& size()

矩形的大小

float x() const、float& x()

矩形左上角的x坐标

float y() const、float& y()

矩形左上角的y坐标

float width() const、float& width()

矩形的宽度

float height() const、float& height()

矩形的高度

float left() const

矩形左侧的x坐标

float right() const

矩形右侧的x坐标（right=x+width）

float top() const

矩形顶部的y坐标

float bottom() const

矩形底部的y坐标（bottom=y+height）

bool contains(const Vector2i& point)

判断点是否在矩形的范围内

bool empty()

判断矩形是否是全空的（即width() < epsilon或height()<epsilon）

bool contains(const RectangleF& dest)

判断目标矩形是否完全在本矩形的区域内

void unionOf(const RectangleF& dest)

计算本矩形和目标矩形重合的部分，并将本矩形设定为该重合部分矩形

rpos::core::Vector2f类

二维向量，元素数据类型为float型

头文件

rpos/core/geometry.h

构造器

Vector2f()

构造一个新的向量，其x、y的值是不确定的

Vector2f(float x, float y)

构造一个x、y为指定的值的向量

Vector2f(const Vector2f&)

拷贝构造函数

运算符

Vector2f& operator=(const Vector2f&)

赋值运算符

方法

float x() const、float& x()

二维向量的x分量

float y() const、float& y()

二维向量的y分量

rpos::core::Vector2i类

二维向量，元素数据类型为int型

头文件

rpos/core/geometry.h

构造器

运算符

方法

rpos/core/laser_point.h

rpos/core/robot_platform.h

rpos/features/motion_planner/move_heading.h

rpos/features/motion_planner/move_heading.h

rpos/features/motion_planner/move_option.h

rpos/features/motion_planner/move_action.h

rpos/features/location_provider.h

rpos/features/motion_planner.h

rpos/features/sweep_motion_planner.h

rpos/features/device_info.h

rpos/features/location_provider.h

rpos/features/location_provider.h

rpos/features/location_provider.h

rpos/features/motion_planner.h

rpos/features/system_resource.h

rpos/robot_platforms/slamware_core_platform.h

rpos::feature::location_provider:MapType mapType = rpos::feature::location_provider:MapType::MapTypeBitmap8Bit;
rpos::feature::location_provider:Mapkind mapKind = rpos::feature::location_provider:MapKind::EXPLORERMAP;
rpos::core::Rectangle knownArea = robotPlatform.getKnownArea(mapType, mapKind);
rpos::feature::location_provider:Map map = robotPlatform.getMap(mapType, knownArea, mapKind);

rpos::feature::location_provider:MapType mapType = rpos::feature::location_provider:MapType::MapTypeBitmap8Bit;
rpos::feature::location_provider:Mapkind mapKind = rpos::feature::location_provider:MapKind::EXPLORERMAP;
rpos::core::Rectangle knownArea = robotPlatform.getKnownArea(mapType, mapKind);
rpos::feature::location_provider:Map map = robotPlatform.getMap(mapType, knownArea, mapKind);
bool bRet = robotPlatform.setMap(map, mapType, mapKind);

rpos::core::Pose pose;
rpos::feature::location_provider:MapType mapType = rpos::feature::location_provider:MapType::MapTypeBitmap8Bit;
rpos::feature::location_provider:Mapkind mapKind = rpos::feature::location_provider:MapKind::EXPLORERMAP;
rpos::core::Rectangle knownArea = robotPlatform.getKnownArea(mapType, mapKind);
rpos::feature::location_provider:Map map = robotPlatform.getMap(mapType, knownArea, mapKind);
bool bRet = robotPlatform.setMap(pose, map, mapType, mapKind);

rpos::feature::location_provider:MapType mapType = rpos::feature::location_provider:MapType::MapTypeBitmap8Bit;
rpos::feature::location_provider:Mapkind mapKind = rpos::feature::location_provider:MapKind::EXPLORERMAP;
rpos::core::Rectangle knownArea = robotPlatform.getKnownArea(mapType, mapKind);

std::vector<rpos::core::Location> locations;
rpos::core::Location location(1,1);
locations.push
rpos::robot::option::MoveAction moveOption;
moveOption.appending = false;
moveOption.isMilestone = true;
rpos::core::Pose pose(Rotation(2));
rpos::robot::heading::RobotHeading robotHeading(rpos::robot::heading::HeadingMode::HeadingModeFixAngle, pose);
moveOption.robotHeading = robotHeading;
rpos::actions::MoveAction moveInfo = robotPlatform.moveTo(locations, moveOption);

rpos::core::ACTION_DIRECTION actionDirection = rpos::core::ACTION_DIRECTION::FORWARD;
rpos::core::Direction direction(actionDirection);
rpos::actions::MoveAction moveBy = platform.moveBy(direction);

Bool bRet = platform.setSystemParameter(SYSPARAM_ROBOT_SPEED, SYSVAL_ROBOT_SPEED_HIGH);

std::map<std::string, std::string> options;
options["ssid"] = "Slamtec";
options["password"] = "slamtect";
Bool bRet = platform.configureNetwork(rpos::features::system_resource::NetworkMode::NetworkModeStation,options);

struct ImpactSensorInfo {
           impact_sensor_id_t id;
           rpos::core::Pose pose;
           ImpactSensorType type;
           float refreshFreq;
};

struct ImpactSensorValue {
           impact_sensor_timestamp_t time;
           float value;
};

auto pose = platform.getPose();

rpos::robot_platforms::objects::Metadata metadata;
std::vector< boost::shared_ptr<rpos::robot_platforms::objects::MapLayer> > maps;

auto map_layer_v_walls = boost::make_shared<rpos::robot_platforms::objects::LineMapLayer>();
maps.push_back(map_layer_v_walls);
map_layer_v_walls->setUsage("virtual_walls");
map_layer_v_walls->setType(rpos::robot_platforms::objects::LineMapLayer::Type);
rpos::robot_platforms::objects::Line line(Point(0, 0), Point(10, 10));
line.name ="1";
map_layer_v_walls->lines()[line.name] = line;

rpos::robot_platforms::objects::CompositeMap compositeMap(metadata, maps);
platform. setCompositeMap (compositeMap, pose);

...

目录
SDK内容
目录结构
头文件结构
开发环境要求
创建项目工程
新建工程
配置编译选项
Hello World
API参考
概览
rpos::core::Location类
rpos::core::Rotation类
rpos::core::Pose类
rpos::core::Action类
rpos::core::ActionStatus枚举
rpos::core::Feature类
rpos::core::RectangleF类
rpos::core::Vector2f类
rpos::core::Vector2i类
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::system_resource::DeviceInfo类
rpos::features::SystemResource类
rpos::features::location_provider::Map类
rpos::features::location_provider::MapType枚举
rpos::features::location_provider::BitmapMap类
rpos::features::location_provider::BitmapMapPixelFormat枚举
rpos::features::motion_planner::Path类
rpos::features::system_resource::LaserScan类
rpos::robot_platforms::SlamwareCorePlatform类
修订历史
附录
图表索引

...

Slamware SDK包含了大量您开发过程中可能会用到的资源、代码、和项目文件，其目录结构组织如下：

...

...

要基于Slamware SDK进行应用开发，需要您的开发环境满足如下条件：

• 您的计算机应当安装Visual Studio 2010 SP1（由于我们提供的预编译库采用Visual Studio 2010 SP1进行编译，所以不可使用Visual Studio 2012或者2013进行开发）

...

步骤1 打开Visual Studio 2010并新建项目

...

1. 选择Visual C++项目，并选择Win32 Console Application（Win32控制台应用程序）项目类型
2. 在Name（名称）中输入项目名称
3. 点击OK（确定）

步骤2 设定应用程序选项

...

1. Application Type（应用程序类型）选择Console Application（命令行应用程序）
2. Additional options（附加选项）勾选Empty Project（空项目）
3. 点击Finish完成项目创建

...

步骤1 打开项目属性面板

...

步骤2 配置VC++目录

...

1. 选中右侧的Include Directories（包含目录），并点击下拉按钮
2. 选择<Edit…>（<编辑…>）
3. 将第一种中提到的SDK中的include目录加入到列表中

...

1. 选中右侧的Library Directories（库目录），并点击下拉按钮
2. 选择<Edit…>（<编辑…>）
3. 将第一种中提到的SDK中的lib目录加入到列表中

...

步骤1 创建源文件

...

步骤2 添加代码

在弹出的编辑器中输入如下代码：

步骤3 编译运行

在Visual Studio的主菜单中，单击Debug（调试）->Start Debugging（开始调试）即可编译运行您的程序。

...

...

概览

Location类用于表示三维空间中的一个坐标，由x，y，z三个成员组成，遵循右手坐标系。

头文件

rpos/core/pose.h

构造器

Location()
Location(double x, double y, double z)
Location(const Location&)

运算符

Location& operator=(const Location&)

方法

double x() const
double& x()
double y() const
double& y()
double z() const
double& z()

...

创建一个Location对象，并自动将x、y、z都设为0。

...

创建一个Location对象，将x、y、z设定为相应的值。

...

拷贝构造函数。

Anchor
_Location&_operator (const_Location&

Location& operator=(const Location&)运算符

赋值运算符。

...

x属性。

...

Location location;
std::cout<<location.x()<<std::endl; // output 0
location.x() = 10;
std::cout<<location.x()<<std::endl; // output 10

...

y属性，用法请参见x属性。

...

z属性，用法请参见x属性。

...

概览

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&_operator=(const_Rotation&]方法
double yaw() const
double& yaw()
double pitch() const
double& pitch()
double roll() const
double& roll()

...

创建一个Rotation对象，并将yaw，pitch，roll都设定为0。

...

创建一个Rotation对象，并将yaw，pitch，roll都设定为相应值。

...

拷贝构造函数。

Anchor
_Rotation&_operator (const_Rotation&

Rotation& operator=(const Rotation&)运算符

赋值运算符。

...

摇摆角（单位：弧度），遵循Tait-Bryan angles规则，请参见维基百科内容：
{+}http://en.wikipedia.org/wiki/Euler_angles#Tait.E2.80.93Bryan_angles+
用法请参见Location::x()的示例。

...

俯仰角。

...

翻滚角。

...

概览

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&)

#_Pose&_operator=(const_Pose&)运算符]方法
const Location& location() const
Location& location()
const Rotation& rotation() const
Rotation& rotation()
double x() const
double& x()
double y() const
double& y()
double z() const
double& z()
double yaw() const
double& yaw()
double pitch() const
double& pitch()
double roll() const
[double& roll()

...

#_double_roll()_const,_1]Pose()构造器
构造一个x、y、z、yaw、pitch、roll都为0的Pose对象。

...

构造一个location和rotation为对应值的Pose对象。

...

构造一个location为对应值，yaw、pitch、roll皆为0的Pose对象。

...

构造一个rotation为对应值，x、y、z皆为0的Pose对象。

...

拷贝构造函数。

Anchor
_Pose&_operator (const_Pose&)运算符

Pose& operator=(const Pose&)运算符

赋值运算符。

...

位置，详见Location类。

...

旋转，详见Rotation类。

...

x属性。

示例

Location location;
std::cout<<location.x()<<std::endl; // output 0
location.x() = 10;
std::cout<<location.x()<<std::endl; // output 10

...

y属性，用法请参见x属性。

...

z属性，用法请参见x属性。

...

摇摆角（单位：弧度），遵循Tait-Bryan angles规则，请参见维基百科内容：
{+}http://en.wikipedia.org/wiki/Euler_angles#Tait.E2.80.93Bryan_angles+
用法请参见Location::x()的示例。

...

俯仰角。

...

翻滚角。

...

概览

Action类表示一个动作。

头文件

rpos/core/action.h

构造器

Action(const Action&)

运算符

Action& operator=(const Action&)

方法

ActionStatus getStatus()
void cancel()
ActionStatus waitUntilDone()
template<class ActionT> ActionT cast()

...

拷贝构造函数。

Anchor
_Action&_operator (const_Action&)

Action& operator=(const Action&)运算符

赋值运算符。

...

获得当前动作状态，返回值详见ActionStatus枚举。

...

取消当前动作。

...

等待动作完成或出错，返回值为动作结束时的动作状态，详见ActionStatus枚举。

...

将rpos::core::Action的对象转换成子类的对象

...

rpos::core::Action someAction = robotPlatform.startSomeAction();
rpos::actions::MoveAction moveAction = someAction.cast<rpos::actions::MoveAction>;

...

概览

ActionStatus枚举表示动作的状态。

头文件

rpos/core/action.h

枚举项

ActionStatusWaitingForStart
ActionStatusRunning
ActionStatusFinished
ActionStatusPaused
ActionStatusStopped
ActionStatusError

...

动作正在等待开始

...

动作正在进行

...

动作已经完成

...

动作已经暂停

...

动作已经停止（取消）

...

动作执行过程中出现错误

...

概览

Feature类表示一个特征，即一个特定的功能集合。

头文件

rpos/core/feature.h

构造器

Feature(const Feature&)

运算符

Feature& operator=(const Feature&)

...

拷贝构造函数

Anchor
_Feature&_operator (const_Feature&)

Feature& operator=(const Feature&)运算符

赋值运算符

...

概览

RectangleF类表示一个矩形，其坐标参数的类型为float。

头文件

rpos/core/geometory.h

构造器

RectangleF()
RectangleF(Vector2f position, Vector2f size)
RectangleF(float x, float y, float width, float height)
RectangleF(const RectangleF&)

运算符

RectangleF& operator=(const RectangleF&)

方法

[const Vector2f& position()
Vector2f& position()

...

#_const_Vector2f&_position()、Vector2f]
[const Vector2f& size()
Vector2f& size()

...

#_const_Vector2f&_size()、Vector2f&]
[float x() const
float& x()

...

#_float_x()_const、float&]
[float y() const
float& y()

...

#_float_y()_const、float&]
[float width() const
float& width()

...

#_float_width()_const、float&]
[float height() const
float& height()

#_float_height()_const、float&]
float left() const
float right() const
float top() const
float bottom() const
bool contains(const Vector2i& point)
bool empty()
bool contains(const RectangleF& dest)
void unionOf(const RectangleF& dest)

...

创建一个x、y、width、height都为0的矩形。

...

创建一个位置和大小为指定值的矩形。

...

创建一个位置和大小为指定值的矩形。

...

拷贝构造函数

Anchor
_RectangleF&_operator (const_Rectang

RectangleF& operator=(const RectangleF&)运算符

赋值运算符

...

矩形的位置（左上角）

...

矩形的大小

...

矩形左上角的x坐标

...

矩形左上角的y坐标

...

矩形的宽度

...

矩形的高度

...

矩形左侧的x坐标

...

矩形右侧的x坐标（right=x+width）

...

矩形顶部的y坐标

...

矩形底部的y坐标（bottom=y+height）

...

判断点是否在矩形的范围内

...

判断矩形是否是全空的（即width() < epsilon或height()<epsilon）

...

判断目标矩形是否完全在本矩形的区域内

...

计算本矩形和目标矩形重合的部分，并将本矩形设定为该重合部分矩形。

...

概览

二维向量，元素数据类型为float型。

头文件

rpos/core/geometry.h

构造器

Vector2f()
Vector2f(float x, float y)
Vector2f(const Vector2f&)

运算符

Vector2f& operator=(const Vector2f&)

方法

[float x() const
float& x()

...

#_float_x()_const、float&_1]
[float y() const
float& y()

#_float_y()_const、float&_1]

...

构造一个新的向量，其x、y的值是不确定的。

...

构造一个x、y为指定的值的向量。

...

拷贝构造函数。

Anchor
_Vector2f&_operator (const_Vector2f&

Vector2f& operator=(const Vector2f&)运算符

赋值运算符。

...

二维向量的x分量。

...

二维向量的y分量。

...

概览

二维向量，元素数据类型为int型。

头文件

rpos/core/geometry.h

构造器

Vector2i()
Vector2i(float x, float y)
Vector2i(const Vector2i&)

运算符

Vector2i& operator=(const Vector2i&)

方法

int x() const
int& x()
int y() const
int& y()
与rpos::core::Vector2f类类似，不再赘述。

...

概览

激光雷达测距的单点数据，包括了距离、角度、是否有效等信息。

头文件

rpos/core/laser_point.h

构造器

LaserPoint()
LaserPoint(float distance, float angle, bool valid)
LaserPoint(const LaserPoint&)

运算符

LaserPoint& operator=(const LaserPoint&)

方法

[float distance() const
float& distance()

...

#_float_distance()_const、float&]
[float angle() const
float& angle()

...

#_float_angle()_const、float&]
[bool valid() const
bool& valid()

#_bool_valid()_const、bool&]

...

创建一个新的LaserPoint对象。

...

创建一个距离、角度、有效性为指定值的LaserPoint对象。

...

拷贝构造函数

Anchor
_LaserPoint&_operator (const_LaserPo

LaserPoint& operator=(const LaserPoint&)运算符

赋值运算符

...

距离数据（单位：米）

...

本次测量的角度（单位：弧度）

...

本次测量是否有效

...

概览

机器人平台是一系列设备组合而成的整体，提供一系列的特征从而提供功能。RobotPlatform类是所有机器人平台的基类。

头文件

rpos/core/robot_platform.h

构造器

RobotPlatform(const RobotPlatform&)

运算符

RobotPlatform& operator=(const RobotPlatform&)

方法

std::vector<Feature> getFeatures()
template<class RobotPlatformT> RobotPlatformT cast()

...

拷贝构造函数。

Anchor
_RobotPlatform&_operator (const_Robo

RobotPlatform& operator=(const RobotPlatform&)运算符

赋值运算符。

...

获得该机器人平台提供的所有特征。

...

将RobotPlatform对象转换成子类对象，示例请参考rpos::core::Action::cast<>。

...

概览

HeadingMode枚举表示机器人移动时头朝向的方式

头文件

rpos/features/motion_planner/move_heading.h

枚举项

HeadingModeAuto,
HeadingModeFixAngle,
HeadingModeCircleMotion,
HeadingModeDirection

...

机器人按照自己的方式随意行走。

...

机器人行走时头与前进方向成固定角度。

...

机器人行走时头始终朝向某个物体或者某点。

...

机器人行走时头始终朝向某个固定的方向。

...

概览

RobotHeading类表示机器人在行走的时候的头朝向某个物体或者方向的设置

头文件

rpos/features/motion_planner/move_heading.h

构造器

RobotHeading()
RobotHeading(HeadingMode headingMode, rpos::core::Pose pose)

运算符

[RobotHeading& operator=(const RobotHeading&)

#_RobotHeading&_operator=(const_Robot]方法
const rpos::core::Pose& pose() const
const HeadingMode& headingMode() const

...

构造函数。

...

构造函数。

Anchor
_RobotHeading&_operator (const_Robot

RobotHeading& operator=(const RobotHeading&)运算符

赋值运算符。

...

获取机器人行走时头朝向的角度或者物体的位置
头朝向与位置或者角度的对应关系。

...

朝向

...

值

...

HeadingModeAuto

...

Pose值不可用

...

HeadingModeFixAngle或者HeadingModeDirection

...

Pose的Rotation参数可用

...

HeadingModeCircleMotion

...

Pose的Location参数可用

...

获取机器人行走时头朝向设置。
可以参考rpos::robot::heading::HeadingMode。

...

概览

MoveOption结构体存储机器人运行时的设置。

头文件

rpos/features/motion_planner/move_option.h

结构体说明

appending
isMilestone
robotHeading

...

如果机器人正在执行其他的移动动作，该参数决定新的点是追加或是替换既有节点。

...

机器人是否通过路径搜索的方式前往目的地。

...

机器人行走时头朝向设置。
参考rpos::robot::heading::RobotHeading。

...

概览

MoveAction类表示一个移动的动作，它包含了当前机器人规划的路径、检查点列表、移动的进程。

头文件

rpos/features/motion_planner/move_action.h

父类

继承自rpos::core::Action类

构造器

MoveAction(boost::shared_ptr<rpos::actions::detail::MoveActionImpl>)
MoveAction(const MoveAction&)

运算符

MoveAction& operator=(const MoveAction&)

方法

rpos::features::motion_planner::Path getRemainingPath()
rpos::features::motion_planner::Path getRemainingMilestones()

继承自rpos::core::Action类的方法

ActionStatus getStatus()
void cancel()
ActionStatus waitUntilDone()
template<class ActionT> ActionT cast()

...

该构造器仅限SDK内部使用。

...

拷贝构造函数。

Anchor
_MoveAction&_operator (const_MoveAct

MoveAction& operator=(const MoveAction&)运算符

赋值运算符。

...

获得已经规划好的，剩余的路径。

...

获得剩余的里程碑。

...

概览

器物功能特征，包括了虚拟墙功能。

头文件

rpos/features/artifact_provider.h

父类

继承自rpos::core::Feature类

构造器

ArtifactProvider(boost::shared_ptr<detail::ArtifactProviderImpl>)
ArtifactProvider(const ArtifactProvider&)

运算符

ArtifactProvider& operator=(const ArtifactProvider&)

方法

[std::vector<rpos::core::Line> getWalls()

...

#_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>)构造器
该构造器仅限SDK内部使用。

...

拷贝构造函数。

Anchor
_ArtifactProvider&_operator (const_A

ArtifactProvider& operator=(const ArtifactProvider&)运算符

赋值运算符。

...

获取系统中所有的虚拟墙。

...

添加虚拟墙。

...

添加虚拟墙。

...

清除指定的虚拟墙。

...

清除所有的虚拟墙。

...

概览

定位功能特征，包括了自动建图和定位的功能（亦即SLAM功能）。

头文件

rpos/features/location_provider.h

父类

继承自rpos::core::Feature类

构造器

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)

...

#_location_provider::Map_getMap(locat]
[bool setMap(
const rpos::features::location_provider::Map&,
rpos::features::location_provider::MapType,
rpos::features::location_provider::MapKind)

...

#_bool_setMap(_const_1]
[rpos::core::RectangleF getKnownArea(
rpos::features::location_provider::MapType,
rpos::features::location_provider::MapKind)

...

#_core::RectangleF_getKnownArea(locat]
[bool clearMap()

...

#_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>)构造器
该构造器仅限SDK内部使用。

...

拷贝构造函数。

Anchor
_LocationProvider&_operator (const_L

LocationProvider& operator=(const LocationProvider&)运算符

赋值运算符。

...

获得该定位功能特征提供的所有地图类型。

...

获得该定位功能特征提供的指定地图类型指定区域的地图数据。

...

上载指定地图类型指定区域的地图数据到该定位功能特征，返回是否成功。

...

获得指定地图类型的地图中，已经完成建图的区域。

...

清除地图数据。

...

获得机器人在上述地图坐标系统中的坐标。

...

获得机器人在上述地图坐标系统中的姿态。

...

上载当前机器人的姿态到上述地图坐标系统中，返回是否成功。

...

获得机器人是否启用定位功能。

...

设置机器人是否启用定位功能。

...

获取机器人是否启用地图更新功能。

...

设置机器人是否启用地图更新功能。

...

概览

路径规划功能特征，包括了动态路径规划功能和自动壁障功能。

头文件

rpos/features/motion_planner.h

父类

继承自rpos::core::Feature类

构造器

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)

...

#_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>)构造器
该构造器仅限SDK内部使用。

...

拷贝构造函数。

Anchor
_MotionPlanner&_operator (const_Moti

MotionPlanner& operator=(const MotionPlanner&)运算符

赋值运算符。

...

让机器人沿着路径移动（机器人会逐一走过路径中的节点，在节点之间尽量走圆滑的曲线，如果遇到障碍物，机器人会自动避开）。

参数

...

名称

...

类型

...

说明

...

locations

...

const std::vector
<rpos::core::Location>&

...

期望机器人经过的点

...

appending

...

bool

...

如果机器人正在执行其他的移动动作，该参数决定新的点是追加或是替换既有节点

...

isMilestone

...

bool

...

当这个参数为true时，机器人会将上述点视作关键点，通过路径搜索的方式前往目的地；当参数为false时，会被视作普通点，不会启用路径搜索功能。

...

让机器人移动到目标位置。

参数

...

获得机器人当前正在进行的移动动作。
您可以使用Action::isEmpty()方法判断它是否存在。当机器人当前没有正在进行的动作时，它Action::isEmpty()将会返回true。

...

使用机器人内置的寻路算法寻找前往指定目的地的路径。

...

概览

清扫路径规划功能特征类。该类中的功能主要针对扫地机专属版本Slamware Core所提供的清扫和自动回充功能。

头文件

rpos/features/sweep_motion_planner.h

父类

继承自rpos::core::Feature类

构造器

SweepMotionPlanner(boost::shared_ptr<detail::SweepMotionPlannerImpl>)
SweepMotionPlanner(const SweepMotionPlanner&)

运算符

SweepMotionPlanner& operator=(const SweepMotionPlanner&)

方法

[rpos::actions::SweepMoveAction startSweep()

...

#_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>)构造器
该构造器仅限SDK内部使用。

...

拷贝构造函数。

Anchor
_SweepMotionPlanner&_operator (const

SweepMotionPlanner& operator=(const SweepMotionPlanner&)运算符

赋值运算符。

...

让机器人进行清扫。（此接口仅适用于扫地机版本）

...

让机器人定点打扫。（此接口仅适用于扫地机版本）

...

让机器人回家充电。

...

概览

获取设备信息。设备信息包括设备ID，制造商，型号，硬件版本，软件版本。

头文件

rpos/features/device_info.h

构造器

DeviceInfo()
[DeviceInfo(const DeviceInfo&)

...

#_DeviceInfo(const_DeviceInfo&)]运算符
DeviceInfo& operator=(const DeviceInfo&)

方法

[std::string deviceID() const、std::string& deviceID();

...

#_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、std::string& hardwareVersion();

#_std::string_hardwareVersion()_const_1][std::string softwareVersion() const、std::string& softwareVersion();

...

#_std::string_softwareVersion()_const]DeviceInfo()
构造函数。

...

构造一个特定设备信息的函数。

Anchor
_DeviceInfo&_operator (const_DeviceI

DeviceInfo& operator=(const DeviceInfo&)

赋值运算符。

...

deviceID属性。

...

manufacturerID属性。

...

manufacturerName属性。

...

modelName属性。

...

硬件版本属性。

...

软件版本属性。

...

概览

系统资源功能特征类。该类提供了对原始激光扫描数据、电源管理系统等相关资源的访问API。

头文件

rpos/features/system_resource.h

父类

继承自rpos::core::Feature类

构造器

SystemResource(boost::shared_ptr<detail::SystemResourceImpl>)
SystemResource(const SystemResource&)

运算符

SystemResource& operator=(const SystemResource&)

方法

...

该构造器仅限SDK内部使用。

...

拷贝构造函数。

Anchor
_SystemResource&_operator (const_Sys

SystemResource& operator=(const SystemResource&)运算符

赋值运算符。

...

获得电池电量，返回值的单位是百分比。比如电池剩余为56%，则该返回值为56。

...

电池是否处于充电状态。

...

外部电源是否连接。

...

系统温度。

...

底盘的版本号。

...

获取原始激光扫描数据。

...

概览

地图基类，泛指定位功能获得的地图。

头文件

rpos/features/location_provider.h

构造器

Map(boost::shared_ptr<detail::MapImpl>)
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)

#_void_setMapData(float,_float,]
std::vector<_u8>& getMapData()
template<class MapT> MapT cast()

...

该构造器仅限SDK内部使用。

...

拷贝构造函数。

Anchor
_Map&_operator (const_Map&)

Map& operator=(const Map&)运算符

赋值运算符。

...

获得这张地图所包含的区域。

...

获得这张地图左上角的坐标。

...

获得地图的尺寸（两个维度的像素个数）

...

获得地图的分辨率（在各个维度上，每个像素代表多少米）

...

获得地图生成的时间。

...

设置地图数据。

...

获得地图数据。

...

将地图转换成特定类型的子类对象。

...

概览

MapType枚举表示地图的类型。

头文件

rpos/features/location_provider.h

枚举项

MapTypeBitmap8Bit

...

每像素8位的位图。

...

概览

位图地图。

头文件

rpos/features/location_provider.h

父类

继承自[rpos::features::location_provider::Map类

...

#_rpos::features::location_provider::]构造器
[BitmapMap(boost::shared_ptr<detail::BitmapMapImpl>)

#_BitmapMap(boost::shared_ptr<detail:_1]BitmapMap(const BitmapMap&)

运算符

BitmapMap& operator=(const BitmapMap&)

方法

BitmapMapPixelFormat getMapFormat()

继承自rpos::features::location_provider::Map类的方法

...

#_void_setMapData(float,_float,]
std::vector<_u8>& getMapData()
template<class MapT> MapT cast()

...

该构造器仅限SDK内部使用。

...

拷贝构造函数。

Anchor
_BitmapMap&_operator (const_BitmapMa

BitmapMap& operator=(const BitmapMap&)运算符

赋值运算符。

...

获得地图的像素格式。

...

概览

BitmapMapPixelFormat枚举表示位图地图的像素格式。

头文件

rpos/features/location_provider.h

枚举项

BitmapMapPixelFormat8Bit

...

位图中的每个像素占用1个字节。

...

概览

Path对象是一系列Location对象的集合，代表一条路径。

头文件

rpos/features/motion_planner.h

构造器

Path(const std::vector<rpos::core::Location>&)
Path(const Path&)

运算符

Path& operator=(const Path&)

方法

std::vector<rpos::core::Location>& getPoints()

...

创建一个由一系列点组成的路径。

...

拷贝构造函数。

Anchor
_Path&_operator (const_Path&)

Path& operator=(const Path&)运算符

赋值运算符。

...

获得路径中的所有点。

...

概览

LaserScan对象是一系列LaserPoint对象的集合，代表一次激光扫描的数据。

头文件

rpos/features/system_resource.h

构造器

LaserScan(const std::vector<rpos::core::LaserPoint>&)
LaserScan(const LaserScan&)

运算符

LaserScan& operator=(const LaserScan&)

方法

std::vector<rpos::core::LaserPoint>& getLaserPoints()

...

创建一个由一系列激光扫描点组成的扫描数据。

...

拷贝构造函数。

Anchor
_LaserScan&_operator (const_LaserSca

LaserScan& operator=(const LaserScan&)运算符

赋值运算符。

...

获取激光扫描数据。

...

概览

SlamwareCorePlatform对象代表一个基于Slamware的机器人，用以获取设备的状态、控制设备的行为。

头文件

rpos/robot_platforms/slamware_core_platform.h

父类

继承自rpos::core::RobotPlatform类

构造器

SlamwareCorePlatform(boost::shared_ptr<detail::SlamwareCorePlatformImpl>)
SlamwareCorePlatform(const SlamwareCorePlatform&)

运算符

SlamwareCorePlatform& operator=(const SlamwareCorePlatform&)

静态方法

SlamwareCorePlatform connect(const std::string&, int, int)

方法

void disconnect()
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()
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)

...

#_features::location_provider::Map_ge]
[bool setMap(
const rpos::features::location_provider::Map&,
rpos::features::location_provider::MapType,
rpos::features::location_provider::MapKind，bool partially=false)

...

#_bool_setMap(_const_3][bool setMap( const core::Pose&,
const rpos::features::location_provider::Map&,
rpos::features::location_provider::MapType,
rpos::features::location_provider::MapKind, bool partially = false)

...

#_bool_setMap(_const_2]
[rpos::core::RectangleF getKnownArea(
rpos::features::location_provider::MapType,
rpos::features::location_provider::MapKind)

...

#_core::RectangleF_getKnownArea(featu]
bool clearMap()
bool clearMap(rpos::features::location_provider::MapKind kind)
[rpos::core::Location getLocation()

...

#_rpos::core::Location_getLocation()]rpos::core::Pose getPose()
bool setPose(const rpos::core::Pose&)
[bool getMapLocalization()

...

#_bool_getMapLocalization()_1][bool setMapLocalization(bool)

...

#_bool_setMapLocalization(bool)_1][bool getMapUpdate()

...

#_bool_getMapUpdate()_1][bool setMapUpdate(bool)

...

#_bool_setMapUpdate(bool)_1]int getLocalizationQuality()
rpos::actions::MoveAction moveTo(const std::vector<rpos::core::Location>&, bool, bool)
rpos::actions::MoveAction moveTo(const rpos::core::Location&, bool, bool)
[rpos::actions::MoveAction moveTo( const std::vector< rpos::core::Location>&, rpos::robot::option::MoveOption&)

...

#_actions::MoveAction_getCurrentActio]rpos::actions::MoveAction moveTo(const rpos::core::Location&, rpos::robot::option::MoveOption&)
rpos::actions::MoveAction moveBy(const rpos::core::Direction& direction)
[rpos::actions::MoveAction rotateTo(const rpos::core::Rotation&)

...

#_rpos::actions::MoveAction_rotateTo(_1]rpos::actions::MoveAction rotate(const rpos::core::Rotation&)
[rpos::actions::MoveAction getCurrentAction()

...

#_rpos::actions::MoveAction_getCurren]rpos::features::motion_planner::Path searchPath(const rpos::core::Location& location)
[rpos::actions::SweepMoveAction startSweep()

...

#_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()
bool getDCIsConnected()
int getBoardTemperature()
std::string getSDPVersion()
std::string getSDKVersion()
[rpos::features::system_resource::LaserScan getLaserScan()

...

#_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)
void stopCalibration()
rpos::features::system_resource::BaseHealthInfo getRobotHealth()
void clearRobotHealth(int errorCode)
bool configurateNetwork(rpos::features::system_resouce::NetworkMode mode, const std::map<std::string, std::string>& options)
std::map<std::string, std::string> getNetworkStatus()
[bool getSensors(std::vector<features::impact_sensor::ImpactSensorInfo>& sensors)

...

#_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类的方法
std::vector<Feature> getFeatures()
template<class RobotPlatformT> RobotPlatformT cast()

...

该构造器仅限SDK内部使用。

...

拷贝构造函数。

Anchor
_SlamwareSdpPlatform&_operator (cons

SlamwareCorePlatform& operator=(const SlamwareCorePlatform&)运算符

赋值运算符。

...

连接到指定的Slamware设备。

参数

...

名称

...

类型

...

说明

...

host

...

const std::string&

...

Slamware Core的IP地址

...

port

...

int

...

Slamware Core的端口（通常为1445）

...

timeout_in_ms

...

int

...

连接超时时间，单位为毫秒

...

断开与CORE之间的连接。

...

获取系统中所有的虚拟墙。

...

添加虚拟墙。

...

添加多个虚拟墙。

...

清除指定的虚拟墙。

...

清除所有的虚拟墙。

...

获得该Slamware CORE提供的所有地图类型。

...

获得该Slamware CORE提供的指定地图类型指定区域的地图数据。

参数

示例

...

上载指定地图类型指定区域的地图数据到该Slamware CORE。

参数

示例

...

上载指定地图类型指定区域的地图数据到该Slamware CORE。

参数

示例

...

获得指定地图类型的地图中，已经完成建图的区域。

示例

...

清除地图数据。

...

清除指定地图类型的地图数据。

...

获得机器人在上述地图坐标系统中的坐标。

...

获得机器人在上述地图坐标系统中的姿态。

...

获得机器人在上述地图坐标系统中的姿态。

...

获取地图定位。

...

设定是否启用定位功能。

...

获得是否启用地图更新功能。

...

设定是否启用地图更新功能。

...

获取雷达定位点的可信度(返回一个0到100的数值,数值越高 当前雷达点的定位越可信，建议取50以上的定位点)

...

让机器人沿着路径移动（机器人会逐一走过路径中的节点，在节点之间尽量走圆滑的曲线，如果遇到障碍物，机器人会自动避开）。
参数详细参考 rpos::action::MoveAction MoveTo(const std::vector<rpos::core::Location>&, bool, bool)

...

让机器人移动到目标位置。
参数详细参考 rpos::action::MoveAction MoveTo(const rpos::core::Location&, bool, bool)

...

让机器人沿着路径移动（机器人会逐一走过路径中的节点，并根据MoveAction参数的变量决定机器人行走的方式和移动过朝向）。

参数

moveOption详细可参考rpos::robot::option::MoveOption

示例

...

让机器人沿着路径移动（机器人会逐一走过路径中的节点，并根据MoveAction参数的变量决定机器人行走的方式和移动过朝向）。
详细参考 rpos::actions::MoveAction moveTo(const std::vector<rpos::core::Location>&,rpos::robot::option::MoveAction&)

...

控制机器人的运行方向

参数

示例

注：direction参数rpos::core::ACTION_DIRECTION取值说明如下

...

单位

...

说明

...

FORWARD

...

...

向前

...

BACKWARD

...

...

向后

...

TURNRIGHT

...

...

向右

...

TURNLEFT

...

...

向左

rpos::actions::MoveAction rotateTo(const rpos::core::Rotation&)

使机器人水平转动到特定的角度。

...

使机器人水平转动一定的角度。

...

获得机器人当前正在进行的移动动作。
您可以使用rpos::core::Action::isEmpty()方法判断它是否存在。当机器人当前没有正在进行的动作时，它rpos::core::Action::isEmpty()将会返回true。

...

使用机器人内置的寻路算法寻找前往指定目的地的路径。

...

命令机器人开始打扫。（此接口仅适用于扫地机版本）

...

在机器人处于扫地状态下，可以命令机器人定点清扫。（此接口仅适用于扫地机版本）

...

在机器人处于扫地状态下，可命令机器人返回充电位置。（此接口仅适用于扫地机版本）

...

获得机器人电池剩余电量（0表示完全没电，100表示电量全满）。

...

获得机器人是否正在充电。

...

获得直流电源是否插上。

...

获得机器人核心温度。单位是0.1℃，比如该函数的返回结果为452，则表示机器人的核心温度为45.2℃。

...

获得机器人底盘的版本号。

...

获得SDK的版本号。

...

根据指定的重启模式（默认软复位）执行重启操作。 重启模式： RestartModeSoft(软复位)，重启SDK，速度较快。建议使用。 RestartModeHard(硬复位)，速度较慢，需要几分钟时间。不建议经常使用。

...

调整系统参数

参数