Functions — github.com/ToyotaResearchInstitute/task_behavior

↓ 232 callersMethodget_node_status

Gets the status of a specific node. @param scope [uuid] The id of the node to get. @returns [NodeStatus] The status of the no

src/task_behavior_engine/tree.py:252

↓ 206 callersMethodadd_child

Add a node to the end behavior tree. @param node [Node] The node to add. @throws RuntimeError if the node name is not unique to this b

src/task_behavior_engine/tree.py:538

↓ 147 callersMethodtick

Runs the node

src/task_behavior_engine/tree.py:453

↓ 68 callersMethodget_result

Return the result of this behavior. @returns [NodeStatus] The current result status.

src/task_behavior_engine/tree.py:407

↓ 36 callersMethodget_memory

Gets current nodedata with any remappings. @param scope [uuid] The id of the scope/node.

src/task_behavior_engine/tree.py:241

↓ 35 callersMethodforce

Forces an execution state. @param status [int] forced outcome state (must be NodeStatus enum).

src/task_behavior_engine/tree.py:382

↓ 29 callersMethod_cancel

Forces the current state to CANCEL and calls the cancel callback, if it exists.

src/task_behavior_engine/tree.py:362

↓ 21 callersMethodtick_child

Run a child node @param child [Node] The child to run

src/task_behavior_engine/tree.py:569

↓ 20 callersMethod_configure

Configuration performed once before run(). This is usually used to set up internal variables.

src/task_behavior_engine/tree.py:312

↓ 12 callersMethodget

Gets a (key, value) pair from tree_scope/node_scope. @param key [string] The key to retrieve. @param scope [uuid] (optional)

src/task_behavior_engine/tree.py:219

↓ 12 callersMethodget_data

Gets data from key. If key does not exist, returns default value. @param key [string] The data key @param default (None) The

src/task_behavior_engine/tree.py:76

↓ 11 callersMethodsave

Saves a (key, value) pair onto tree_scope/node_scope. @param key [string] the key of the item. @param value [*] The value of

src/task_behavior_engine/tree.py:210

↓ 11 callersMethodset_blackboard

Set the blackboard for this node. @param blackboard [Blackboard] The blackboard to assign to this node.

src/task_behavior_engine/tree.py:447

↓ 10 callersMethod_cleanup

Cleanup performed once after run() returns a termination value. This is usually used to reset internal variables.

src/task_behavior_engine/tree.py:326

↓ 9 callersMethodkeys

Gets all of the keys @returns List A list of all of the keys

src/task_behavior_engine/tree.py:70

↓ 9 callersMethodregister_run_cb

Register the run_cb. This will get called when ticked. @param cb [function] The function to call on run.

src/task_behavior_engine/tree.py:419

↓ 8 callersMethod__init__

(self, name, *args, **kwargs)

src/task_behavior_engine/branch.py:110

↓ 8 callersMethod_run

Evaluates the current node. @returns [NodeStatus] Outcome status.

src/task_behavior_engine/tree.py:342

↓ 8 callersMethodregister_cleanup_cb

Register the cleanup callback. This will get called on cleanup. @param cb [function] The function to call on cleanup.

src/task_behavior_engine/tree.py:433

↓ 8 callersMethodregister_configure_cb

Register the configure_cb. This will get called on configure. @param cb [function] The function to call on configure.

src/task_behavior_engine/tree.py:426

↓ 6 callersMethod__init__

(self, name, *args, **kwargs)

src/task_behavior_engine/decorator.py:138

↓ 5 callersMethod_get_node_memory

Gets node memory If memory doesn't exist it will be assigned a default value. @param scope [uuid] The id of the node.

src/task_behavior_engine/tree.py:159

↓ 4 callersMethod_get_memory

Gets memory. If scope is none, it returns global memory else it returns node memory. @param scope [uuid] The uuid

src/task_behavior_engine/tree.py:193

↓ 4 callersMethodclear_node_status

Clears the node_status currently saved. This is mostly used for display purposes.

src/task_behavior_engine/tree.py:268

↓ 4 callersMethodregister_cancel_cb

Register the cancel callback. This will get called if task is canceled. @param cb [function] The function to call on cancel.

