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

Interface SetNodeConfigFactory

public interface SetNodeConfigFactory

This interface can be used to construct configurations that can be set on a SetNode.

Method Summary

Modifier and Type	Method and Description
AnalogOutputCurrentSetNodeConfig	createAnalogOutputCurrentConfig(AnalogIO output, Current current, ErrorHandler<Current> errorHandler) Creates an analog output current configuration.
AnalogOutputVoltageSetNodeConfig	createAnalogOutputVoltageConfig(AnalogIO output, Voltage voltage, ErrorHandler<Voltage> errorHandler) Creates an analog output voltage configuration.
DigitalOutputSetNodeConfig	createDigitalOutputConfig(BooleanRegister output, boolean valueToSet) Creates a digital output configuration.
DigitalOutputSetNodeConfig	createDigitalOutputConfig(DigitalIO output, boolean valueToSet) Creates a digital output configuration.
DigitalOutputSetNodeConfig	createDigitalOutputConfig(ModbusIO output, boolean valueToSet) Creates a digital MODBUS output configuration.
ExpressionOutputSetNodeConfig	createExpressionOutputConfig(IO output, Expression expression) Create an expression output configuration.
FloatRegisterOutputSetNodeConfig	createFloatRegisterOutputConfig(FloatRegister output, float valueToSet) Create a float register output configuration.
SingleDigitalPulseSetNodeConfig	createSingleDigitalPulseConfig(BooleanRegister output, Time pulseTime, ErrorHandler<Time> errorHandler) Creates a single digital pulse configuration.
SingleDigitalPulseSetNodeConfig	createSingleDigitalPulseConfig(DigitalIO output, Time pulseTime, ErrorHandler<Time> errorHandler) Creates a single digital pulse configuration.
SingleDigitalPulseSetNodeConfig	createSingleDigitalPulseConfig(ModbusIO output, Time pulseTime, ErrorHandler<Time> errorHandler) Creates a single digital pulse MODBUS configuration.

Method Detail

createDigitalOutputConfig

DigitalOutputSetNodeConfig createDigitalOutputConfig(DigitalIO output,
                                                     boolean valueToSet)

Creates a digital output configuration.

Parameters:

output - the digital output to apply the output action to, not null.

valueToSet - if true the output will be set to HIGH, otherwise LOW.

Returns:

the configuration.

Throws:

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

createDigitalOutputConfig

DigitalOutputSetNodeConfig createDigitalOutputConfig(ModbusIO output,
                                                     boolean valueToSet)

Creates a digital MODBUS output configuration.

Parameters:

output - the digital MODBUS output to apply the output action to, not null.

valueToSet - if true the MODBUS output will be set to HIGH, otherwise LOW.

Returns:

the configuration.

Throws:

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

createDigitalOutputConfig

DigitalOutputSetNodeConfig createDigitalOutputConfig(BooleanRegister output,
                                                     boolean valueToSet)

Creates a digital output configuration.

Parameters:

output - the the boolean register output to apply the output action to, not null.

valueToSet - the value to apply to the output register.

Returns:

the configuration.

Throws:

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

createAnalogOutputCurrentConfig

AnalogOutputCurrentSetNodeConfig createAnalogOutputCurrentConfig(AnalogIO output,
                                                                 Current current,
                                                                 ErrorHandler<Current> errorHandler)

Creates an analog output current configuration.

Parameters:

output - the analog output to apply the output action to. The output should be configured to use electric current domain, not null.

current - the electric current value/level to set, not null.

errorHandler - error handler for handling validation or domain (i.e. current or voltage) errors. If using ErrorHandler.AUTO_CORRECT this will clamp the value, and in case of domain error, set the value regardless of the output's domain type.

Returns:

the configuration.

Throws:

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

createAnalogOutputVoltageConfig

AnalogOutputVoltageSetNodeConfig createAnalogOutputVoltageConfig(AnalogIO output,
                                                                 Voltage voltage,
                                                                 ErrorHandler<Voltage> errorHandler)

Creates an analog output voltage configuration.

Parameters:

output - the analog output to apply the output action to. The output should be configured to use voltage domain, not null.

voltage - the voltage value/level to set, not null.

errorHandler - error handler for handling validation or domain (i.e. current or voltage) errors. If using ErrorHandler.AUTO_CORRECT this will clamp the value, and in case of domain error, set the value regardless of the output's domain type.

Returns:

the configuration.

Throws:

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

createFloatRegisterOutputConfig

FloatRegisterOutputSetNodeConfig createFloatRegisterOutputConfig(FloatRegister output,
                                                                 float valueToSet)

Create a float register output configuration.

Parameters:

output - the register to apply the value to, not null.

valueToSet - the value to be set.

Returns:

the configuration.

Throws:

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

createExpressionOutputConfig

ExpressionOutputSetNodeConfig createExpressionOutputConfig(IO output,
                                                           Expression expression)

Create an expression output configuration.

Parameters:

output - the output to set to the result of the evaluation of the expression, not null.

expression - the expression whose evaluation will be set on the output, not null.

Returns:

the configuration.

Throws:

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

createSingleDigitalPulseConfig

SingleDigitalPulseSetNodeConfig createSingleDigitalPulseConfig(DigitalIO output,
                                                               Time pulseTime,
                                                               ErrorHandler<Time> errorHandler)

Creates a single digital pulse configuration.

Parameters:

output - the digital output to apply the output action to, not null.

pulseTime - the time to pulse the pin for.

errorHandler - error handler for handling validation errors. If using ErrorHandler.AUTO_CORRECT this will default the value to 0.5 seconds.

Returns:

the configuration.

Throws:

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

createSingleDigitalPulseConfig

SingleDigitalPulseSetNodeConfig createSingleDigitalPulseConfig(ModbusIO output,
                                                               Time pulseTime,
                                                               ErrorHandler<Time> errorHandler)

Creates a single digital pulse MODBUS configuration.

Parameters:

output - the digital MODBUS output to apply the output action to, not null.

pulseTime - the time to pulse the pin for.

errorHandler - error handler for handling validation errors. If using ErrorHandler.AUTO_CORRECT this will default the value to 0.5 seconds.

Returns:

the configuration.

Throws:

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

createSingleDigitalPulseConfig

SingleDigitalPulseSetNodeConfig createSingleDigitalPulseConfig(BooleanRegister output,
                                                               Time pulseTime,
                                                               ErrorHandler<Time> errorHandler)

Creates a single digital pulse configuration.

Parameters:

output - the the boolean register output to apply the output action to, not null.

pulseTime - the time to pulse the pin for.

errorHandler - error handler for handling validation errors. If using ErrorHandler.AUTO_CORRECT this will default the value to 0.5 seconds.

Returns:

the configuration.

Throws:

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