com.ur.urcap.api.domain.tcp

Interface TCP

public interface TCP

This interface represents a TCP in the installation in PolyScope. This can either be a user-defined TCP or a TCP added by a URCap.

Since:

1.5.0

Method Summary

Modifier and Type	Method and Description
String	getDisplayName() Gets the name of the TCP displayed in the PolyScope UI.
Pose	getOffset()
boolean	isResolvable() A TCP cannot be guaranteed to be present in PolyScope.

Method Detail

getOffset

Pose getOffset()

Returns:

The offset of the TCP with respect to the tool output flange, if the TCP is resolvable, otherwise null.

getDisplayName

String getDisplayName()

Gets the name of the TCP displayed in the PolyScope UI.

Note: The TCP can change name at any time, and thus the name must not be used to uniquely identify a specific TCP. The TCP name can change in the following situations:

• The TCP is renamed by the end user
• The name gets translated (depending on the selected language in PolyScope)
• The name is changed between versions of the URCap that added the TCP

Returns:

The name of the TCP displayed in PolyScope

isResolvable

boolean isResolvable()

A TCP cannot be guaranteed to be present in PolyScope. This method can be used to determine, if the TCP is present.

The TCP will not be present, if the end user loads a different installation which does not contain the TCP, or if the TCP is removed by the end user or the URCap that added the TCP.

Returns:

true if this TCP is present in PolyScope, otherwise false.