Public Member Functions | Public Attributes | Private Member Functions | Private Attributes | Static Private Attributes | List of all members
smach_viewer.SmachViewerFrame Class Reference
Inheritance diagram for smach_viewer.SmachViewerFrame:
Inheritance graph
[legend]

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 OnTimer (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 Member Functions inherited from smach_viewer.smach_viewer_base.SmachViewerBase
def kill (self)
 

Public Attributes

 content_splitter
 
 depth_spinner
 
 is_button
 
 path_combo
 
 path_input
 
 statusbar
 
 timer
 
 tree
 
 ud_gs
 
 ud_txt
 
 ud_win
 
 widget
 
 width_spinner
 
- Public Attributes inherited from smach_viewer.smach_viewer_base.SmachViewerBase
 dotstr
 

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_step (self)
 
def _update_tree (self)
 

Private Attributes

 _auto_focus
 
 _max_depth
 
 _needs_refresh
 
 _needs_zoom
 
 _path
 
 _pub
 
 _selected_paths
 
 _show_all_transitions
 
 _structure_changed
 
 _tree_nodes
 
 _update_tree_thread
 

Static Private Attributes

 _container_class = WxContainerNode
 

Detailed Description

This class provides a GUI application for viewing SMACH plans.

Definition at line 207 of file smach_viewer.py.

Constructor & Destructor Documentation

◆ __init__()

def smach_viewer.SmachViewerFrame.__init__ (   self)

Reimplemented from smach_viewer.smach_viewer_base.SmachViewerBase.

Definition at line 214 of file smach_viewer.py.

Member Function Documentation

◆ _set_max_depth()

def smach_viewer.SmachViewerFrame._set_max_depth (   self,
  max_depth 
)
private

Definition at line 408 of file smach_viewer.py.

◆ _set_path()

def smach_viewer.SmachViewerFrame._set_path (   self,
  path 
)
private

Definition at line 396 of file smach_viewer.py.

◆ _status_msg_update()

def smach_viewer.SmachViewerFrame._status_msg_update (   self,
  msg 
)
private
Process status messages.

Reimplemented from smach_viewer.smach_viewer_base.SmachViewerBase.

Definition at line 522 of file smach_viewer.py.

◆ _structure_msg_update()

def smach_viewer.SmachViewerFrame._structure_msg_update (   self,
  msg,
  server_name 
)
private
Update the structure of the SMACH plan (re-generate the dotcode).

Reimplemented from smach_viewer.smach_viewer_base.SmachViewerBase.

Definition at line 509 of file smach_viewer.py.

◆ _update_graph_step()

def smach_viewer.SmachViewerFrame._update_graph_step (   self)
private

Reimplemented from smach_viewer.smach_viewer_base.SmachViewerBase.

Definition at line 548 of file smach_viewer.py.

◆ _update_tree()

def smach_viewer.SmachViewerFrame._update_tree (   self)
private
Update the tree view.

Definition at line 593 of file smach_viewer.py.

◆ add_to_tree()

def smach_viewer.SmachViewerFrame.add_to_tree (   self,
  path,
  parent 
)
Add a path to the tree view.

Definition at line 603 of file smach_viewer.py.

◆ append_tree()

def smach_viewer.SmachViewerFrame.append_tree (   self,
  container,
  parent = None 
)
Append an item to the tree view.

Definition at line 618 of file smach_viewer.py.

◆ on_set_initial_state()

def smach_viewer.SmachViewerFrame.on_set_initial_state (   self,
  event 
)
Event: Change the initial state of the server.

Definition at line 381 of file smach_viewer.py.

◆ OnExit()

def smach_viewer.SmachViewerFrame.OnExit (   self,
  event 
)

Definition at line 673 of file smach_viewer.py.

◆ OnIdle()

def smach_viewer.SmachViewerFrame.OnIdle (   self,
  event 
)
Event: On Idle, refresh the display if necessary, then un-set the flag.

Definition at line 625 of file smach_viewer.py.

◆ OnQuit()

def smach_viewer.SmachViewerFrame.OnQuit (   self,
  event 
)
Quit Event: kill threads and wait for join.

Definition at line 370 of file smach_viewer.py.

◆ OnTimer()

def smach_viewer.SmachViewerFrame.OnTimer (   self,
  event 
)

Definition at line 632 of file smach_viewer.py.

◆ SaveDotGraph()

def smach_viewer.SmachViewerFrame.SaveDotGraph (   self,
  event 
)

Definition at line 663 of file smach_viewer.py.

◆ select_cb()

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

◆ selection_changed()

def smach_viewer.SmachViewerFrame.selection_changed (   self,
  event 
)
Event: Selection dropdown changed.

Definition at line 458 of file smach_viewer.py.

◆ set_depth()

def smach_viewer.SmachViewerFrame.set_depth (   self,
  event 
)
Event: Change the maximum depth and update the graph.

Definition at line 402 of file smach_viewer.py.

◆ set_dotcode()

def smach_viewer.SmachViewerFrame.set_dotcode (   self,
  dotcode,
  zoom = True 
)
Set the xdot view's dotcode and refresh the display.

Definition at line 580 of file smach_viewer.py.

◆ set_filter()

def smach_viewer.SmachViewerFrame.set_filter (   self,
  filter 
)

Definition at line 676 of file smach_viewer.py.

◆ set_label_width()

def smach_viewer.SmachViewerFrame.set_label_width (   self,
  event 
)
Event: Change the label wrapper width and update the graph.

Definition at line 414 of file smach_viewer.py.

◆ set_path()

def smach_viewer.SmachViewerFrame.set_path (   self,
  event 
)
Event: Change the viewable path and update the graph.

Definition at line 390 of file smach_viewer.py.

◆ ShowControlsDialog()

def smach_viewer.SmachViewerFrame.ShowControlsDialog (   self,
  event 
)

Definition at line 657 of file smach_viewer.py.

◆ toggle_all_transitions()

def smach_viewer.SmachViewerFrame.toggle_all_transitions (   self,
  event 
)
Event: Change whether automatic transitions are hidden and update the graph.

Definition at line 420 of file smach_viewer.py.

◆ toggle_auto_focus()

def smach_viewer.SmachViewerFrame.toggle_auto_focus (   self,
  event 
)
Event: Enable/Disable automatically focusing

Definition at line 426 of file smach_viewer.py.

◆ update_graph()

def smach_viewer.SmachViewerFrame.update_graph (   self)
Notify all that the graph needs to be updated.

Definition at line 376 of file smach_viewer.py.

Member Data Documentation

◆ _auto_focus

smach_viewer.SmachViewerFrame._auto_focus
private

Definition at line 279 of file smach_viewer.py.

◆ _container_class

smach_viewer.SmachViewerFrame._container_class = WxContainerNode
staticprivate

Definition at line 212 of file smach_viewer.py.

◆ _max_depth

smach_viewer.SmachViewerFrame._max_depth
private

Definition at line 404 of file smach_viewer.py.

◆ _needs_refresh

smach_viewer.SmachViewerFrame._needs_refresh
private

Definition at line 590 of file smach_viewer.py.

◆ _needs_zoom

smach_viewer.SmachViewerFrame._needs_zoom
private

Definition at line 393 of file smach_viewer.py.

◆ _path

smach_viewer.SmachViewerFrame._path
private

Definition at line 392 of file smach_viewer.py.

◆ _pub

smach_viewer.SmachViewerFrame._pub
private

Definition at line 352 of file smach_viewer.py.

◆ _selected_paths

smach_viewer.SmachViewerFrame._selected_paths
private

Definition at line 450 of file smach_viewer.py.

◆ _show_all_transitions

smach_viewer.SmachViewerFrame._show_all_transitions
private

Definition at line 422 of file smach_viewer.py.

◆ _structure_changed

smach_viewer.SmachViewerFrame._structure_changed
private

Definition at line 423 of file smach_viewer.py.

◆ _tree_nodes

smach_viewer.SmachViewerFrame._tree_nodes
private

Definition at line 599 of file smach_viewer.py.

◆ _update_tree_thread

smach_viewer.SmachViewerFrame._update_tree_thread
private

Definition at line 361 of file smach_viewer.py.

◆ content_splitter

smach_viewer.SmachViewerFrame.content_splitter

Definition at line 220 of file smach_viewer.py.

◆ depth_spinner

smach_viewer.SmachViewerFrame.depth_spinner

Definition at line 251 of file smach_viewer.py.

◆ is_button

smach_viewer.SmachViewerFrame.is_button

Definition at line 331 of file smach_viewer.py.

◆ path_combo

smach_viewer.SmachViewerFrame.path_combo

Definition at line 244 of file smach_viewer.py.

◆ path_input

smach_viewer.SmachViewerFrame.path_input

Definition at line 320 of file smach_viewer.py.

◆ statusbar

smach_viewer.SmachViewerFrame.statusbar

Definition at line 343 of file smach_viewer.py.

◆ timer

smach_viewer.SmachViewerFrame.timer

Definition at line 365 of file smach_viewer.py.

◆ tree

smach_viewer.SmachViewerFrame.tree

Definition at line 307 of file smach_viewer.py.

◆ ud_gs

smach_viewer.SmachViewerFrame.ud_gs

Definition at line 316 of file smach_viewer.py.

◆ ud_txt

smach_viewer.SmachViewerFrame.ud_txt

Definition at line 327 of file smach_viewer.py.

◆ ud_win

smach_viewer.SmachViewerFrame.ud_win

Definition at line 315 of file smach_viewer.py.

◆ widget

smach_viewer.SmachViewerFrame.widget

Definition at line 301 of file smach_viewer.py.

◆ width_spinner

smach_viewer.SmachViewerFrame.width_spinner

Definition at line 261 of file smach_viewer.py.


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


smach_viewer
Author(s): Jonathan Bohren
autogenerated on Thu Feb 20 2025 03:09:09