Inheritance diagram for test_tools.headless_smach_viewer.SmachViewerFrame:

Public Member Functions
def	__init__ (self)

def	add_to_tree (self, path, parent)

def	append_tree (self, container, parent=None)

def	on_set_initial_state (self, event)

def	OnExit (self, event)

def	OnIdle (self, event)

def	OnQuit (self, event)

def	select_cb (self, item, event)

def	selection_changed (self, event)

def	set_depth (self, event)

def	set_dotcode (self, dotcode, zoom=True)

def	set_filter (self, filter)

def	set_label_width (self, event)

def	set_path (self, event)

def	ShowControlsDialog (self, event)

def	toggle_all_transitions (self, event)

def	update_graph (self)

Public Attributes
	content_splitter

	depth_spinner

	is_button

	path_combo

	path_input

	statusbar

	tree

	ud_gs

	ud_txt

	ud_win

	widget

	width_spinner

Private Member Functions
def	_status_msg_update (self, msg)

def	_structure_msg_update (self, msg, server_name)

def	_update_graph (self)

def	_update_server_list (self)

def	_update_tree (self)

Detailed Description

This class provides a GUI application for viewing SMACH plans.

Definition at line 429 of file headless_smach_viewer.py.

Constructor & Destructor Documentation

◆ init()

def test_tools.headless_smach_viewer.SmachViewerFrame.__init__ ( self )

Definition at line 433 of file headless_smach_viewer.py.

Member Function Documentation

◆ _status_msg_update()

def test_tools.headless_smach_viewer.SmachViewerFrame._status_msg_update	(	self,
		msg
	)

private

Process status messages.

Definition at line 756 of file headless_smach_viewer.py.

◆ _structure_msg_update()

def test_tools.headless_smach_viewer.SmachViewerFrame._structure_msg_update	(	self,
		msg,
		server_name
	)

private

Update the structure of the SMACH plan (re-generate the dotcode).

Definition at line 707 of file headless_smach_viewer.py.

◆ _update_graph()

def test_tools.headless_smach_viewer.SmachViewerFrame._update_graph ( self )

private

This thread continuously updates the graph when it changes.

The graph gets updated in one of two ways:

  1: The structure of the SMACH plans has changed, or the display
  settings have been changed. In this case, the dotcode needs to be
  regenerated.

  2: The status of the SMACH plans has changed. In this case, we only
  need to change the styles of the graph.

Definition at line 782 of file headless_smach_viewer.py.

◆ _update_server_list()

def test_tools.headless_smach_viewer.SmachViewerFrame._update_server_list ( self )

private

Update the list of known SMACH introspection servers.

Definition at line 912 of file headless_smach_viewer.py.

◆ _update_tree()

def test_tools.headless_smach_viewer.SmachViewerFrame._update_tree ( self )

private

Update the tree view.

Definition at line 873 of file headless_smach_viewer.py.

◆ add_to_tree()

def test_tools.headless_smach_viewer.SmachViewerFrame.add_to_tree	(	self,
		path,
		parent
	)

Add a path to the tree view.

Definition at line 883 of file headless_smach_viewer.py.

◆ append_tree()

def test_tools.headless_smach_viewer.SmachViewerFrame.append_tree	(	self,
		container,
		parent = `None`
	)

Append an item to the tree view.

Definition at line 898 of file headless_smach_viewer.py.

◆ on_set_initial_state()

def test_tools.headless_smach_viewer.SmachViewerFrame.on_set_initial_state	(	self,
		event
	)

Event: Change the initial state of the server.

Definition at line 612 of file headless_smach_viewer.py.

◆ OnExit()

def test_tools.headless_smach_viewer.SmachViewerFrame.OnExit	(	self,
		event
	)

Definition at line 952 of file headless_smach_viewer.py.

◆ OnIdle()

def test_tools.headless_smach_viewer.SmachViewerFrame.OnIdle	(	self,
		event
	)

Event: On Idle, refresh the display if necessary, then un-set the flag.

Definition at line 905 of file headless_smach_viewer.py.

◆ OnQuit()

def test_tools.headless_smach_viewer.SmachViewerFrame.OnQuit	(	self,
		event
	)

Quit Event: kill threads and wait for join.

Definition at line 595 of file headless_smach_viewer.py.

◆ select_cb()

def test_tools.headless_smach_viewer.SmachViewerFrame.select_cb	(	self,
		item,
		event
	)

Event: Click to select a graph node to display user data and update the graph.

