Refine class docs
This commit is contained in:
parent
067f73e11e
commit
a7d86c5356
|
@ -1,27 +1,27 @@
|
|||
<?xml version="1.0" encoding="UTF-8" ?>
|
||||
<class name="BTParallel" inherits="BTComposite" version="4.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd">
|
||||
<brief_description>
|
||||
BT composite that executes tasks simultaneously.
|
||||
BT composite that executes child tasks until one of the criteria is met.
|
||||
</brief_description>
|
||||
<description>
|
||||
BT composite that executes tasks simultaneously until one of the criterea is met. BTParallel will execute each task from first to last at least once before returning a result.
|
||||
If set to [member repeat], the tasks will be executed again, even if they returned [code]SUCCESS[/code] or [code]FAILURE[/code] on the previous tick.
|
||||
Returns [code]FAILURE[/code] when a required number of tasks return [code]FAILURE[/code]. When [member repeat] is set to [code]false[/code], if none of the criteria were met, and all child tasks returned [code]SUCCESS[/code] or [code]FAILURE[/code], [BTParallel] will return [code]FAILURE[/code].
|
||||
Returns [code]SUCCESS[/code] when a required number of tasks return [code]SUCCESS[/code].
|
||||
Returns [code]RUNNING[/code] after executing all tasks from first to last, and for as long as the above criterea are not met.
|
||||
BTParallel executes its child tasks until one of the criterea is met. It will execute each task at least once, from the first to the last, before returning a result.
|
||||
If set to [member repeat], the child tasks will be re-executed, regardless of whether they previously resulted in a [code]SUCCESS[/code] or [code]FAILURE[/code].
|
||||
Returns [code]FAILURE[/code] when the required number of tasks return [code]FAILURE[/code]. When [member repeat] is set to [code]false[/code], if none of the criteria were met, and all child tasks resulted in a [code]SUCCESS[/code] or [code]FAILURE[/code], BTParallel will return [code]FAILURE[/code].
|
||||
Returns [code]SUCCESS[/code] when the required number of tasks return [code]SUCCESS[/code].
|
||||
Returns [code]RUNNING[/code] if none of the criterea were fulfilled, and either [member repeat] is set to [code]true[/code] or a child task resulted in [code]RUNNING[/code].
|
||||
</description>
|
||||
<tutorials>
|
||||
</tutorials>
|
||||
<members>
|
||||
<member name="num_failures_required" type="int" setter="set_num_failures_required" getter="get_num_failures_required" default="1">
|
||||
When the specified number of child tasks return [code]SUCCESS[/code], [BTParallel] will also return [code]SUCCESS[/code].
|
||||
When the specified number of child tasks return [code]SUCCESS[/code], BTParallel will also return [code]SUCCESS[/code].
|
||||
</member>
|
||||
<member name="num_successes_required" type="int" setter="set_num_successes_required" getter="get_num_successes_required" default="1">
|
||||
When the specified number of child tasks return [code]FAILURE[/code], [BTParallel] will also return [code]FAILURE[/code].
|
||||
When the specified number of child tasks return [code]FAILURE[/code], BTParallel will also return [code]FAILURE[/code].
|
||||
</member>
|
||||
<member name="repeat" type="bool" setter="set_repeat" getter="get_repeat" default="false">
|
||||
When [code]true[/code], the tasks will be executed again, even if they returned [code]SUCCESS[/code] or [code]FAILURE[/code] on the previous tick.
|
||||
When [code]false[/code], if none of the criteria were met, and all child tasks returned [code]SUCCESS[/code] or [code]FAILURE[/code], [BTParallel] will return [code]FAILURE[/code].
|
||||
When [code]true[/code], the child tasks will be executed again, regardless of whether they previously resulted in a [code]SUCCESS[/code] or [code]FAILURE[/code].
|
||||
When [code]false[/code], if none of the criteria were met, and all child tasks resulted in a [code]SUCCESS[/code] or [code]FAILURE[/code], BTParallel will return [code]FAILURE[/code].
|
||||
</member>
|
||||
</members>
|
||||
</class>
|
||||
|
|
|
@ -1,13 +1,13 @@
|
|||
<?xml version="1.0" encoding="UTF-8" ?>
|
||||
<class name="BTSelector" inherits="BTComposite" version="4.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd">
|
||||
<brief_description>
|
||||
BT composite that executes tasks in turn until first [code]SUCCESS[/code].
|
||||
BT composite that sequentially executes tasks until first [code]SUCCESS[/code].
|
||||
</brief_description>
|
||||
<description>
|
||||
BT composite that executes child tasks from first to last until any child returns [code]SUCCESS[/code].
|
||||
Returns [code]RUNNING[/code] if a task returns [code]RUNNING[/code], and remembers last [code]RUNNING[/code] child. BTSelector will continue where it left off on the next execution tick.
|
||||
Returns [code]FAILURE[/code] if all tasks return [code]FAILURE[/code].
|
||||
Returns [code]SUCCESS[/code] if any task returns [code]SUCCESS[/code].
|
||||
BTSelector executes its child tasks sequentially, from first to last, until any child returns [code]SUCCESS[/code].
|
||||
Returns [code]RUNNING[/code] if any child task returns [code]RUNNING[/code]. The composite will also remember the last child task that returned [code]RUNNING[/code], ensuring it resumes from that point in the next execution tick.
|
||||
Returns [code]FAILURE[/code] if all child tasks return [code]FAILURE[/code].
|
||||
Returns [code]SUCCESS[/code] if a child task returns [code]SUCCESS[/code].
|
||||
</description>
|
||||
<tutorials>
|
||||
</tutorials>
|
||||
|
|
|
@ -1,13 +1,13 @@
|
|||
<?xml version="1.0" encoding="UTF-8" ?>
|
||||
<class name="BTSequence" inherits="BTComposite" version="4.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd">
|
||||
<brief_description>
|
||||
BT composite that executes tasks in turn for as long as they return [code]SUCCESS[/code].
|
||||
BT composite that sequentially executes tasks as long as they return [code]SUCCESS[/code].
|
||||
</brief_description>
|
||||
<description>
|
||||
BT composite that executes child tasks from first to last for as long as they return [code]SUCCESS[/code].
|
||||
Returns [code]RUNNING[/code] if a task returns [code]RUNNING[/code], and remembers last [code]RUNNING[/code] child. BTSequence will continue where it left off on the next execution tick.
|
||||
Returns [code]FAILURE[/code] if any task returns [code]FAILURE[/code].
|
||||
Returns [code]SUCCESS[/code] if all tasks return [code]SUCCESS[/code].
|
||||
BTSequence executes its child tasks sequentially, from first to last, as long as they return [code]SUCCESS[/code].
|
||||
Returns [code]RUNNING[/code] if any child task returns [code]RUNNING[/code]. The composite will also remember the last child task that returned [code]RUNNING[/code], ensuring it resumes from that point in the next execution tick.
|
||||
Returns [code]FAILURE[/code] if a child task returns [code]FAILURE[/code].
|
||||
Returns [code]SUCCESS[/code] if all child tasks return [code]SUCCESS[/code].
|
||||
</description>
|
||||
<tutorials>
|
||||
</tutorials>
|
||||
|
|
Loading…
Reference in New Issue