arcs::aubo_scope::FeatureContributionModel类 参考

特征贡献模型 此接口提供在 AuboScope 中添加、更新和删除特征的功能。 更多...

#include <feature_contribution_model.h>

Public 成员函数
	FeatureContributionModel (FeatureContributionModel &f)
	FeatureContributionModel (FeatureContributionModel &&f)
	~FeatureContributionModel ()
FeaturePtr	addFeature (const std::string &idKey, const std::string &suggestedName, const std::vector< double > &pose)
	向当前AuboScope安装中添加一个特征。添加后终端用户可选择该特征，但不可修改。
FeaturePtr	getFeature (const std::string &idKey)
	返回此前由此AuboCap使用相同idKey标识符添加的特征。用于验证特征是否存在。
void	updateFeature (const std::string &idKey, const std::vector< double > &newPose)
	更新此AuboCap已添加特征的位姿。
void	renameFeature (const std::string &idKey, const std::string &newName)
void	removeFeature (const std::string &idKey)
	从此AuboCap中移除已添加的特征。使用该特征的程序节点将变为未定义。

Private 成员函数
	FeatureContributionModel ()

Private 属性
void *	d_ { nullptr }

友元
class	DataSwitch

详细描述

特征贡献模型 此接口提供在 AuboScope 中添加、更新和删除特征的功能。

注意：此接口只能在安装贡献中使用。

在文件 feature_contribution_model.h 第 28 行定义.

构造及析构函数说明

FeatureContributionModel() [1/3]

arcs::aubo_scope::FeatureContributionModel::FeatureContributionModel

(

FeatureContributionModel &

f

)

引用了 FeatureContributionModel().

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

函数调用图:

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

FeatureContributionModel() [2/3]

arcs::aubo_scope::FeatureContributionModel::FeatureContributionModel

(

FeatureContributionModel &&

f

)

引用了 FeatureContributionModel().

函数调用图:

~FeatureContributionModel()

arcs::aubo_scope::FeatureContributionModel::~FeatureContributionModel

(

)

FeatureContributionModel() [3/3]

arcs::aubo_scope::FeatureContributionModel::FeatureContributionModel ( )

private

成员函数说明

addFeature()

FeaturePtr arcs::aubo_scope::FeatureContributionModel::addFeature	(	const std::string &	idKey,
		const std::string &	suggestedName,
		const std::vector< double > &	pose )

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

参数

idKey	用于标识此特征的键。该键仅对此AuboCap有效。
suggestedName	建议的特征名称。有效名称必须匹配正则表达式 [a-zA-Z][a-zA-Z0-9_]{0,14}。
pose	特征相对于机器人基座的位姿。

返回

在AuboScope中创建并注册的特征。

异常

FeatureAlreadyAddedException	如果之前已用相同idKey添加过特征。
IllegalFeatureNameException	如果建议的名称不匹配所需正则表达式。

getFeature()

FeaturePtr arcs::aubo_scope::FeatureContributionModel::getFeature

(

const std::string &

idKey

)

返回此前由此AuboCap使用相同idKey标识符添加的特征。用于验证特征是否存在。

参数

idKey

用于标识特征的键。

返回

此前添加的特征，如果不存在则返回null。

removeFeature()

void arcs::aubo_scope::FeatureContributionModel::removeFeature

(

const std::string &

idKey

)

从此AuboCap中移除已添加的特征。使用该特征的程序节点将变为未定义。

参数

idKey

添加特征时使用的键。

异常

FeatureNotFoundException

如果不存在对应idKey的特征。

renameFeature()

void arcs::aubo_scope::FeatureContributionModel::renameFeature	(	const std::string &	idKey,
		const std::string &	newName )

updateFeature()

void arcs::aubo_scope::FeatureContributionModel::updateFeature	(	const std::string &	idKey,
		const std::vector< double > &	newPose )

更新此AuboCap已添加特征的位姿。

参数

idKey	用于标识特征的键。
newPose	特征的新位姿。

异常

FeatureNotFoundException

如果不存在对应idKey的特征。

友元及相关符号说明

DataSwitch

friend class DataSwitch

friend

在文件 feature_contribution_model.h 第 123 行定义.

引用了 DataSwitch.

被这些函数引用 DataSwitch.

类成员变量说明

d_

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

private

在文件 feature_contribution_model.h 第 125 行定义.

---

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

• include/aubo_caps/domain/feature/feature_contribution_model.h