Loop Limit
N2FE Flow Operation - Loop Limit
The Loop Limit
operation allows NCC to restrict the number of times the
operation is triggered in a control plan.
It should be used where a loop within a control plan is known to occur to ensure that NCC does not loop forever between nodes.
Depending on configuration, loop limit nodes might be required to allow any loops in control plans.
Config Parameters
The LoopLimit
operation config
attributes are as follows.
Parameter | Type | Description |
---|---|---|
loop_limit
|
Integer | A value between 0 and 1000 determining what NCC should consider the maximum number of times processing the operation. |
Example Operation
Here is an example LoopLimit
operation in JSON representation.
{
"id": 5,
"type": "LoopLimit",
"base_node": 4,
"config": {
"loop_limit": 5
},
"exits": [ 7, 6 ]
}
Exits
Two exits are allowed. Both are optional.
Exit Index | Name | Description |
---|---|---|
0
|
Below Limit | [Optional] This exit is used if the number of times NCC has processed this node in a running control plan is less than the loop limit. |
1
|
Limit Reached | [Optional] This exit is used if the number of times NCC has processed this node in a running control plan is equal to or greater than the loop limit. |