arcs::aubo_scope::WaypointModel类 参考

\chinese 路点模型 提供从当前机器人获取路点的方法。 \endchinese \english WaypointModel Provides methods that returns Waypoints from the current robot installation. 更多...

#include <waypoint_model.h>

Public 成员函数
	WaypointModel (WaypointModel &f)
	WaypointModel (WaypointModel &&f)
	~WaypointModel ()
std::vector< WaypointPtr >	getWaypoints ()
	\chinese 获取当前安装中的几何路点
WaypointPtr	getByName (const std::string &name)
	\chinese 根据名称获取路点
WaypointPtr	addWaypoint (const std::string &suggestedName, const std::vector< double > &pose)
	\chinese 向当前AuboScope安装中添加一个路点。添加后终端用户可选择该路点，但不可修改。
WaypointPtr	addWaypoint (const std::string &suggestedName, const std::vector< double > &pose, const std::vector< double > &joint, const std::vector< double > &offset)
	\chinese 向当前AuboScope安装中添加一个包含关节角度和偏移的路点。
void	removeWaypoint (const std::string &name)
	\chinese 从此AuboCap中移除已添加的路点。使用该路点的程序节点将变为未定义状态，因为路点 不再可解析。
void	renameWaypoint (const std::string &name, const std::string &newName)
	\chinese 根据名称重命名模型中的路点

Private 成员函数
	WaypointModel ()

Private 属性
void *	d_ { nullptr }

友元
class	DataSwitch

详细描述

\chinese 路点模型 提供从当前机器人获取路点的方法。 \endchinese \english WaypointModel Provides methods that returns Waypoints from the current robot installation.

\endenglish

在文件 waypoint_model.h 第 22 行定义.

构造及析构函数说明

WaypointModel() [1/3]

arcs::aubo_scope::WaypointModel::WaypointModel

(

WaypointModel &

f

)

引用了 WaypointModel().

被这些函数引用 WaypointModel() , 以及 WaypointModel().

函数调用图:

这是这个函数的调用关系图:

WaypointModel() [2/3]

arcs::aubo_scope::WaypointModel::WaypointModel

(

WaypointModel &&

f

)

引用了 WaypointModel().

函数调用图:

~WaypointModel()

arcs::aubo_scope::WaypointModel::~WaypointModel

(

)

WaypointModel() [3/3]

arcs::aubo_scope::WaypointModel::WaypointModel ( )

private

成员函数说明

addWaypoint() [1/2]

WaypointPtr arcs::aubo_scope::WaypointModel::addWaypoint	(	const std::string &	suggestedName,
		const std::vector< double > &	pose )

\chinese 向当前AuboScope安装中添加一个路点。添加后终端用户可选择该路点，但不可修改。

参数

suggestedName	建议的路点名称。有效名称必须匹配正则表达式 [a-zA-Z][a-zA-Z0-9_]{0,14}，总共15个字符。最终名称可从返回的Waypoint实例获取。
pose	路点相对于机器人基座的位姿。

返回

在AuboScope中创建并注册的路点。

异常

WaypointAlreadyAddedException	如果之前已用相同的idKey标 识符添加过路点。使用getWaypoint(String)检查路点是否已添加到当前安装中。 使用updateWaypoint(String, Pose)来更新路点。
IllegalWaypointNameException	如果建议的名称不匹配所需的正则表达式。 \endchinese \english Add a Waypoint to the current AuboScope installation. This makes it selectable by the end user. The Waypoint is not modifiable by the end user.

参数

suggestedName	Suggested name for the Waypoint. Valid names must match regex [a-zA-Z][a-zA-Z0-9_]{0,14} for a total of 15 characters. The final name can be retrieved from the returned Waypoint instance.
pose	The pose of the Waypoint with respect to the robot base.

返回

The Waypoint created and registered in AuboScope.

异常

WaypointAlreadyAddedException	If a Waypoint has previously been added the same idKey identifier. Use getWaypoint(String) to check if the Waypoint has already been added to the current installation. Use updateWaypoint(String, Pose) to update the Waypoint.
IllegalWaypointNameException	If the suggested name does not match required regex. \endenglish

