Loop Counter Branching
N2FE Flow Operation - Loop Counter Branching
The LoopCounterBranching
will inspect the stored value of a provided counter and will select the appropriate exit according to if:
- Limit has not yet been reached.
- Limit has been reached (or exceeded).
The LoopCounterBranching
operation has exactly two exits.
Config Parameters
The LoopCounterBranching
operation config
attributes are as follows.
Parameter | Type | Description |
---|---|---|
buffer
|
User Buffer |
[Required] This must be the Name of a User Buffer (e.g. user.counter1 or user.counter2 )
which will be used for branching. See the notes on Buffer Names in the
Flow Introduction documentation. The GUI may allow free-form
entry for the user buffer name, or may restrict it to pre-determined values.
|
limit | Integer | [Required] This is the limit value. It must be an integer greater than or equal to zero. |
Example Operation
Here is an example LoopCounterBranching
operation in JSON representation.
{
"id": 5,
"type": "LoopCounterBranching",
"base_node": 1,
"config": {
"buffer": "user.counter1",
"limit": 3
},
"exits": [ 4, 17 ]
}
In this example, if the value of the buffer user.counter1
is greater than or equal to three, processing will proceed down exit index 1
to operation ID 17
.
Otherwise processing will continue down exit index 0
to operation ID 4
.
Exits
There are exactly two exits for every LoopCounterBranching
.
Exit Index | Name | Description |
---|---|---|
0
|
Not-Reached Exit | [Required] This exit is used if the counter value has not yet reached the configured limit, i.e. if it is strictly less than the limit. |
`1` | Limit-Reached Exit | [Required] This exit is used if the counter value has reached the configured limit, i.e. if it is greater than or equal to the limit. |