src/task_behavior_engine/tree.py:440

↓ 4 callersMethodreset_children_status

Reset the current node status for all children

src/task_behavior_engine/tree.py:617

↓ 3 callersMethodset_node_status

Sets the status of a specific node @param scope [uuid] The id of the node to set @param status [NodeStatus] The status to set

src/task_behavior_engine/tree.py:261

↓ 2 callersMethod__init__

(self, name, *args, **kwargs)

src/task_behavior_engine/node.py:35

↓ 2 callersMethod__init__

Node constructor. @param name [string] The name of this node. @param blackboard [Blackboard] The common nodedata container.

src/task_behavior_engine/tree.py:291

↓ 2 callersMethod_get_node_data

Gets node data with any remappings. If node data doesn't exist it will create an empty NodeData object. @param node_memory [d

src/task_behavior_engine/tree.py:170

↓ 2 callersMethod_get_status_str

Gets the string of the current status enum

src/task_behavior_engine/tree.py:115

↓ 2 callersMethodcancel_children

Cancel all children currently running

src/task_behavior_engine/tree.py:586

↓ 2 callersMethodget_status

Gets all of the node status.

src/task_behavior_engine/tree.py:247

↓ 2 callersMethodset_data

Sets data. @param key [string] The data key @param value [*] The data value

src/task_behavior_engine/tree.py:86

↓ 1 callersMethod__getattr__

Override getattr to be thread safe.

src/task_behavior_engine/tree.py:37

↓ 1 callersMethod_cancel

Cancel the child node if this node is canceled.

src/task_behavior_engine/tree.py:498

↓ 1 callersMethod_cancel

If a behavior is canceled, cancel all running children.

src/task_behavior_engine/tree.py:592

↓ 1 callersMethod_cleanup

Cleanup the child node if this node is cleaned up.

src/task_behavior_engine/tree.py:488

↓ 1 callersMethod_cleanup

If a behavior finishes, cancel all running children.

src/task_behavior_engine/tree.py:610

↓ 1 callersMethod_configure

Configure the child node if this node is configured.

src/task_behavior_engine/tree.py:477

↓ 1 callersMethodadd_remapping

Add a remapping from one node->key to another node->key. @param from_scope [uuid] The id of the source node. @param from_key

src/task_behavior_engine/tree.py:228

↓ 1 callersMethodcancel

By default a behavior should just call its internal cancel when requested.

src/task_behavior_engine/tree.py:376

↓ 1 callersMethodcancel_child

Cancel a particular child. @param child [Node] The child to cancel

src/task_behavior_engine/tree.py:623

↓ 1 callersMethodcheck_unique_child

(self, name)

src/task_behavior_engine/tree.py:535

↓ 1 callersMethodcleanup_children

Cleanup all active children

src/task_behavior_engine/tree.py:598

↓ 1 callersMethodinsert_child

Insert node into position i of the behavior tree. @param node [Node] The node to add. @param i [int] The position of insertion.

src/task_behavior_engine/tree.py:562

↓ 1 callersMethodprepend_child

Add a node to the beginning of the behavior tree. @param node [Node] The node to prepend.

src/task_behavior_engine/tree.py:556

↓ 1 callersMethodremove_child

Remove a node from the behavior tree. @param node [Node] The node to remove. @throws ValueError if node not child of behavior.

src/task_behavior_engine/tree.py:549

Method__contains__

(self, key)

src/task_behavior_engine/tree.py:34

Method__eq__

(self, other)

src/task_behavior_engine/tree.py:131

Method__getitem__

(self, key)

src/task_behavior_engine/tree.py:61

Method__init__

User-facing initialization @param name [str] The human-readable name to aid in debugging

example/example.py:35

Method__init__

(self, name, *args, **kwargs)

src/task_behavior_engine/node.py:24

Method__init__

(self, name, *args, **kwargs)

src/task_behavior_engine/node.py:46

Method__init__

(self, name, *args, **kwargs)

src/task_behavior_engine/decorator.py:31

Method__init__

(self, name, *args, **kwargs)

src/task_behavior_engine/decorator.py:53

