com.kuka.roboticsAPI.concurrencyModel
Class CyclicTasks

java.lang.Object
  com.kuka.roboticsAPI.concurrencyModel.CyclicTasks

public final class CyclicTasks
extends Object

This class starts cyclic tasks.

CyclicTasks run in a defined cycle and can have different behaviors which define what should happen if the cycle was violated.

If a task fails, the cyclic scheduling will stop.

This element is not in its final state and might change in future versions.

Method Summary

static ICyclicTaskContainer	doCyclic(int cycleTimeMillis, CyclicTask... tasks) Starts a cyclic thread for the given tasks.
static ICyclicTaskContainer	doCyclic(int cycleTimeMillis, CyclicTaskBehavior behavior, CyclicTask... tasks) Starts a cyclic thread for the given tasks.
static ICyclicTaskContainer	doCyclic(int cycleTimeMillis, int priority, CyclicTaskBehavior behavior, CyclicTask... tasks) Starts a cyclic thread for the given tasks.

Methods inherited from class java.lang.Object

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

Method Detail

doCyclic

public static ICyclicTaskContainer doCyclic(int cycleTimeMillis,
                                            int priority,
                                            CyclicTaskBehavior behavior,
                                            CyclicTask... tasks)

Starts a cyclic thread for the given tasks. All tasks will be executed in the given order. If a task is already executing, the method will fail.

Parameters:

cycleTimeMillis - The cycle millis.

priority - The priority of the tasks.

behavior - The behavior if the tasks do not succeed within the given cycle.

tasks - The tasks to execute.

Returns:

The ICyclicTaskGroup which contains all given cyclic tasks. The group can be used to cancel the tasks.

This element is not in its final state and might change in future versions.

doCyclic

public static ICyclicTaskContainer doCyclic(int cycleTimeMillis,
                                            CyclicTask... tasks)

Starts a cyclic thread for the given tasks. All tasks will be executed in the given order. If a task is already executing, the method will fail.

Parameters:

cycleTimeMillis - The cycle millis.

tasks - The tasks to execute.

Returns:

The ICyclicTaskContainer which contains all given cyclic tasks. The group can be used to cancel the tasks.

This element is not in its final state and might change in future versions.

doCyclic

public static ICyclicTaskContainer doCyclic(int cycleTimeMillis,
                                            CyclicTaskBehavior behavior,
                                            CyclicTask... tasks)

Starts a cyclic thread for the given tasks. All tasks will be executed in the given order. If a task is already executing, the method will fail.

Parameters:

cycleTimeMillis - The cycle millis.

behavior - The behavior is the tasks do not succeed within the given cycle.

tasks - The tasks to execute.

Returns:

The ICyclicTaskContainer which contains all given cyclic tasks. The container can be used to cancel all tasks at once.

This element is not in its final state and might change in future versions.