arcs::aubo_scope::TcpContributionModel Class Reference

TcpContributionModel This interface provides functionality for adding, updating and removing TCPs in AuboScope. More...

#include <tcp_contribution_model.h>

Public Member Functions
	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 Add a TCP to the current AuboScope installation.
TCPPtr	getTcp (const std::string &idKey)
	TCP Returns the TCP previously added by this AuboCap using the same idKey.
void	updateTcp (const std::string &idKey, const std::vector< double > &newOffset)
	Update the offset of a TCP already added by this AuboCap.
void	removeTcp (const std::string &idKey)
	Remove a TCP added by this AuboCap from AuboScope.

Private Member Functions
	TcpContributionModel ()

Private Attributes
void *	d_ { nullptr }

Friends
class	DataSwitch

Detailed Description

TcpContributionModel This interface provides functionality for adding, updating and removing TCPs in AuboScope.

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

Definition at line 27 of file tcp_contribution_model.h.

Constructor & Destructor Documentation

TcpContributionModel() [1/3]

arcs::aubo_scope::TcpContributionModel::TcpContributionModel

(

TcpContributionModel &

f

)

References TcpContributionModel().

Referenced by TcpContributionModel(), and TcpContributionModel().

Here is the call graph for this function:

Here is the caller graph for this function:

TcpContributionModel() [2/3]

arcs::aubo_scope::TcpContributionModel::TcpContributionModel

(

TcpContributionModel &&

f

)

References TcpContributionModel().

Here is the call graph for this function:

~TcpContributionModel()

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

virtual

TcpContributionModel() [3/3]

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

private

Member Function Documentation

addTcp()

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

TCP 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.

Parameters

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.

Returns

The TCP created and registered in AuboScope.

Exceptions

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

getTcp()

TCPPtr arcs::aubo_scope::TcpContributionModel::getTcp

(

const std::string &

idKey

)

TCP Returns the TCP previously added by this AuboCap using the same idKey.

Parameters

idKey

The key to identify this TCP by.

Returns

The TCP previously added by this AuboCap.

removeTcp()

void arcs::aubo_scope::TcpContributionModel::removeTcp

(

const std::string &

idKey

)

Remove a TCP added by this AuboCap from AuboScope.

Parameters

idKey

The key used to add the TCP with.

Exceptions

TCPNotFoundException

If no TCP exists with the provided idKey.

updateTcp()

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

Update the offset of a TCP already added by this AuboCap.

Parameters

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

Exceptions

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

Friends And Related Symbol Documentation

DataSwitch

friend class DataSwitch

friend

Definition at line 116 of file tcp_contribution_model.h.

References DataSwitch.

Referenced by DataSwitch.

Member Data Documentation

d_

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

private

Definition at line 118 of file tcp_contribution_model.h.

---

The documentation for this class was generated from the following file:

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