com.kuka.roboticsAPI.applicationModel.tasks
Enum CycleBehavior

java.lang.Object
  java.lang.Enum<CycleBehavior>
      com.kuka.roboticsAPI.applicationModel.tasks.CycleBehavior

All Implemented Interfaces:

Serializable, Comparable<CycleBehavior>

public enum CycleBehavior
extends Enum<CycleBehavior>

Defines the behavior of a cyclic task if the execution of a cyclic method takes longer than the specified period of time.

Enum Constant Summary

BestEffort
Tries to hold the period time.

Strict
Does not tolerate if the execution of a called method takes longer than the given period time.

Method Summary

static CycleBehavior	valueOf(String name) Returns the enum constant of this type with the specified name.
static CycleBehavior[]	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

Strict

public static final CycleBehavior Strict

Does not tolerate if the execution of a called method takes longer than the given period time. If the given time is exceeded a CycleExceededException is thrown and the cyclic task is terminated.

BestEffort

public static final CycleBehavior BestEffort

Tries to hold the period time. If the RoboticsAPICyclicBackgroundTask.runCyclic() takes longer than that time, the next call will take place immediately after the previous has returned.

Method Detail

values

public static CycleBehavior[] 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 (CycleBehavior c : CycleBehavior.values())
    System.out.println(c);

Returns:

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

valueOf

public static CycleBehavior 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