rqt_py_trees.visibility Namespace Reference

Functions
def	filter_behaviours_by_visibility_level (behaviours, visibility_level)
def	get_branch_blackbox_level (behaviours, behaviour_id, current_level)
def	is_root (behaviour_id)
def	is_visible (behaviours, behaviour_id, visibility_level)

Variables
	combo_to_py_trees
	Imports. More...
dictionary	msg_to_py_trees
dictionary	saved_setting_to_combo_index

Function Documentation

def rqt_py_trees.visibility.filter_behaviours_by_visibility_level	(		behaviours,
			visibility_level
	)

Drops any behaviours whose blackbox level does not match the required visibility
level. See the py_trees.common module for more information.

:param py_trees_msgs.msg.Behaviour[] behaviours
:returns: py_trees_msgs.msg.Behaviour[]

Definition at line 94 of file visibility.py.

def rqt_py_trees.visibility.get_branch_blackbox_level	(		behaviours,
			behaviour_id,
			current_level
	)

Computes the critial (minimum) blackbox level present in the branch above
this behaviour.

:param {id: py_trees_msgs.Behaviour} behaviours: (sub)tree of all behaviours, including this one
:param uuid.UUID behaviour_id: id of this behavour
:param py_trees.common.BlackBoxLevel current_level

Definition at line 63 of file visibility.py.

def rqt_py_trees.visibility.is_root

(

behaviour_id

)

Check the unique id to determine if it is the root (all zeros).

:param uuid.UUID behaviour_id:

Definition at line 54 of file visibility.py.

def rqt_py_trees.visibility.is_visible	(		behaviours,
			behaviour_id,
			visibility_level
	)

:param {id: py_trees_msgs.Behaviour} behaviours:
:param uuid.UUID behaviour_id:
:param py_trees.common.VisibilityLevel visibility_level

Definition at line 79 of file visibility.py.

Variable Documentation

rqt_py_trees.visibility.combo_to_py_trees

Initial value:

= collections.OrderedDict([
    ("All", py_trees.common.VisibilityLevel.ALL),
    ("Detail", py_trees.common.VisibilityLevel.DETAIL),
    ("Component", py_trees.common.VisibilityLevel.COMPONENT),
    ("Big Picture", py_trees.common.VisibilityLevel.BIG_PICTURE)]
)

Imports.

Definition at line 32 of file visibility.py.

dictionary rqt_py_trees.visibility.msg_to_py_trees

Initial value:

= {
    py_trees_msgs.Behaviour.BLACKBOX_LEVEL_DETAIL: py_trees.common.BlackBoxLevel.DETAIL,
    py_trees_msgs.Behaviour.BLACKBOX_LEVEL_COMPONENT: py_trees.common.BlackBoxLevel.COMPONENT,
    py_trees_msgs.Behaviour.BLACKBOX_LEVEL_BIG_PICTURE: py_trees.common.BlackBoxLevel.BIG_PICTURE,
    py_trees_msgs.Behaviour.BLACKBOX_LEVEL_NOT_A_BLACKBOX: py_trees.common.BlackBoxLevel.NOT_A_BLACKBOX
}

Definition at line 46 of file visibility.py.

dictionary rqt_py_trees.visibility.saved_setting_to_combo_index

Initial value:

= {
    0: 0,
    1: 1,
    2: 2,
    3: 3
}

Definition at line 39 of file visibility.py.