com.kuka.roboticsAPI.applicationModel
Class RoboticsAPIOverrideControl

java.lang.Object
  com.kuka.roboticsAPI.applicationModel.RoboticsAPIOverrideControl

All Implemented Interfaces:

IApplicationOverrideControl

public final class RoboticsAPIOverrideControl
extends Object
implements IApplicationOverrideControl

Class to get control robotics API overrides.

This element is an undocumented internal feature. It is not intended to be used by applications as it might change or be removed in future versions.

Method Summary

void	addOverrideListener(IApplicationOverrideListener listener) Adds a listener for the changes of the application override.
void	clipApplicationOverride(double override) Sets the application override to the specified value, but only if it is equal to or smaller than the current application override.
void	clipManualOverride(double override) Sets the manual override to the specified value, but only if it is equal to or smaller than the current manual override.
static RoboticsAPIOverrideControl	create(RoboticsAPIContext context) Creates a new RoboticsAPIApplicationControl.
void	dispose() Dispose.
double	getApplicationOverride() Returns the application override.
double	getEffectiveOverride() Returns the effective override of the application.
double	getManualOverride() Returns the manual override of the application.
void	removeOverrideListener(IApplicationOverrideListener listener) Remove an application override listener.
void	setApplicationOverride(double override) Sets the application override to the specified value.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

dispose

public void dispose()

Dispose.

getManualOverride

public double getManualOverride()

Returns the manual override of the application. This is the override, that can be changed by the user in the HMI.

Specified by:

getManualOverride in interface IApplicationOverrideControl

Returns:

the manual override (0.0 <= override <= 1.0)

clipManualOverride

public void clipManualOverride(double override)

Sets the manual override to the specified value, but only if it is equal to or smaller than the current manual override. If it is greater than the current manual override, the current manual override remains unchanged.

Specified by:

clipManualOverride in interface IApplicationOverrideControl

Parameters:

override - Manual override will be set to this value [0:1], but only if it is equal to or smaller than the current manual override.

getApplicationOverride

public double getApplicationOverride()

Returns the application override. This is the override, that can be set by the application developer within the application. The application override multiplied by the manual override yields the effective override of the application.

Specified by:

getApplicationOverride in interface IApplicationOverrideControl

Returns:

the application override (0.0 <= override <= 1.0)

setApplicationOverride

public void setApplicationOverride(double override)

Sets the application override to the specified value.

Specified by:

setApplicationOverride in interface IApplicationOverrideControl

Parameters:

override - Application override will be set to this value [0:1].

clipApplicationOverride

public void clipApplicationOverride(double override)

Sets the application override to the specified value, but only if it is equal to or smaller than the current application override. If it is greater than the current application override, the current application override remains unchanged.

Specified by:

clipApplicationOverride in interface IApplicationOverrideControl

Parameters:

override - Application override will be set to this value [0:1], but only if it is equal to or smaller than the current application override.

getEffectiveOverride

public double getEffectiveOverride()

Returns the effective override of the application. Effective Override = Application Override * Manual Override

Specified by:

getEffectiveOverride in interface IApplicationOverrideControl

Returns:

the effective override (0.0 <= override <= 1.0)

addOverrideListener

public void addOverrideListener(IApplicationOverrideListener listener)

Adds a listener for the changes of the application override.

Specified by:

addOverrideListener in interface IApplicationOverrideControl

Parameters:

listener - the listener

removeOverrideListener

public void removeOverrideListener(IApplicationOverrideListener listener)

Remove an application override listener.

Specified by:

removeOverrideListener in interface IApplicationOverrideControl

Parameters:

listener - the listener

create

public static RoboticsAPIOverrideControl create(RoboticsAPIContext context)

Creates a new RoboticsAPIApplicationControl.

Parameters:

context - The context for this application control. null is not allowed.

Returns:

the RoboticsAPIApplicationControl.