BTRunLimit

Inherits: BTDecorator < BTTask < BT

BT decorator that restricts the execution of its child a limited number of times.

Description

BTRunLimit restricts the execution of the child task to a maximum number of times, defined by run_limit.

Returns FAILURE if the limit on executions is exceeded; otherwise, it returns the status of the child task.

Properties

CountPolicy	count_policy	0
int	run_limit	1

---

Enumerations

enum CountPolicy: 🔗

CountPolicy COUNT_SUCCESSFUL = 0

Count only successful runs towards the limit.

CountPolicy COUNT_FAILED = 1

Count only failed runs towards the limit.

CountPolicy COUNT_ALL = 2

Count successful and failed runs towards the limit.

---

Property Descriptions

CountPolicy count_policy = 0 🔗

• void set_count_policy(value: CountPolicy)

• CountPolicy get_count_policy()

Which runs should be counted towards the limit: successful, failed, or all?

---

int run_limit = 1 🔗

• void set_run_limit(value: int)

• int get_run_limit()

The maximum number of times the child is permitted to be executed.