Definition at line 645 of file headless_smach_viewer.py.

◆ selection_changed()

def test_tools.headless_smach_viewer.SmachViewerFrame.selection_changed	(	self,
		event
	)

Event: Selection dropdown changed.

Definition at line 659 of file headless_smach_viewer.py.

◆ set_depth()

def test_tools.headless_smach_viewer.SmachViewerFrame.set_depth	(	self,
		event
	)

Event: Change the maximum target_depth and update the graph.

Definition at line 627 of file headless_smach_viewer.py.

◆ set_dotcode()

def test_tools.headless_smach_viewer.SmachViewerFrame.set_dotcode	(	self,
		dotcode,
		zoom = `True`
	)

Set the xdot view's dotcode and refresh the display.

Definition at line 857 of file headless_smach_viewer.py.

◆ set_filter()

def test_tools.headless_smach_viewer.SmachViewerFrame.set_filter	(	self,
		filter
	)

Definition at line 955 of file headless_smach_viewer.py.

◆ set_label_width()

def test_tools.headless_smach_viewer.SmachViewerFrame.set_label_width	(	self,
		event
	)

Event: Change the label wrapper width and update the graph.

Definition at line 633 of file headless_smach_viewer.py.

◆ set_path()

def test_tools.headless_smach_viewer.SmachViewerFrame.set_path	(	self,
		event
	)

Event: Change the viewable path and update the graph.

Definition at line 621 of file headless_smach_viewer.py.

◆ ShowControlsDialog()

def test_tools.headless_smach_viewer.SmachViewerFrame.ShowControlsDialog	(	self,
		event
	)

Definition at line 946 of file headless_smach_viewer.py.

◆ toggle_all_transitions()

def test_tools.headless_smach_viewer.SmachViewerFrame.toggle_all_transitions	(	self,
		event
	)

Event: Change whether automatic transitions are hidden and update the graph.

Definition at line 639 of file headless_smach_viewer.py.

◆ update_graph()

def test_tools.headless_smach_viewer.SmachViewerFrame.update_graph ( self )

Notify all that the graph needs to be updated.

Definition at line 607 of file headless_smach_viewer.py.

Member Data Documentation

◆ _client

test_tools.headless_smach_viewer.SmachViewerFrame._client

private

Definition at line 568 of file headless_smach_viewer.py.

◆ _containers

test_tools.headless_smach_viewer.SmachViewerFrame._containers

private

Definition at line 437 of file headless_smach_viewer.py.

◆ _keep_running

test_tools.headless_smach_viewer.SmachViewerFrame._keep_running

private

Definition at line 586 of file headless_smach_viewer.py.

◆ _label_wrapper

test_tools.headless_smach_viewer.SmachViewerFrame._label_wrapper

private

Definition at line 495 of file headless_smach_viewer.py.

◆ _max_depth

test_tools.headless_smach_viewer.SmachViewerFrame._max_depth

private

Definition at line 484 of file headless_smach_viewer.py.

◆ _needs_refresh

test_tools.headless_smach_viewer.SmachViewerFrame._needs_refresh

private

Definition at line 440 of file headless_smach_viewer.py.

◆ _needs_zoom

test_tools.headless_smach_viewer.SmachViewerFrame._needs_zoom

private

Definition at line 582 of file headless_smach_viewer.py.

◆ _path

test_tools.headless_smach_viewer.SmachViewerFrame._path

private

Definition at line 581 of file headless_smach_viewer.py.

◆ _selected_paths

test_tools.headless_smach_viewer.SmachViewerFrame._selected_paths

private

Definition at line 570 of file headless_smach_viewer.py.

◆ _server_list_thread

test_tools.headless_smach_viewer.SmachViewerFrame._server_list_thread

private

Definition at line 587 of file headless_smach_viewer.py.

◆ _show_all_transitions

test_tools.headless_smach_viewer.SmachViewerFrame._show_all_transitions

private

Definition at line 502 of file headless_smach_viewer.py.

◆ _status_subs

test_tools.headless_smach_viewer.SmachViewerFrame._status_subs

private

Definition at line 574 of file headless_smach_viewer.py.

◆ _structure_changed

test_tools.headless_smach_viewer.SmachViewerFrame._structure_changed

private

Definition at line 583 of file headless_smach_viewer.py.

◆ _structure_subs

test_tools.headless_smach_viewer.SmachViewerFrame._structure_subs

private

Definition at line 573 of file headless_smach_viewer.py.

◆ _top_containers

