com.kuka.roboticsAPI.applicationModel
Interface IApplicationOverrideControl

All Known Subinterfaces:

IApplicationControl

All Known Implementing Classes:

RoboticsAPIApplicationControl, RoboticsAPIOverrideControl

public interface IApplicationOverrideControl

Interface for application override control. This interface contains methods for control of the application override.

This element is not in its final state and might change 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.
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.

Method Detail

getManualOverride

double getManualOverride()

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

Returns:

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

clipManualOverride

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.

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

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.

Returns:

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

setApplicationOverride

void setApplicationOverride(double override)

Sets the application override to the specified value.

Parameters:

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

clipApplicationOverride

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.

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

double getEffectiveOverride()

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

Returns:

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

addOverrideListener

void addOverrideListener(IApplicationOverrideListener listener)

Adds a listener for the changes of the application override.

Parameters:

listener - the listener

removeOverrideListener

void removeOverrideListener(IApplicationOverrideListener listener)

Remove an application override listener.

Parameters:

listener - the listener