Method__init__

(self, name, *args, **kwargs)

src/task_behavior_engine/decorator.py:72

Method__init__

(self, name, *args, **kwargs)

src/task_behavior_engine/decorator.py:91

Method__init__

(self, name, max_count, *args, **kwargs)

src/task_behavior_engine/decorator.py:109

Method__init__

(self, name, *args, **kwargs)

src/task_behavior_engine/decorator.py:158

Method__init__

(self)

src/task_behavior_engine/tree.py:30

Method__init__

(self, status=PENDING, text="")

src/task_behavior_engine/tree.py:111

Method__init__

(self)

src/task_behavior_engine/tree.py:154

Method__init__

(self, name, child=None, *args, **kwargs)

src/task_behavior_engine/tree.py:473

Method__init__

(self, name, *args, **kwargs)

src/task_behavior_engine/tree.py:529

Method__init__

(self, name, *args, **kwargs)

src/task_behavior_engine/branch.py:34

Method__init__

(self, name, *args, **kwargs)

src/task_behavior_engine/branch.py:61

Method__init__

(self, name, *args, **kwargs)

src/task_behavior_engine/branch.py:87

Method__init__

(self, name, *args, **kwargs)

src/task_behavior_engine/branch.py:147

Method__init__

(self, name, *args, **kwargs)

src/task_behavior_engine/branch.py:182

Method__init__

(self, name, *args, **kwargs)

src/task_behavior_engine/branch.py:218

Method__init__

(self, name, *args, **kwargs)

src/task_behavior_engine/branch.py:254

Method__init__

(self, name, *args, **kwargs)

src/task_behavior_engine/branch.py:302

Method__setattr__

Override setattr to be thread safe.

src/task_behavior_engine/tree.py:49

Method__setitem__

(self, key, item)

src/task_behavior_engine/tree.py:64

Method__str__

(self)

src/task_behavior_engine/tree.py:67

Method__str__

(self)

src/task_behavior_engine/tree.py:128

Methodcancel_callback

(nd)

test/test_tree.py:315

Methodcancel_cb

(nd)

test/test_tree.py:596

Methodcleanup

Reset the count to start @param nodedata [NodeData] NodeData: index [int] The current index of the count

example/example.py:70

Methodcleanup_callback

(nd)

test/test_tree.py:253

Methodcleanup_cb

(nd)

test/test_tree.py:451

Methodcleanup_cb

(nd)

test/test_tree.py:567

Methodconfig

(self, nodedata)

src/task_behavior_engine/decorator.py:115

Methodconfig_callback

(nd)

test/test_tree.py:380

Methodconfig_cb

(nd)

test/test_tree.py:447

Methodconfig_cb

(nd)

test/test_tree.py:563

Methodconfigure

Initialize the start and limit values @param nodedata [NodeData] The shareable data associated with this node NodeData:

example/example.py:46

Methodconfigure

(self, nodedata)

src/task_behavior_engine/branch.py:116

Methodconfigure

(self, nodedata)

src/task_behavior_engine/branch.py:153

Methodconfigure

(self, nodedata)

src/task_behavior_engine/branch.py:189

Methodconfigure

(self, nodedata)

src/task_behavior_engine/branch.py:224

Methodconfigure

(self, nodedata)

src/task_behavior_engine/branch.py:260

Methodconfigure_callback

(nd)

test/test_tree.py:227

Methodcontinue_cb

(nd)

test/test_tree.py:585

Methodget_nodedata

Return the NodeData of this behavior @returns [NodeData] The current NodeData

src/task_behavior_engine/tree.py:394

Methodget_status

Get the status of this node. @returns [NodeStatus] The last completion status of the node.

src/task_behavior_engine/tree.py:413

Methodmerge

Merges a NodeStatus together. If the merged status has a greater value than the current status, the merged status is used.

src/task_behavior_engine/tree.py:134

Methodrun

Update the count and return current status. @param nodedata [NodeData] The shareable data associated with this node NodeData

example/example.py:58

Methodrun

(self, nodedata)

src/task_behavior_engine/node.py:27

Functions268 in github.com/ToyotaResearchInstitute/task_behavior_engine