test_tools.headless_smach_viewer.SmachViewerFrame._top_containers

private

Definition at line 438 of file headless_smach_viewer.py.

◆ _tree_nodes

test_tools.headless_smach_viewer.SmachViewerFrame._tree_nodes

private

Definition at line 879 of file headless_smach_viewer.py.

◆ _update_cond

test_tools.headless_smach_viewer.SmachViewerFrame._update_cond

private

Definition at line 439 of file headless_smach_viewer.py.

◆ _update_graph_thread

test_tools.headless_smach_viewer.SmachViewerFrame._update_graph_thread

private

Definition at line 590 of file headless_smach_viewer.py.

◆ _update_tree_thread

test_tools.headless_smach_viewer.SmachViewerFrame._update_tree_thread

private

Definition at line 592 of file headless_smach_viewer.py.

◆ content_splitter

test_tools.headless_smach_viewer.SmachViewerFrame.content_splitter

Definition at line 446 of file headless_smach_viewer.py.

◆ depth_spinner

test_tools.headless_smach_viewer.SmachViewerFrame.depth_spinner

Definition at line 478 of file headless_smach_viewer.py.

◆ is_button

test_tools.headless_smach_viewer.SmachViewerFrame.is_button

Definition at line 546 of file headless_smach_viewer.py.

◆ path_combo

test_tools.headless_smach_viewer.SmachViewerFrame.path_combo

Definition at line 471 of file headless_smach_viewer.py.

◆ path_input

test_tools.headless_smach_viewer.SmachViewerFrame.path_input

Definition at line 535 of file headless_smach_viewer.py.

◆ statusbar

test_tools.headless_smach_viewer.SmachViewerFrame.statusbar

Definition at line 558 of file headless_smach_viewer.py.

◆ tree

test_tools.headless_smach_viewer.SmachViewerFrame.tree

Definition at line 522 of file headless_smach_viewer.py.

◆ ud_gs

test_tools.headless_smach_viewer.SmachViewerFrame.ud_gs

Definition at line 531 of file headless_smach_viewer.py.

◆ ud_txt

test_tools.headless_smach_viewer.SmachViewerFrame.ud_txt

Definition at line 542 of file headless_smach_viewer.py.

◆ ud_win

test_tools.headless_smach_viewer.SmachViewerFrame.ud_win

Definition at line 530 of file headless_smach_viewer.py.

◆ widget

test_tools.headless_smach_viewer.SmachViewerFrame.widget

Definition at line 516 of file headless_smach_viewer.py.

◆ width_spinner

test_tools.headless_smach_viewer.SmachViewerFrame.width_spinner

Definition at line 489 of file headless_smach_viewer.py.

The documentation for this class was generated from the following file:

headless_smach_viewer.py

Private Attributes
	_client

	_containers

	_keep_running

	_label_wrapper

	_max_depth

	_needs_refresh

	_needs_zoom

	_path

	_selected_paths

	_server_list_thread

	_show_all_transitions

	_status_subs

	_structure_changed

	_structure_subs

	_top_containers

	_tree_nodes

	_update_cond

	_update_graph_thread

	_update_tree_thread

Public Member Functions

Public Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __init__()

Member Function Documentation

◆ _status_msg_update()

◆ _structure_msg_update()

◆ _update_graph()

◆ _update_server_list()

◆ _update_tree()

◆ add_to_tree()

◆ append_tree()

◆ on_set_initial_state()

◆ OnExit()

◆ OnIdle()

◆ OnQuit()

◆ select_cb()

◆ selection_changed()

◆ set_depth()

◆ set_dotcode()

◆ set_filter()

◆ set_label_width()

◆ set_path()

◆ ShowControlsDialog()

◆ toggle_all_transitions()

◆ update_graph()

Member Data Documentation

◆ _client

◆ _containers

◆ _keep_running

◆ _label_wrapper

◆ _max_depth

◆ _needs_refresh

◆ _needs_zoom

◆ _path

◆ _selected_paths

◆ _server_list_thread

◆ _show_all_transitions

◆ _status_subs

◆ _structure_changed

◆ _structure_subs

◆ _top_containers

◆ _tree_nodes

◆ _update_cond

◆ _update_graph_thread

◆ _update_tree_thread

◆ content_splitter

◆ depth_spinner

◆ is_button

◆ path_combo

◆ path_input

◆ statusbar

◆ tree

◆ ud_gs

◆ ud_txt

◆ ud_win

◆ widget

◆ width_spinner

◆ init()