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

Interface UntilNode

All Superinterfaces:

ProgramNode

public interface UntilNode
extends ProgramNode

The Until node is a type of program node that must be under a Waypoint node or Direction node.

It has special behavior when calling TreeNode.addChild(ProgramNode) and TreeNode.removeChild(TreeNode). Until nodes by default are leaf nodes, however they can have actions added to them. When that happens they are transformed into branch nodes that allow child nodes. When the last child is removed they become leaf nodes again. This is all automatically handled when TreeNode.addChild(ProgramNode) and TreeNode.removeChild(TreeNode) are called.

Method Summary

Modifier and Type	Method and Description
UntilNodeConfig	getConfig()
UntilNodeConfigFactory	getConfigFactory()
UntilNode	setConfig(UntilNodeConfig config) Set a configuration on this node.

Method Detail

getConfigFactory

UntilNodeConfigFactory getConfigFactory()

Returns:

This method returns a factory for creating various configurations for this type of node.

setConfig

UntilNode setConfig(UntilNodeConfig config)

Set a configuration on this node.

Parameters:

config - the configuration to be set.

Returns:

this node.

Throws:

IllegalArgumentException - If the Until node is placed under an invalid parent node e.g. trying to added a Until Distance node under a Waypoint node instead of a Direction node.

InvalidDomainException - if applying an I/O Input configuration with a Voltage threshold value when the selected analog input is using the Current electrical domain or vice versa.

IllegalStateException - if called from a Swing-based URCap outside of an UndoableChanges scope (see also UndoRedoManager).

getConfig

UntilNodeConfig getConfig()

Returns:

the current configuration for this node.