Inheritance diagram for 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	SaveDotGraph (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	toggle_auto_focus (self, event)

def	update_graph (self)

Public Attributes
	content_splitter

	depth_spinner

	dotstr

	is_button

	path_combo

	path_input

	statusbar

	tree

	ud_gs

	ud_txt

	ud_win

	widget

	width_spinner

Private Member Functions
def	_set_max_depth (self, max_depth)

def	_set_path (self, path)

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 459 of file smach_viewer.py.

Constructor & Destructor Documentation

def smach_viewer.SmachViewerFrame.__init__ ( self )

Definition at line 463 of file smach_viewer.py.

Member Function Documentation

def smach_viewer.SmachViewerFrame._set_max_depth	(	self,
		max_depth
	)

private

Definition at line 679 of file smach_viewer.py.

def smach_viewer.SmachViewerFrame._set_path	(	self,
		path
	)

private

Definition at line 667 of file smach_viewer.py.

def smach_viewer.SmachViewerFrame._status_msg_update	(	self,
		msg
	)

private

Process status messages.

Definition at line 823 of file smach_viewer.py.

def 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 774 of file smach_viewer.py.

def 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 853 of file smach_viewer.py.

def smach_viewer.SmachViewerFrame._update_server_list ( self )

private

Update the list of known SMACH introspection servers.

Definition at line 980 of file smach_viewer.py.

def smach_viewer.SmachViewerFrame._update_tree ( self )

private

Update the tree view.

Definition at line 941 of file smach_viewer.py.

def smach_viewer.SmachViewerFrame.add_to_tree	(	self,
		path,
		parent
	)

Add a path to the tree view.

Definition at line 951 of file smach_viewer.py.

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

Append an item to the tree view.

Definition at line 966 of file smach_viewer.py.

def smach_viewer.SmachViewerFrame.on_set_initial_state	(	self,
		event
	)

Event: Change the initial state of the server.

Definition at line 652 of file smach_viewer.py.

def smach_viewer.SmachViewerFrame.OnExit	(	self,
		event
	)

Definition at line 1030 of file smach_viewer.py.

def smach_viewer.SmachViewerFrame.OnIdle	(	self,
		event
	)

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

Definition at line 973 of file smach_viewer.py.

def smach_viewer.SmachViewerFrame.OnQuit	(	self,
		event
	)

Quit Event: kill threads and wait for join.

Definition at line 635 of file smach_viewer.py.

def smach_viewer.SmachViewerFrame.SaveDotGraph	(	self,
		event
	)

Definition at line 1020 of file smach_viewer.py.

def 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 707 of file smach_viewer.py.

def smach_viewer.SmachViewerFrame.selection_changed	(	self,
		event
	)

Event: Selection dropdown changed.

Definition at line 726 of file smach_viewer.py.

def smach_viewer.SmachViewerFrame.set_depth	(	self,
		event
	)

Event: Change the maximum depth and update the graph.

Definition at line 673 of file smach_viewer.py.

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

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

Definition at line 928 of file smach_viewer.py.

def smach_viewer.SmachViewerFrame.set_filter	(	self,
		filter
	)

Definition at line 1033 of file smach_viewer.py.

def smach_viewer.SmachViewerFrame.set_label_width	(	self,
		event
	)

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

Definition at line 685 of file smach_viewer.py.

def smach_viewer.SmachViewerFrame.set_path	(	self,
		event
	)

Event: Change the viewable path and update the graph.

Definition at line 661 of file smach_viewer.py.

def smach_viewer.SmachViewerFrame.ShowControlsDialog	(	self,
		event
	)

Definition at line 1014 of file smach_viewer.py.

def smach_viewer.SmachViewerFrame.toggle_all_transitions	(	self,
		event
	)

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

Definition at line 691 of file smach_viewer.py.

def smach_viewer.SmachViewerFrame.toggle_auto_focus	(	self,
		event
	)

Event: Enable/Disable automatically focusing

Definition at line 697 of file smach_viewer.py.

def smach_viewer.SmachViewerFrame.update_graph ( self )

Notify all that the graph needs to be updated.

Definition at line 647 of file smach_viewer.py.

Member Data Documentation

smach_viewer.SmachViewerFrame._auto_focus

private

Definition at line 540 of file smach_viewer.py.

smach_viewer.SmachViewerFrame._client

private

Definition at line 608 of file smach_viewer.py.

smach_viewer.SmachViewerFrame._containers

private

Definition at line 467 of file smach_viewer.py.

smach_viewer.SmachViewerFrame._keep_running

private

Definition at line 626 of file smach_viewer.py.

smach_viewer.SmachViewerFrame._label_wrapper

private

Definition at line 526 of file smach_viewer.py.

smach_viewer.SmachViewerFrame._max_depth

private

Definition at line 515 of file smach_viewer.py.

smach_viewer.SmachViewerFrame._needs_refresh

private

Definition at line 470 of file smach_viewer.py.

smach_viewer.SmachViewerFrame._needs_zoom

private

Definition at line 622 of file smach_viewer.py.

smach_viewer.SmachViewerFrame._path

private

Definition at line 621 of file smach_viewer.py.

smach_viewer.SmachViewerFrame._selected_paths

private

Definition at line 610 of file smach_viewer.py.

smach_viewer.SmachViewerFrame._server_list_thread

private

Definition at line 627 of file smach_viewer.py.

smach_viewer.SmachViewerFrame._show_all_transitions

private

Definition at line 533 of file smach_viewer.py.

smach_viewer.SmachViewerFrame._status_subs

private

Definition at line 614 of file smach_viewer.py.

smach_viewer.SmachViewerFrame._structure_changed

private

Definition at line 623 of file smach_viewer.py.

smach_viewer.SmachViewerFrame._structure_subs

private

Definition at line 613 of file smach_viewer.py.

smach_viewer.SmachViewerFrame._top_containers

private

Definition at line 468 of file smach_viewer.py.

smach_viewer.SmachViewerFrame._tree_nodes

private

Definition at line 947 of file smach_viewer.py.

smach_viewer.SmachViewerFrame._update_cond

private

Definition at line 469 of file smach_viewer.py.

smach_viewer.SmachViewerFrame._update_graph_thread

private

Definition at line 630 of file smach_viewer.py.

smach_viewer.SmachViewerFrame._update_tree_thread

private

Definition at line 632 of file smach_viewer.py.

smach_viewer.SmachViewerFrame.content_splitter

Definition at line 477 of file smach_viewer.py.

smach_viewer.SmachViewerFrame.depth_spinner

Definition at line 509 of file smach_viewer.py.

smach_viewer.SmachViewerFrame.dotstr

Definition at line 471 of file smach_viewer.py.

smach_viewer.SmachViewerFrame.is_button

Definition at line 586 of file smach_viewer.py.

smach_viewer.SmachViewerFrame.path_combo

Definition at line 502 of file smach_viewer.py.

smach_viewer.SmachViewerFrame.path_input

Definition at line 575 of file smach_viewer.py.

smach_viewer.SmachViewerFrame.statusbar

Definition at line 598 of file smach_viewer.py.

smach_viewer.SmachViewerFrame.tree

Definition at line 562 of file smach_viewer.py.

smach_viewer.SmachViewerFrame.ud_gs

Definition at line 571 of file smach_viewer.py.

smach_viewer.SmachViewerFrame.ud_txt

Definition at line 582 of file smach_viewer.py.

smach_viewer.SmachViewerFrame.ud_win

Definition at line 570 of file smach_viewer.py.

smach_viewer.SmachViewerFrame.widget

Definition at line 556 of file smach_viewer.py.

smach_viewer.SmachViewerFrame.width_spinner

Definition at line 520 of file smach_viewer.py.

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

smach_viewer.py

Private Attributes
	_auto_focus

	_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

Member Function Documentation

Member Data Documentation