addWaypoint() [2/2]

WaypointPtr arcs::aubo_scope::WaypointModel::addWaypoint	(	const std::string &	suggestedName,
		const std::vector< double > &	pose,
		const std::vector< double > &	joint,
		const std::vector< double > &	offset )

\chinese 向当前AuboScope安装中添加一个包含关节角度和偏移的路点。

参数

suggestedName	建议的路点名称。有效名称必须匹配正则表达式 [a-zA-Z][a-zA-Z0-9_]{0,14}，总共15个字符。最终名称可从返回的Waypoint实例获取。
pose	路点相对于机器人基座的位姿。
joint	路点相对于机器人基座的关节角度。
offset	路点相对于机器人基座的TCP偏移。

返回

在AuboScope中创建并注册的路点。

异常

WaypointAlreadyAddedException	如果之前已用相同的idKey标 识符添加过路点。
IllegalWaypointNameException	如果建议的名称不匹配所需的正则表达式。 \endchinese \english Add a Waypoint to the current AuboScope installation with joint angles and offset.

参数

suggestedName	Suggested name for the Waypoint. Valid names must match regex [a-zA-Z][a-zA-Z0-9_]{0,14} for a total of 15 characters. The final name can be retrieved from the returned Waypoint instance.
pose	The pose of the Waypoint with respect to the robot base.
joint	The joint of the Waypoint with respect to the robot base.
offset	The tcp of the Waypoint with respect to the robot base.

返回

The Waypoint created and registered in AuboScope.

异常

WaypointAlreadyAddedException	If a Waypoint has previously been added the same idKey identifier. Use getWaypoint(String) to check if the Waypoint has already been added to the current installation. Use updateWaypoint(String, Pose) to update the Waypoint.
IllegalWaypointNameException	If the suggested name does not match required regex. \endenglish

getByName()

WaypointPtr arcs::aubo_scope::WaypointModel::getByName

(

const std::string &

name

)

\chinese 根据名称获取路点

参数

name

路点名称。

返回

对应名称的路点。 \endchinese \english Returns the Waypoint by name.

参数

name	the name of the Waypoint.

返回

the Waypoint with the given name. \endenglish

getWaypoints()

std::vector< WaypointPtr > arcs::aubo_scope::WaypointModel::getWaypoints

(

)

\chinese 获取当前安装中的几何路点

返回

当前安装中的几何路点集合。 \endchinese \english Returns the geometric Waypoints of the current installation.

the geometric Waypoints of the current installation. \endenglish

removeWaypoint()

void arcs::aubo_scope::WaypointModel::removeWaypoint

(

const std::string &

name

)

\chinese 从此AuboCap中移除已添加的路点。使用该路点的程序节点将变为未定义状态，因为路点 不再可解析。

参数

name	添加路点时使用的名称。

异常

WaypointNotFoundException

如果没有与提供的idKey对应 的路点存在。 \endchinese \english Remove a Waypoint added by this AuboCap from AuboScope. Program nodes using the Waypoint will be become undefined because the Waypoint is no longer resolvable.

参数

name	The key used to add the Waypoint with.

异常

WaypointNotFoundException

If no Waypoint exists with the provided idKey. \endenglish

renameWaypoint()

void arcs::aubo_scope::WaypointModel::renameWaypoint	(	const std::string &	name,
		const std::string &	newName )

\chinese 根据名称重命名模型中的路点

参数

name	原始名称。
newName	新名称。 \endchinese \english Rename the waypoint in the model by the name.
name	the original name.
newName	the new name. \endenglish

友元及相关符号说明

DataSwitch

friend class DataSwitch

friend

在文件 waypoint_model.h 第 169 行定义.

引用了 DataSwitch.

被这些函数引用 DataSwitch.

类成员变量说明

d_

void* arcs::aubo_scope::WaypointModel::d_ { nullptr }

private

在文件 waypoint_model.h 第 171 行定义.

---

该类的文档由以下文件生成:

• include/aubo_caps/domain/waypoint/waypoint_model.h