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

Interface AnalogInputUntilNodeConfig

All Superinterfaces:

IOInputUntilNodeConfig, UntilNodeConfig

public interface AnalogInputUntilNodeConfig
extends IOInputUntilNodeConfig

Since:

1.7.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	AnalogInputUntilNodeConfig.InputDomainType The type of the electrical domain used by an analog input.

Nested classes/interfaces inherited from interface com.ur.urcap.api.domain.program.nodes.builtin.configurations.untilnode.IOInputUntilNodeConfig

IOInputUntilNodeConfig.SelectionType

Nested classes/interfaces inherited from interface com.ur.urcap.api.domain.program.nodes.builtin.configurations.untilnode.UntilNodeConfig

UntilNodeConfig.ConfigType

Method Summary

Modifier and Type	Method and Description
CompareOperator	getCompareOperator()
Current	getCurrentThreshold()
AnalogIO	getInput() Retrieves the selected analog input used by the until condition.
AnalogInputUntilNodeConfig.InputDomainType	getInputDomainType()
Voltage	getVoltageThreshold()

Methods inherited from interface com.ur.urcap.api.domain.program.nodes.builtin.configurations.untilnode.IOInputUntilNodeConfig

getType

Methods inherited from interface com.ur.urcap.api.domain.program.nodes.builtin.configurations.untilnode.UntilNodeConfig

getConfigType

Method Detail

getInputDomainType

AnalogInputUntilNodeConfig.InputDomainType getInputDomainType()

Returns:

the electrical domain type for the analog input used by the Until node. This can change depending on what the end user has selected in PolyScope.

getInput

AnalogIO getInput()

Retrieves the selected analog input used by the until condition.

Note: The selected analog input might no longer be available (e.g. because a selected analog Tool input is used for Tool Communication Interface). The presence of the selected analog input can be verified using AnalogIO.isResolvable().

Returns:

the selected analog input

getCompareOperator

CompareOperator getCompareOperator()

Returns:

the operator used when comparing the signal value/level of the selected analog input to the threshold value.

getCurrentThreshold

Current getCurrentThreshold()

Returns:

the electric Current threshold value used by the until condition. Execution will proceed until the signal value of the selected analog input goes past this threshold.

Throws:

IllegalStateException - if the selected analog input is using the Voltage electrical domain. Use getInputDomainType() to determine the electrical domain type used by the selected analog input.

getVoltageThreshold

Voltage getVoltageThreshold()

Returns:

the electric Voltage threshold value used by the until condition. Execution will proceed until the signal value of the selected analog input goes past this threshold.

Throws:

IllegalStateException - if the selected analog input is using the Current electrical domain. Use getInputDomainType() to determine the electrical domain type used by the selected analog input.