com.ur.urcap.api.domain

Interface URCapAPI

public interface URCapAPI

Provides access to functionality available from within PolyScope, as well as creating additional model elements to be used within PolyScope.

NOTE: This interface is only relevant for URCap program and installation nodes with a HTML-based user interface (see InstallationNodeService and ProgramNodeService)

Method Summary

Modifier and Type	Method and Description
FeatureModel	getFeatures() Deprecated. Use InstallationAPI or ProgramAPI accessible through their respective providers, i.e. getInstallationAPIProvider() or getProgramAPIProvider().
FunctionModel	getFunctionModel() Deprecated. Use InstallationAPI accessible through its provider, getInstallationAPIProvider().
InstallationAPIProvider	getInstallationAPIProvider()
<T extends InstallationNodeContribution> T	getInstallationNode(Class<T> installationType) Deprecated. Use InstallationAPI or ProgramAPI accessible through their respective providers. This method can be used to get a specific InstallationNodeContribution instance
IOModel	getIOs() Deprecated. Use InstallationAPI or ProgramAPI accessible through their respective providers, i.e. getInstallationAPIProvider() or getProgramAPIProvider().
ProgramAPIProvider	getProgramAPIProvider()
ProgramModel	getProgramModel() Deprecated. Use ProgramAPI accessible through its provider, getProgramAPIProvider().
RobotModel	getRobotModel() Deprecated. Use SystemAPI accessible through both getInstallationAPIProvider() and getProgramAPIProvider()
SoftwareVersion	getSoftwareVersion() Deprecated. Use SystemAPI accessible through both getInstallationAPIProvider() and getProgramAPIProvider()
SystemSettings	getSystemSettings() Deprecated. Use SystemAPI accessible through both getInstallationAPIProvider() and getProgramAPIProvider()
UserInteraction	getUserInteraction() Deprecated. Use UserInterfaceAPI accessible through both getInstallationAPIProvider() and getProgramAPIProvider()
ValueFactoryProvider	getValueFactoryProvider() Deprecated. Use InstallationAPI or ProgramAPI accessible through their respective providers, i.e. getInstallationAPIProvider() or getProgramAPIProvider().
VariableModel	getVariableModel() Deprecated. Use InstallationAPI or ProgramAPI accessible through their respective providers, i.e. getInstallationAPIProvider() or getProgramAPIProvider().

Method Detail

getInstallationAPIProvider

InstallationAPIProvider getInstallationAPIProvider()

Returns:

The installation api provider gives access to interfaces relevant for contributed installation nodes.

getProgramAPIProvider

ProgramAPIProvider getProgramAPIProvider()

Returns:

The program api provider gives access to interfaces relevant for contributed program nodes.

getSoftwareVersion

SoftwareVersion getSoftwareVersion()

Deprecated. Use SystemAPI accessible through both getInstallationAPIProvider() and getProgramAPIProvider()

Returns:

an interface for obtaining version information about PolyScope

getSystemSettings

SystemSettings getSystemSettings()

Deprecated. Use SystemAPI accessible through both getInstallationAPIProvider() and getProgramAPIProvider()

Returns:

an interface for obtaining system settings (e.g. locale) for PolyScope

getRobotModel

RobotModel getRobotModel()

Deprecated. Use SystemAPI accessible through both getInstallationAPIProvider() and getProgramAPIProvider()

Returns:

An interface providing information about the robot

getIOs

IOModel getIOs()

Deprecated. Use InstallationAPI or ProgramAPI accessible through their respective providers, i.e. getInstallationAPIProvider() or getProgramAPIProvider().

Returns:

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

getFeatures

FeatureModel getFeatures()

Deprecated. Use InstallationAPI or ProgramAPI accessible through their respective providers, i.e. getInstallationAPIProvider() or getProgramAPIProvider().

Returns:

An interface for working with the features of the current installation

getFunctionModel

FunctionModel getFunctionModel()

Deprecated. Use InstallationAPI accessible through its provider, getInstallationAPIProvider().

Returns:

An interface for adding script functions to PolyScope

getProgramModel

ProgramModel getProgramModel()

Deprecated. Use ProgramAPI accessible through its provider, getProgramAPIProvider().

Returns:

An interface for working with the sub-trees of a program node

getVariableModel

VariableModel getVariableModel()

Deprecated. Use InstallationAPI or ProgramAPI accessible through their respective providers, i.e. getInstallationAPIProvider() or getProgramAPIProvider().

Returns:

An interface for working with variables

getValueFactoryProvider

ValueFactoryProvider getValueFactoryProvider()

Deprecated. Use InstallationAPI or ProgramAPI accessible through their respective providers, i.e. getInstallationAPIProvider() or getProgramAPIProvider().

Returns:

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

getUserInteraction

UserInteraction getUserInteraction()

Deprecated. Use UserInterfaceAPI accessible through both getInstallationAPIProvider() and getProgramAPIProvider()

Returns:

an interface for various ways of interacting with the user

getInstallationNode

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

Deprecated. Use InstallationAPI or ProgramAPI accessible through their respective providers. 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