Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

包名

描述

com.slamtec.slamware

 包含有主要与slamware相关的类。

com.slamtec.slamware.action

 包含有与运动方式相关的类。

com.slamtec.slamware.discovery

 包含有与发现设备相关的类。

com.slamtec.slamware.FirmwareUpdate

 包含有与固件更新相关的类。

com.slamtec.slamware.geometry

 包含有与geometry相关的类。

com.slamtec.slamware.robot

 包含有与robot相关的类。

com.slamtec.slamware.exceptions
com.slamtec.slamware.message
com.slamtec.slamware.sdp

类列表

类名

描述

AbstractDiscover

类, 表示abstract discover interface。

AbstractDiscover.BleConfigureListener

类, 表示BleConfigureListener。

AbstractDiscover.DiscoverStatus

类,表示DiscoverStatus。

AbstractDiscover.DiscoveryListener

类,表示DiscoveryListener。

AbstractSlamwarePlatform

类,定义统一的接口用于和SLAMWARE设备通讯。

ActionStatus

枚举,列举动作状态。

BleDevice

类,表示BleDevice。

Device

类,表示设备。

DeviceManager

类,表示管理设备的管理程序。

DiscoveryMode

枚举,列举发现机器人的模式。

FirmwareUpdateInfo

类,表示固件更新信息。

FirmwareUpdateProgress

类,表示固件更新进程。

HealthInfo

类,表示健康状况。

HealthInfo.BaseError

类,表示底盘健康状况和错误信息。

IAction

接口,表示机器人动作。

IMoveAction

接口,表示移动动作。

ISweepMoveAction

接口,表示清扫动作。

LaserPoint

类,表示激光扫描点。

LaserScan

类,表示一次激光扫描。

Line

类,表示线。

Location

类,表示机器人在3D空间中的位置。

Map(Robot)

类,表示机器人所在的位置地图。

Map(SDP)

类,表示SDP所在的位置地图。

MapKind

枚举,列举地图种类。

MapType

枚举,列举地图数据类型。

MdnsDevice

类,MdnsDevice。

MoveDirection

类,列举人工控制机器人时的方向指令。

NetworkMode

类,表示网络模式。

Path

类,表示路径。

PointF

类,表示2D浮点小数数据类型。

Pose

类,表示机器人姿态。

RestartMode

枚举,列举重启模式。

Rotation

类,表示旋转。

Size

类,表示整数型的Size类别。

SlamwareCorePlatform

类,Abstract Slamware Platform类的子类。

SlamwareSdpPlatform

类,表示SDP扩展平台。

SystemParameters

类,表示系统参数。

...

waitUntilDone()

等待动作完成。返回值为完成的动作结果。

boolean isEmpty()

检查当前动作是否为空。

int getActionId()

获取当前动作id。

String getReason()

获取当前action结束后返回的字符串,成功后会返回不为null且长度为0的字符串,失败后会返回说明失败原因的字符串,如“failed”表示action失败, “aborted”表示action被打断(主动调用cancel或在action未结束时启动新的action),
对于moveTo接口返回的action,“unreachable”表示目标点不可达(搜索路径失败)。

IMoveAction IAction接口

继承自 IAction

...

cancel, getActionName, getProgress, getStatus, waitUntilDone

 pause()

暂停机器人的当前动作。

 resume()

恢复机器人暂停之前进行的动作。


ISweepMoveAction IAction接口

...

public void clear() 

清除points map数据。

com.slamtec.slamware.exceptions包

AlreadyConnectedException类

已连接到机器,异常信息为“Already Connected to the device”。

ConnectionFailException类

连接机器人失败,异常信息为“Connection Failed”。 

ConnectionLostException类

连接丢失,异常信息为“Connection Lost” 。

ConnectionTimeOutException类

连接超时,异常信息为“Connection Time Out”。

InvalidArgumentException类

参数无效,异常信息为“Invalid Argument” 。

OperationFailException类

操作失败,异常信息为“Operation Failed”。 

OutOfResourceException类

资源不足,异常信息为“Out of Resource”。

ParseInvalidException类

参数解析无效,异常信息为“Failed to parse device data” 。

PathFindFailException类

未能找到路径,异常信息为“Failed to find path”。 

RequestFailException类

请求失败异常 Request Failed

RequestTimeOutException类

请求时间超时异常 Request Time Out

UnauthorizedRequestException类

未授权请求异常 Unauthorized request.

UnsupportedCommandException类

不支持的命令异常 Unsupported Command


com.slamtec.slamware.message包

DepthCameraFrame类

构造器

DepthCameraFrame()

创建DepthCameraFrame 对象。

方法

setMinValidDistance(float minValidDistance)

设置深度摄像头最小探测的距离,单位是米。

float getMinValidDistance()

获取深度摄像头最小探测的距离,单位是米。

setMaxValidDistance()

设置深度摄像头最大探测的距离,单位是米。

float getMaxValidDistance()

获取深度摄像头最大探测的距离,单位是米。

setMinFovPitch(float MinFovPitch)

设置深度摄像头垂直方向朝下最大探测仰度,单位是弧度。

float getMinFovPitch()

获取深度摄像头垂直方向朝下最大探测仰度,单位是弧度。

setMaxFovPitch(float MaxFovPitch)

设置深度摄像头垂直方向朝上最小探测的仰角,单位是弧度。

float getMaxFovPitch()

获取深度摄像头垂直方向朝上最小探测的仰角,单位是弧度。

setMinFovYaw(float MinFovYaw )

设置深度摄像头水平方向朝左最大探测的角度,单位是弧度。

float getMinFovYaw()

获取深度摄像头水平方向朝左最大探测的角度,单位是弧度。

setMaxFovYaw(float MaxFovYaw)

设置深度摄像头水平方向朝右最小探测的角度,单位是弧度。

float getMaxFovYaw()

获取深度摄像头水平方向朝右最小探测的角度,单位是弧度。

setCols(int cols)

设置深度摄像头数据多少列。

int getCols()

获取深度摄像头数据多少列。

setRows(int rows)

设置深度摄像头数据多少行。

int getRows()

获取深度摄像头数据多少行。

setData(ArrayList<Float> data)

设置深度摄像头采集到的数据,数据大小为行*列(cols*rows),数据的排列由左到右依次往下 ,float的单位是米。

ArrayList<float> getData()

获取深度摄像头采集到的数据,数据大小为行*列(cols*rows),数据的排列由左到右依次往下 ,float的单位是米。

com.slamtec.slamware.sdp包

Action类

继承自 IAction。

方法

cancel()

取消本次操作。

getActionName()

获取动作名称。返回值为动作名称(string)。

getProgress()

获取动作进程(0~1)。返回值为动作进程(double)。

getStatus()

获取动作状态。返回值为动作状态。

waitUntilDone()

等待动作完成。返回值为完成的动作结果。

isEmpty()

判断当前action是否为空。

getActionId()

获取当前action的id。

String getActionName()

获取到当前action的名字。

String getReason()

获取当前action结束后返回的字符串,成功后会返回不为null且长度为0的字符串,失败后会返回失败原因的字符串,如“failed”表示action失败, “aborted”表示action被打断(主动调用cancel或者在action没有结束的时候启动新的action),对于通过moveTo接口返回的action,“unreachable”表示目标点不可达(搜索路径失败)。

releaseCPointer()

释放所有指针资源。

CompositeMapHelper 

地图工具类

构造器

CompositeMapHelper()

创建CompositeMapHelper对象。

方法

loadFile(String var1)

根据路径加载地图。

saveFile(String var1, CompositeMap var2)

根据路径保存地图。