Improve class docs for Repeat, RunLimit, Subtree & TimeLimit
This commit is contained in:
parent
eb58363977
commit
7324f0462b
|
@ -1,25 +1,25 @@
|
||||||
<?xml version="1.0" encoding="UTF-8" ?>
|
<?xml version="1.0" encoding="UTF-8" ?>
|
||||||
<class name="BTRepeat" inherits="BTDecorator" version="4.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd">
|
<class name="BTRepeat" inherits="BTDecorator" version="4.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd">
|
||||||
<brief_description>
|
<brief_description>
|
||||||
BT decorator that repeats its child specified number of [member times].
|
BT decorator that repeats its child a specified number of [member times].
|
||||||
</brief_description>
|
</brief_description>
|
||||||
<description>
|
<description>
|
||||||
BT decorator that repeats execution of the child task specified number of [member times].
|
BTRepeat iterates its child task a specified number of times, as defined by [member times]. If [member forever] is [code]true[/code], the child's execution will be repeated indefinitely.
|
||||||
Returns [code]RUNNING[/code] if the child returns [code]RUNNING[/code]. If [member forever] is [code]true[/code], BTRepeat will always return [code]RUNNING[/code].
|
Returns [code]RUNNING[/code] if the child task results in [code]RUNNING[/code]. If [member forever] is [code]true[/code], BTRepeat will always return [code]RUNNING[/code].
|
||||||
Returns [code]SUCCESS[/code] when specified number of successfully finished executions is reached. When [member abort_on_failure] is [code]false[/code], [code]FAILURE[/code] status returned by the child is also considered a successfully finished execution.
|
Returns [code]SUCCESS[/code] if the specified number of successful executions is reached. If [member abort_on_failure] is [code]false[/code], a [code]FAILURE[/code] status returned by the child is also considered a successful execution.
|
||||||
Returns [code]FAILURE[/code] when [member abort_on_failure] is set and the child returns [code]FAILURE[/code].
|
Returns [code]FAILURE[/code] if the child task results in [code]FAILURE[/code] when [member abort_on_failure] is [code]true[/code].
|
||||||
</description>
|
</description>
|
||||||
<tutorials>
|
<tutorials>
|
||||||
</tutorials>
|
</tutorials>
|
||||||
<members>
|
<members>
|
||||||
<member name="abort_on_failure" type="bool" setter="set_abort_on_failure" getter="get_abort_on_failure" default="false">
|
<member name="abort_on_failure" type="bool" setter="set_abort_on_failure" getter="get_abort_on_failure" default="false">
|
||||||
If [code]false[/code], [code]FAILURE[/code] status returned by the child is also considered a successfully finished execution.
|
If [code]false[/code], [code]FAILURE[/code] status returned by the child task is also considered as a successful execution.
|
||||||
</member>
|
</member>
|
||||||
<member name="forever" type="bool" setter="set_forever" getter="get_forever" default="false">
|
<member name="forever" type="bool" setter="set_forever" getter="get_forever" default="false">
|
||||||
If [code]true[/code], the child's execution will be repeated indefinitely, always returning [code]RUNNING[/code].
|
If [code]true[/code], the child's execution will be repeated indefinitely, always returning [code]RUNNING[/code].
|
||||||
</member>
|
</member>
|
||||||
<member name="times" type="int" setter="set_times" getter="get_times" default="1">
|
<member name="times" type="int" setter="set_times" getter="get_times" default="1">
|
||||||
A number of times to repeat an execution of the child task.
|
The number of times to repeat execution of the child task.
|
||||||
</member>
|
</member>
|
||||||
</members>
|
</members>
|
||||||
</class>
|
</class>
|
||||||
|
|
|
@ -1,17 +1,17 @@
|
||||||
<?xml version="1.0" encoding="UTF-8" ?>
|
<?xml version="1.0" encoding="UTF-8" ?>
|
||||||
<class name="BTRunLimit" inherits="BTDecorator" version="4.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd">
|
<class name="BTRunLimit" inherits="BTDecorator" version="4.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd">
|
||||||
<brief_description>
|
<brief_description>
|
||||||
BT decorator that allows child's execution a limited number of times.
|
BT decorator that restricts the execution of its child a limited number of times.
|
||||||
</brief_description>
|
</brief_description>
|
||||||
<description>
|
<description>
|
||||||
BT decorator that allows child's execution a limited number of times defined by [member run_limit].
|
BTRunLimit restricts the execution of the child task to a maximum number of times, defined by [member run_limit].
|
||||||
Returns [code]FAILURE[/code], if a limit on executions is exceeded. Otherwise, returns child's status.
|
Returns [code]FAILURE[/code] if the limit on executions is exceeded; otherwise, it returns the status of the child task.
|
||||||
</description>
|
</description>
|
||||||
<tutorials>
|
<tutorials>
|
||||||
</tutorials>
|
</tutorials>
|
||||||
<members>
|
<members>
|
||||||
<member name="run_limit" type="int" setter="set_run_limit" getter="get_run_limit" default="1">
|
<member name="run_limit" type="int" setter="set_run_limit" getter="get_run_limit" default="1">
|
||||||
A limit on number of times the child is allowed to be executed.
|
The maximum number of times the child is permitted to be executed.
|
||||||
</member>
|
</member>
|
||||||
</members>
|
</members>
|
||||||
</class>
|
</class>
|
||||||
|
|
|
@ -1,11 +1,11 @@
|
||||||
<?xml version="1.0" encoding="UTF-8" ?>
|
<?xml version="1.0" encoding="UTF-8" ?>
|
||||||
<class name="BTSubtree" inherits="BTNewScope" version="4.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd">
|
<class name="BTSubtree" inherits="BTNewScope" version="4.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd">
|
||||||
<brief_description>
|
<brief_description>
|
||||||
BT decorator that instantiates a subtree.
|
BT decorator that instantiates and runs a subtree within the larger tree.
|
||||||
</brief_description>
|
</brief_description>
|
||||||
<description>
|
<description>
|
||||||
Instantiates a behavior tree as a child of this task during initialization and creates a new [Blackboard] scope.
|
BTSubtree instantiates a [BehaviorTree] and includes its root task as a child during initialization, while also creating a new [Blackboard] scope.
|
||||||
Returns status of the child execution.
|
Returns the status of the subtree's execution.
|
||||||
</description>
|
</description>
|
||||||
<tutorials>
|
<tutorials>
|
||||||
</tutorials>
|
</tutorials>
|
||||||
|
|
|
@ -1,16 +1,17 @@
|
||||||
<?xml version="1.0" encoding="UTF-8" ?>
|
<?xml version="1.0" encoding="UTF-8" ?>
|
||||||
<class name="BTTimeLimit" inherits="BTDecorator" version="4.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd">
|
<class name="BTTimeLimit" inherits="BTDecorator" version="4.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd">
|
||||||
<brief_description>
|
<brief_description>
|
||||||
BT decorator that allots a limited time for child's execution.
|
BT decorator that sets a time limit for its child's execution.
|
||||||
</brief_description>
|
</brief_description>
|
||||||
<description>
|
<description>
|
||||||
BT decorator that allots a limited time for child's execution. Cancels execution and returns [code]FAILURE[/code] if [member time_limit] is exceeded.
|
BTTimeLimit allocates a limited time for the child's execution and cancels it, returning [code]FAILURE[/code] if the [member time_limit] is exceeded.
|
||||||
|
Returns [code]FAILURE[/code] if the [member time_limit] is exceeded; otherwise, it returns the status of the child task.
|
||||||
</description>
|
</description>
|
||||||
<tutorials>
|
<tutorials>
|
||||||
</tutorials>
|
</tutorials>
|
||||||
<members>
|
<members>
|
||||||
<member name="time_limit" type="float" setter="set_time_limit" getter="get_time_limit" default="5.0">
|
<member name="time_limit" type="float" setter="set_time_limit" getter="get_time_limit" default="5.0">
|
||||||
Time allotted for a child task's execution.
|
Time allocated for the child task's execution.
|
||||||
</member>
|
</member>
|
||||||
</members>
|
</members>
|
||||||
</class>
|
</class>
|
||||||
|
|
Loading…
Reference in New Issue