arcs::aubo_scope::TcpContributionModel类 参考

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

#include <tcp_contribution_model.h>

Public 成员函数
	TcpContributionModel (TcpContributionModel &f)
	TcpContributionModel (TcpContributionModel &&f)
virtual	~TcpContributionModel ()
TCPPtr	addTcp (const std::string &idKey, const std::string &suggested_name, const std::vector< double > &offset)
	TCP \chinese 向当前AuboScope安装中添加一个TCP。添加后终端用户可选择该TCP，但不可修改。
TCPPtr	getTcp (const std::string &idKey)
	TCP \chinese 返回此前由此AuboCap使用相同idKey添加的TCP。
void	updateTcp (const std::string &idKey, const std::vector< double > &newOffset)
	\chinese 更新此AuboCap已添加TCP的偏移量。
void	removeTcp (const std::string &idKey)
	\chinese 从此AuboCap中移除已添加的TCP。使用该TCP的程序节点将变为未定义。

Private 成员函数
	TcpContributionModel ()

Private 属性
void *	d_ { nullptr }

友元
class	DataSwitch

详细描述

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

注意：此接口只能在安装贡献中使用。 \endchinese \english TcpContributionModel This interface provides functionality for adding, updating and removing TCPs in AuboScope.

Note: This interface must only be used in an installation contribution. \endenglish

在文件 tcp_contribution_model.h 第 27 行定义.

构造及析构函数说明

TcpContributionModel() [1/3]

arcs::aubo_scope::TcpContributionModel::TcpContributionModel

(

TcpContributionModel &

f

)

引用了 TcpContributionModel().

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

函数调用图:

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

TcpContributionModel() [2/3]

arcs::aubo_scope::TcpContributionModel::TcpContributionModel

(

TcpContributionModel &&

f

)

引用了 TcpContributionModel().

函数调用图:

~TcpContributionModel()

virtual arcs::aubo_scope::TcpContributionModel::~TcpContributionModel ( )

virtual

TcpContributionModel() [3/3]

arcs::aubo_scope::TcpContributionModel::TcpContributionModel ( )

private

成员函数说明

addTcp()

TCPPtr arcs::aubo_scope::TcpContributionModel::addTcp	(	const std::string &	idKey,
		const std::string &	suggested_name,
		const std::vector< double > &	offset )

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

参数

idKey	用于标识此TCP的键。该键仅对此AuboCap有效。
suggested_name	建议的TCP名称。
offset	TCP相对于工具输出法兰的偏移量。

返回

在AuboScope中创建并注册的TCP。

异常

TCPAlreadyAddedException	如果已使用相同idKey添加过TCP。
IllegalTCPNameException	如果建议的名称不匹配所需正则表达式。
IllegalArgumentException	如果偏移量超出有效范围。 \endchinese \english Add a TCP to the current AuboScope installation. This makes it selectable by the end user. The TCP is not modifiable by the end user.

参数

idKey	The key to identify this TCP by.
suggested_name	Suggested name for the TCP.
offset	The offset of the TCP with respect to the tool output flange.

返回

The TCP created and registered in AuboScope.

异常

TCPAlreadyAddedException	If called twice using the same idKey.
IllegalTCPNameException	If the suggested name does not match regex.
IllegalArgumentException	If the offset is invalid. \endenglish

getTcp()

TCPPtr arcs::aubo_scope::TcpContributionModel::getTcp

(

const std::string &

idKey

)

TCP \chinese 返回此前由此AuboCap使用相同idKey添加的TCP。

参数

idKey

TCP标识符键。

返回

此前添加的TCP，如果不存在则返回null。 \endchinese \english Returns the TCP previously added by this AuboCap using the same idKey.

参数

idKey

The key to identify this TCP by.

返回

The TCP previously added by this AuboCap. \endenglish

removeTcp()

void arcs::aubo_scope::TcpContributionModel::removeTcp

(

const std::string &

idKey

)

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

参数

idKey

添加TCP时使用的键。

异常

TCPNotFoundException

如果不存在对应idKey的TCP。 \endchinese \english Remove a TCP added by this AuboCap from AuboScope.

参数

idKey

The key used to add the TCP with.

异常

TCPNotFoundException

If no TCP exists with the provided idKey. \endenglish

updateTcp()

void arcs::aubo_scope::TcpContributionModel::updateTcp	(	const std::string &	idKey,
		const std::vector< double > &	newOffset )

\chinese 更新此AuboCap已添加TCP的偏移量。

参数

idKey	TCP标识符键。
newOffset	TCP的新偏移量。

异常

TCPNotFoundException	如果不存在对应idKey的TCP。
IllegalArgumentException	如果偏移量超出有效范围。 \endchinese \english Update the offset of a TCP already added by this AuboCap.

参数

idKey	The key to identify the TCP.
newOffset	The new offset to set for the TCP.

异常

TCPNotFoundException	If no TCP exists with the provided idKey.
IllegalArgumentException	If the offset is invalid. \endenglish

友元及相关符号说明

DataSwitch

friend class DataSwitch

friend

在文件 tcp_contribution_model.h 第 116 行定义.

引用了 DataSwitch.

被这些函数引用 DataSwitch.

类成员变量说明

d_

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

private

在文件 tcp_contribution_model.h 第 118 行定义.

---

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

• include/aubo_caps/domain/tcp/tcp_contribution_model.h