URCapAPI (api 1.13.0 API)

```
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).

Since:

1.0.0

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method and Description
`FeatureModel`	`getFeatures()` Deprecated. Use `InstallationAPI` or `ProgramAPI` instead accessible through their respective providers, i.e. `getInstallationAPIProvider()` or `getProgramAPIProvider()`.
`FunctionModel`	`getFunctionModel()` Deprecated. Use `InstallationAPI` instead accessible through its provider, `getInstallationAPIProvider()`.
`InstallationAPIProvider`	`getInstallationAPIProvider()`
`<T extends InstallationNodeContribution> T`	`getInstallationNode(Class<T> installationType)` Deprecated. Use `InstallationAPI` or `ProgramAPI` instead accessible through their respective providers.
`IOModel`	`getIOs()` Deprecated. Use `InstallationAPI` or `ProgramAPI` instead accessible through their respective providers, i.e. `getInstallationAPIProvider()` or `getProgramAPIProvider()`.
`ProgramAPIProvider`	`getProgramAPIProvider()`
`ProgramModel`	`getProgramModel()` Deprecated. Use `ProgramAPI` instead accessible through its provider, `getProgramAPIProvider()`.
`RobotModel`	`getRobotModel()` Deprecated. Use `SystemAPI` instead accessible through both `getInstallationAPIProvider()` and `getProgramAPIProvider()`.
`SoftwareVersion`	`getSoftwareVersion()` Deprecated. Use `SystemAPI` instead accessible through both `getInstallationAPIProvider()` and `getProgramAPIProvider()`.
`SystemSettings`	`getSystemSettings()` Deprecated. Use `SystemAPI` instead accessible through both `getInstallationAPIProvider()` and `getProgramAPIProvider()`.
`UserInteraction`	`getUserInteraction()` Deprecated. Use `UserInterfaceAPI` instead accessible through both `getInstallationAPIProvider()` and `getProgramAPIProvider()`.
`ValueFactoryProvider`	`getValueFactoryProvider()` Deprecated. Use `InstallationAPI` or `ProgramAPI` instead accessible through their respective providers, i.e. `getInstallationAPIProvider()` or `getProgramAPIProvider()`.
`VariableModel`	`getVariableModel()` Deprecated. Use `InstallationAPI` or `ProgramAPI` instead 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.
    
    Since:
    
    1.5.0
  - getProgramAPIProvider
```
ProgramAPIProvider getProgramAPIProvider()
```
    Returns:
    
    The program api provider gives access to interfaces relevant for contributed program nodes.
    
    Since:
    
    1.5.0
  - getSoftwareVersion
```
@Deprecated
SoftwareVersion getSoftwareVersion()
```
    Deprecated. Use SystemAPI instead accessible through both getInstallationAPIProvider() and getProgramAPIProvider().
    
    Returns:
    
    an interface for obtaining version information about PolyScope.
  - getSystemSettings
```
@Deprecated
SystemSettings getSystemSettings()
```
    Deprecated. Use SystemAPI instead accessible through both getInstallationAPIProvider() and getProgramAPIProvider().
    
    Returns:
    
    an interface for obtaining system settings (e.g. locale) for PolyScope.
    
    Since:
    
    1.2.56
  - getRobotModel
```
@Deprecated
RobotModel getRobotModel()
```
    Deprecated. Use SystemAPI instead accessible through both getInstallationAPIProvider() and getProgramAPIProvider().
    
    Returns:
    
    An interface providing information about the robot.
  - getIOs
```
@Deprecated
IOModel getIOs()
```
    Deprecated. Use InstallationAPI or ProgramAPI instead accessible through their respective providers, i.e. getInstallationAPIProvider() or getProgramAPIProvider().
    
    Returns:
    
    An interface for working with the inputs and outputs of the robot.
  - getFeatures
```
@Deprecated
FeatureModel getFeatures()
```
    Deprecated. Use InstallationAPI or ProgramAPI instead accessible through their respective providers, i.e. getInstallationAPIProvider() or getProgramAPIProvider().
    
    Returns:
    
    An interface for working with the features of the current installation.
  - getFunctionModel
```
@Deprecated
FunctionModel getFunctionModel()
```
    Deprecated. Use InstallationAPI instead accessible through its provider, getInstallationAPIProvider().
    
    Returns:
    
    An interface for adding script functions to PolyScope.
    
    Since:
    
    1.1.0
  - getProgramModel
```
@Deprecated
ProgramModel getProgramModel()
```
    Deprecated. Use ProgramAPI instead accessible through its provider, getProgramAPIProvider().
    
    Returns:
    
    An interface for working with the sub-trees of a program node.
    
    Since:
    
    1.1.0
  - getVariableModel
```
@Deprecated
VariableModel getVariableModel()
```
    Deprecated. Use InstallationAPI or ProgramAPI instead accessible through their respective providers, i.e. getInstallationAPIProvider() or getProgramAPIProvider().
    
    Returns:
    
    An interface for working with variables.
    
    Since:
    
    1.2.56
  - getValueFactoryProvider
```
@Deprecated
ValueFactoryProvider getValueFactoryProvider()
```
    Deprecated. Use InstallationAPI or ProgramAPI instead accessible through their respective providers, i.e. getInstallationAPIProvider() or getProgramAPIProvider().
    
    Returns:
    
    An interface for accessing various factories capable of creating value objects.
    
    Since:
    
    1.2.56
  - getUserInteraction
```
@Deprecated
UserInteraction getUserInteraction()
```
    Deprecated. Use UserInterfaceAPI instead accessible through both getInstallationAPIProvider() and getProgramAPIProvider().
    
    Returns:
    
    an interface for various ways of interacting with the end user.
    
    Since:
    
    1.2.56
  - getInstallationNode
```
@Deprecated
<T extends InstallationNodeContribution> T getInstallationNode(Class<T> installationType)
```
    Deprecated. Use InstallationAPI or ProgramAPI instead 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.

Interface URCapAPI

Method Summary

Method Detail

getInstallationAPIProvider

getProgramAPIProvider

getSoftwareVersion

getSystemSettings

getRobotModel

getIOs

getFeatures

getFunctionModel

getProgramModel

getVariableModel

getValueFactoryProvider

getUserInteraction

getInstallationNode