com.ur.urcap.api.domain

Interface ApplicationAPI

All Known Subinterfaces:

InstallationAPI, ProgramAPI

@ProviderType
public interface ApplicationAPI

Provides access to functionality and services which are relevant for various different applications and contexts. This includes what is available from within PolyScope, as well as creating additional model elements to be used within PolyScope.

Since:

1.3.0

Method Summary

Modifier and Type	Method and Description
<T extends DeviceManager> T	getDeviceManager(Class<T> deviceManagerClass) This method can be used to get a specific DeviceManager instance
FeatureModel	getFeatureModel()
<T extends InstallationNodeContribution> T	getInstallationNode(Class<T> installationType) This method can be used to get a specific InstallationNodeContribution instance
IOModel	getIOModel()
PayloadModel	getPayloadModel() Gets an interface which provides access the payloads in the current PolyScope installation.
ResourceModel	getResourceModel()
TCPModel	getTCPModel()
ValueFactoryProvider	getValueFactoryProvider()
VariableModel	getVariableModel()

Method Detail

getIOModel

IOModel getIOModel()

Returns:

An interface for working with the inputs and outputs of the robot

getFeatureModel

FeatureModel getFeatureModel()

Returns:

An interface for working with the features of the current installation

getTCPModel

TCPModel getTCPModel()

Returns:

An interface for accessing the TCPs of the current installation

Since:

1.5.0

getPayloadModel

PayloadModel getPayloadModel()

Gets an interface which provides access the payloads in the current PolyScope installation.

Returns:

An interface for accessing the payloads in the current PolyScope installation

Since:

1.13.0

getVariableModel

VariableModel getVariableModel()

Returns:

An interface for working with variables

getResourceModel

ResourceModel getResourceModel()

Returns:

An interface with access to various queryable-only system resources

Since:

1.7.0

getValueFactoryProvider

ValueFactoryProvider getValueFactoryProvider()

Returns:

An interface for accessing various factories capable of creating value objects.

getInstallationNode

<T extends InstallationNodeContribution> T getInstallationNode(Class<T> installationType)

This method can be used to get a specific InstallationNodeContribution instance

Type Parameters:

T - The generic for specifying the InstallationNodeContribution

Parameters:

installationType - The class of the installation node contribution to return

Returns:

The installation node instance

getDeviceManager

<T extends DeviceManager> T getDeviceManager(Class<T> deviceManagerClass)

This method can be used to get a specific DeviceManager instance

Type Parameters:

T - The generic type of class to return

Parameters:

deviceManagerClass - The class for the device manager to return

Returns:

An interface for registering and working with a specific device

Since:

1.9.0