com.kuka.roboticsAPI.concurrencyModel
Enum CyclicTaskBehavior

java.lang.Object
  java.lang.Enum<CyclicTaskBehavior>
      com.kuka.roboticsAPI.concurrencyModel.CyclicTaskBehavior

All Implemented Interfaces:

Serializable, Comparable<CyclicTaskBehavior>

public enum CyclicTaskBehavior
extends Enum<CyclicTaskBehavior>

Defines the behavior of a cyclic task if the task needed longer than the given cycle time.

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

Enum Constant Summary

BestEffortCycles
Best effort cycles try to hold the cycle time.

ExactCycles
Exact cycles run every time and do not tolerate if the called method needs longer than the given cycle time.

FixedCycles
Fixed cyclic tasks run every time a new cycle should run.

Method Summary

static CyclicTaskBehavior	valueOf(String name) Returns the enum constant of this type with the specified name.
static CyclicTaskBehavior[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

ExactCycles

public static final CyclicTaskBehavior ExactCycles

Exact cycles run every time and do not tolerate if the called method needs longer than the given cycle time.

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

BestEffortCycles

public static final CyclicTaskBehavior BestEffortCycles

Best effort cycles try to hold the cycle time. If the called method needs longer than the given cycle time, it will be called immediately after it has returned. There may not be a fixed cycle.

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

FixedCycles

public static final CyclicTaskBehavior FixedCycles

Fixed cyclic tasks run every time a new cycle should run. If the called method needs longer than the given cycle, one cycle will be omitted.

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

Method Detail

values

public static CyclicTaskBehavior[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (CyclicTaskBehavior c : CyclicTaskBehavior.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static CyclicTaskBehavior valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null