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

Interface WaitNodeConfigFactory

public interface WaitNodeConfigFactory

The WaitNodeConfigFactory can be used to construct configurations that can be set on a WaitNode.

Method Summary

Modifier and Type	Method and Description
AnalogInputCurrentWaitNodeConfig	createAnalogInputCurrentConfig(AnalogIO input, CompareOperator compareOperator, Current current, ErrorHandler<Current> errorHandler) Creates a configuration for waiting for an analog input to go past an electric current threshold.
AnalogInputVoltageWaitNodeConfig	createAnalogInputVoltageConfig(AnalogIO input, CompareOperator compareOperator, Voltage voltage, ErrorHandler<Voltage> errorHandler) Creates a configuration for waiting for an analog input to go past a voltage threshold.
DigitalInputWaitNodeConfig	createDigitalInputConfig(BooleanRegister input, boolean valueToWaitFor) Creates a configuration for waiting for a boolean register to go true or false.
DigitalInputWaitNodeConfig	createDigitalInputConfig(DigitalIO input, boolean valueToWaitFor) Creates a configuration for waiting for a digital input to go high or low.
DigitalInputWaitNodeConfig	createDigitalInputConfig(ModbusIO input, boolean valueToWaitFor) Creates a configuration for waiting for a digital MODBUS input to go high or low.
ExpressionInputWaitNodeConfig	createExpressionInputConfig(Expression expression) Create a configuration for waiting for an expression to be evaluated to true.
FloatRegisterInputWaitNodeConfig	createFloatRegisterInputConfig(FloatRegister input, CompareOperator compareOperator, float valueToWaitFor) Creates a configuration for waiting for a register to go past a float threshold.
TimeWaitNodeConfig	createTimeConfig(Time time, ErrorHandler<Time> errorHandler) Creates a configuration for waiting a specified amount of time.

Method Detail

createTimeConfig

TimeWaitNodeConfig createTimeConfig(Time time,
                                    ErrorHandler<Time> errorHandler)

Creates a configuration for waiting a specified amount of time.

Parameters:

time - the time to wait, not null.

errorHandler - handler for validation errors. If using ErrorHandler.AUTO_CORRECT this will clamp the value to the nearest valid time value.

Returns:

the configuration.

createDigitalInputConfig

DigitalInputWaitNodeConfig createDigitalInputConfig(DigitalIO input,
                                                    boolean valueToWaitFor)

Creates a configuration for waiting for a digital input to go high or low.

Parameters:

input - the digital input on which to wait, not null.

valueToWaitFor - true, if waiting for the input signal value/level to go HIGH, false otherwise (waiting for LOW signal value/level).

Returns:

the configuration.

Throws:

IllegalArgumentException - if input is an output (does not support reading of values). See IO.isInput().

createDigitalInputConfig

DigitalInputWaitNodeConfig createDigitalInputConfig(ModbusIO input,
                                                    boolean valueToWaitFor)

Creates a configuration for waiting for a digital MODBUS input to go high or low.

Parameters:

input - the digital MODBUS input on which to wait, not null.

valueToWaitFor - true, if waiting for the input signal value/level to go HIGH, false otherwise (waiting for LOW signal value/level).

Returns:

the configuration.

Throws:

IllegalArgumentException - if input is an output (does not support reading of values) or if output is not a digital output. See IO.isInput() and IO.getType().

createDigitalInputConfig

DigitalInputWaitNodeConfig createDigitalInputConfig(BooleanRegister input,
                                                    boolean valueToWaitFor)

Creates a configuration for waiting for a boolean register to go true or false.

Parameters:

input - the boolean register input on which to wait, not null.

valueToWaitFor - true, if waiting for the register to be true, false otherwise.

Returns:

the configuration.

Throws:

IllegalArgumentException - if input is an output (does not support reading of values). See IO.isInput().

createAnalogInputCurrentConfig

AnalogInputCurrentWaitNodeConfig createAnalogInputCurrentConfig(AnalogIO input,
                                                                CompareOperator compareOperator,
                                                                Current current,
                                                                ErrorHandler<Current> errorHandler)

Creates a configuration for waiting for an analog input to go past an electric current threshold.

Parameters:

input - on which to wait, not null.

compareOperator - the operator to use when comparing input to value, not null. Available options are "less than" (<) or "greater than" (>).

current - the electric current threshold to wait for, not null.

errorHandler - the error handler for validation errors. If using ErrorHandler.AUTO_CORRECT this will clamp the value to the nearest valid current value.

Returns:

the configuration.

Throws:

IllegalArgumentException - if input is an output (does not support reading of values). See IO.isInput().

createAnalogInputVoltageConfig

AnalogInputVoltageWaitNodeConfig createAnalogInputVoltageConfig(AnalogIO input,
                                                                CompareOperator compareOperator,
                                                                Voltage voltage,
                                                                ErrorHandler<Voltage> errorHandler)

Creates a configuration for waiting for an analog input to go past a voltage threshold.

Parameters:

input - on which to wait, not null.

compareOperator - the operator to use when comparing input to value, not null. Available options are "less than" (<) or "greater than" (>).

voltage - the voltage threshold to wait for, not null.

errorHandler - the error handler for validation errors. If using ErrorHandler.AUTO_CORRECT this will clamp the value to the nearest valid voltage value.

Returns:

the configuration.

Throws:

IllegalArgumentException - if input is an output (does not support reading of values). See IO.isInput().

createFloatRegisterInputConfig

FloatRegisterInputWaitNodeConfig createFloatRegisterInputConfig(FloatRegister input,
                                                                CompareOperator compareOperator,
                                                                float valueToWaitFor)

Creates a configuration for waiting for a register to go past a float threshold.

Parameters:

input - the float register input on which to wait, not null.

compareOperator - the operator to use when comparing register to value, not null. Available options are "less than" (<) or "greater than" (>).

valueToWaitFor - the float threshold to wait for.

Returns:

the configuration.

Throws:

IllegalArgumentException - if input is an output (does not support reading of values). See IO.isInput().

createExpressionInputConfig

ExpressionInputWaitNodeConfig createExpressionInputConfig(Expression expression)

Create a configuration for waiting for an expression to be evaluated to true.

Parameters:

expression - the expression to evaluate, not null.

Returns:

the configuration.