com.ur.urcap.api.domain.program.nodes.builtin.configurations.loopnode

Interface LoopNodeConfigFactory

public interface LoopNodeConfigFactory

This interface can be used to construct configurations that can be set on a Loop program node.

Since:

1.2.56

Method Summary

Modifier and Type	Method and Description
AlwaysLoopNodeConfig	createAlwaysConfig() Creates a loop always (infinitely) configuration.
CounterLoopNodeConfig	createCounterConfig(int loopCount, ErrorHandler<Integer> errorHandler) Creates a loop counter configuration.
ExpressionLoopNodeConfig	createExpressionConfig(Expression expression, boolean evaluateContinuously) Create a loop expression configuration.

Method Detail

createAlwaysConfig

AlwaysLoopNodeConfig createAlwaysConfig()

Creates a loop always (infinitely) configuration.

Returns:

the configuration.

createCounterConfig

CounterLoopNodeConfig createCounterConfig(int loopCount,
                                          ErrorHandler<Integer> errorHandler)

Creates a loop counter configuration.

Parameters:

loopCount - the number of iterations through the loop node.

errorHandler - error handler for handling validation. If using ErrorHandler.AUTO_CORRECT this will clamp the value to the nearest valid loop count value.

Returns:

the configuration.

createExpressionConfig

ExpressionLoopNodeConfig createExpressionConfig(Expression expression,
                                                boolean evaluateContinuously)

Create a loop expression configuration.

Parameters:

expression - the expression whose evaluation must be true to continue looping, not null.

evaluateContinuously - if true the expression will be evaluated continuously during the looping (i.e. the loop can be interrupted anytime during its execution), otherwise false and the expression will be evaluated once per loop iteration.

Returns:

the configuration.