Extends

• ArchBaseActionWithOutputLoop

Members

static, readonly displayTypeName :string

Returns the display type name string 'ArchActionLoopUntil'.

readonly currentIndex :ArchValueInteger

A value that contains the variable that holds the current loop index.

readonly isArchActionLoopUntil :boolean

Returns true indicating that this is an ArchActionLoopUntil instance.

readonly maxLoopCount :ArchValueInteger

The number of times this loop action should loop.

readonly outputLoop :ArchActionOutput

The loop output for this action where actions to be performed during the loop iteration should be added.

Inherited From:

• ArchBaseActionWithOutputLoop#outputLoop

readonly untilCases :Array.<ArchNamedValue>

Returns the Until Cases configured on this loop until action as a JavaScript array of ArchNamedValue instances. The ArchNamedValue#name property on items in the returned list are the Until Case names. The ArchNamedValue#value property on items in the returned list are the ArchValueBoolean Until Case conditions which determine if the loop until action should exit. To add an Until Case to this action, call the ArchActionLoopUntil#addUntilCase method. Attempting to add items directly to the array returned from this property will not add an until case to the action.

Methods

addUntilCase(untilCaseName, untilCaseExpressionopt) → {ArchNamedValue}

Adds an Until Case to a Loop Until action. You need to specify a name for the until case which will be available as an output on the action after it is successfully added. If you do not specify an until case expression, the boolean value on the returned until case will be a boolean false literal value.

Parameters:

Name	Type	Attributes	Default	Description
untilCaseName	string			this should be a non-blank string that specifies an Until Case name. Until case names must be unique. If you are not sure if you are adding an until case with a name that already exists, you can call ArchBaseActionWithOutputs#getOutputByName and check. Remember if you decide to use this method that until case outputs are dynamic so specify true for the isDynamic parameter on the GetOutputByName call.
untilCaseExpression	string	<optional>	'false'	this is the boolean expression to assign to the newly added Until Case. If no expression text is specified, the returned ArchNamedValue instance will have a value with a boolean false literal value.

Returns:

ArchNamedValue