com.kuka.roboticsAPI.controllerModel.sunrise.api
Class SunriseStopCondition

java.lang.Object
  com.kuka.roboticsAPI.controllerModel.sunrise.api.SunriseStopCondition

All Implemented Interfaces:

com.kuka.common.IDataEquatable

Direct Known Subclasses:

ExpressionStopCondition, XmlStopCondition

public class SunriseStopCondition
extends Object
implements com.kuka.common.IDataEquatable

A StopCondition in a SPR tells Sunrise when the given SPR will go into maintaining. If a StopCondition get's true, it's hasFired method returns true.

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.

Constructor Summary

SunriseStopCondition()
Creates a new instance.

SunriseStopCondition(String condition)
Creates a new stop condition.

Method Summary

String	getCondition() Gets the condition (the expression) of the stop condition.
String	getErrorMessage() Gets the optional error message provided by the user when he declared the stop condition as an error stop condition.
ICondition	getUserDefinedStopCondition() Gets the original user defined (non Sunrise) stop condition for the stop condition.
boolean	hasFired() Gets the hasFired property.
boolean	hasSameDataAs(Object obj)
boolean	isErrorStopCondition() Gets the flag indicating if this stop condition is an error stop condition.
boolean	isStop1StopCondition() Gets the flag indicating if this stop condition allows resume of execution.
void	markAsErrorStopCondition() Marks this stop condition as an error stop condition.
void	markAsErrorStopCondition(String errorMessage) Marks this stop condition as an error stop condition.
void	markAsStop1StopCondition() Marks this stop condition as a stop condition which allows resume of execution.
void	resetFired() Marks the stop condition as not fired.
void	setConditionExpression(String condition) Sets the stop condition expression.
void	setFired() Marks the stop condition as fired.
void	setUserDefinedStopCondition(ICondition condition) Sets the original user defined (non Sunrise) stop condition for the stop condition.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

SunriseStopCondition

public SunriseStopCondition()

Creates a new instance.

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.

SunriseStopCondition

public SunriseStopCondition(String condition)

Creates a new stop condition.

Parameters:

condition - The expression of the stop condition.

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 Detail

isErrorStopCondition

public boolean isErrorStopCondition()

Gets the flag indicating if this stop condition is an error stop condition.

Returns:

The flag indicating if this stop condition is an error stop condition.

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.

markAsErrorStopCondition

public void markAsErrorStopCondition()

Marks this stop condition as an error stop condition.

The SunriseController will mark a command with the stop condition as invalid if the stop condition fires.

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.

markAsStop1StopCondition

public void markAsStop1StopCondition()

Marks this stop condition as a stop condition which allows resume of execution.

The SunriseController will mark a command with the stop condition as canceled if the stop condition fires.

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.

isStop1StopCondition

public boolean isStop1StopCondition()

Gets the flag indicating if this stop condition allows resume of execution.

Returns:

flag-value

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.

getErrorMessage

public String getErrorMessage()

Gets the optional error message provided by the user when he declared the stop condition as an error stop condition. May return null.

Returns:

The optional error message provided by the user when he declared the stop condition as an error stop condition. May return null.

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.

markAsErrorStopCondition

public void markAsErrorStopCondition(String errorMessage)

Marks this stop condition as an error stop condition.

The SunriseController will mark a command with the stop condition as invalid if the stop condition fires.

Parameters:

errorMessage - The optional error message which should be inserted by the SunriseController. May be null.

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.

getCondition

public String getCondition()

Gets the condition (the expression) of the stop condition.

Returns:

The stop condition expression.

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.

setConditionExpression

public void setConditionExpression(String condition)

Sets the stop condition expression.

Parameters:

condition - the stop condition expression.

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.

toString

public String toString()

Overrides:

toString in class Object

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.

setFired

public void setFired()

Marks the stop condition as fired.

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.

resetFired

public void resetFired()

Marks the stop condition as not fired.

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.

hasFired

public boolean hasFired()

Gets the hasFired property.

Returns:

True if the stop condition has fired, false otherwise.

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.

setUserDefinedStopCondition

public void setUserDefinedStopCondition(ICondition condition)

Sets the original user defined (non Sunrise) stop condition for the stop condition.

Parameters:

condition - The original user defined (non Sunrise) stop condition for the stop condition.

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.

getUserDefinedStopCondition

public ICondition getUserDefinedStopCondition()

Gets the original user defined (non Sunrise) stop condition for the stop condition.

Returns:

The original user defined (non Sunrise) stop condition for the stop condition.

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.

hasSameDataAs

public boolean hasSameDataAs(Object obj)

Specified by:

hasSameDataAs in interface com.kuka.common.IDataEquatable

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.