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

Public Member Functions

def __init__ (self, server_name, msg)
 
def get_dotcode (self, selected_paths, closed_paths, depth, max_depth, containers, show_all, label_wrapper, attrs={})
 
def update_status (self, msg)
 
def update_structure (self, msg)
 

Private Member Functions

def _load_local_data (self, msg)
 

Private Attributes

 _active_states
 
 _children
 
 _container_outcomes
 
 _dir
 
 _info
 
 _initial_states
 
 _internal_outcomes
 
 _label
 
 _last_active_states
 
 _local_data
 
 _outcomes_from
 
 _outcomes_to
 
 _path
 
 _server_name
 
 _structure_changed
 

Detailed Description

This class represents a given container in a running SMACH system.

Its primary use is to generate dotcode for a SMACH container. It has
methods for responding to structure and status messages from a SMACH
introspection server, as well as methods for updating the styles of a
graph once it's been drawn.

Definition at line 22 of file smach_viewer_base.py.

Constructor & Destructor Documentation

◆ __init__()

def smach_viewer.smach_viewer_base.ContainerNode.__init__ (   self,
  server_name,
  msg 
)

Definition at line 31 of file smach_viewer_base.py.

Member Function Documentation

◆ _load_local_data()

def smach_viewer.smach_viewer_base.ContainerNode._load_local_data (   self,
  msg 
)
private
Unpack the user data

Definition at line 74 of file smach_viewer_base.py.

◆ get_dotcode()

def smach_viewer.smach_viewer_base.ContainerNode.get_dotcode (   self,
  selected_paths,
  closed_paths,
  depth,
  max_depth,
  containers,
  show_all,
  label_wrapper,
  attrs = {} 
)
Generate the dotcode representing this container.

@param selected_paths: The paths to nodes that are selected
@closed paths: The paths that shouldn't be expanded
@param depth: The depth to start traversing the tree
@param max_depth: The depth to which we should traverse the tree
@param containers: A dict of containers keyed by their paths
@param show_all: True if implicit transitions should be shown
@param label_wrapper: A text wrapper for wrapping element names
@param attrs: A dict of dotcode attributes for this cluster

Definition at line 120 of file smach_viewer_base.py.

◆ update_status()

def smach_viewer.smach_viewer_base.ContainerNode.update_status (   self,
  msg 
)
Update the known userdata and active state set and return True if the graph needs to be redrawn.

Definition at line 85 of file smach_viewer_base.py.

◆ update_structure()

def smach_viewer.smach_viewer_base.ContainerNode.update_structure (   self,
  msg 
)
Update the structure of this container from a given message. Return True if anything changes.

Definition at line 53 of file smach_viewer_base.py.

Member Data Documentation

◆ _active_states

smach_viewer.smach_viewer_base.ContainerNode._active_states
private

Definition at line 48 of file smach_viewer_base.py.

◆ _children

smach_viewer.smach_viewer_base.ContainerNode._children
private

Definition at line 39 of file smach_viewer_base.py.

◆ _container_outcomes

smach_viewer.smach_viewer_base.ContainerNode._container_outcomes
private

Definition at line 44 of file smach_viewer_base.py.

◆ _dir

smach_viewer.smach_viewer_base.ContainerNode._dir
private

Definition at line 37 of file smach_viewer_base.py.

◆ _info

smach_viewer.smach_viewer_base.ContainerNode._info
private

Definition at line 51 of file smach_viewer_base.py.

◆ _initial_states

smach_viewer.smach_viewer_base.ContainerNode._initial_states
private

Definition at line 47 of file smach_viewer_base.py.

◆ _internal_outcomes

smach_viewer.smach_viewer_base.ContainerNode._internal_outcomes
private

Definition at line 40 of file smach_viewer_base.py.

◆ _label

smach_viewer.smach_viewer_base.ContainerNode._label
private

Definition at line 36 of file smach_viewer_base.py.

◆ _last_active_states

smach_viewer.smach_viewer_base.ContainerNode._last_active_states
private

Definition at line 49 of file smach_viewer_base.py.

◆ _local_data

smach_viewer.smach_viewer_base.ContainerNode._local_data
private

Definition at line 50 of file smach_viewer_base.py.

◆ _outcomes_from

smach_viewer.smach_viewer_base.ContainerNode._outcomes_from
private

Definition at line 41 of file smach_viewer_base.py.

◆ _outcomes_to

smach_viewer.smach_viewer_base.ContainerNode._outcomes_to
private

Definition at line 42 of file smach_viewer_base.py.

◆ _path

smach_viewer.smach_viewer_base.ContainerNode._path
private

Definition at line 34 of file smach_viewer_base.py.

◆ _server_name

smach_viewer.smach_viewer_base.ContainerNode._server_name
private

Definition at line 33 of file smach_viewer_base.py.

◆ _structure_changed

smach_viewer.smach_viewer_base.ContainerNode._structure_changed
private

Definition at line 93 of file smach_viewer_base.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