Public Member Functions | Public Attributes | Private Member Functions
rcommander.tool_utils.ToolBase Class Reference

List of all members.

Public Member Functions

def __init__
def activate_cb
def clear_saved_state
def create_button
def create_node
def deselect_tool
def fill_connections_box
def fill_property_box
 Responsible for setting up graphical widgets allowing users to edit the parameters of an action.
def get_current_node_name
def get_smach_class
def new_node
 When called must return an instance of smach_class (an object which inherits from tool_utils.StateBase given in constructor).
def node_selected
def refresh_connections_box
def reset
 Resets the state of this GUI tool, sets all options to sensible defaults.
def set_loaded_node_name
def set_node_properties
 Called by parent when user selects a node created by this tool (of class smach_class).

Public Attributes

 button
 button_name
 counter
 loaded_node_name
 name
 name_input
 node_exists
 outcome_inputs
 rcommander
 saved_state
 smach_class

Private Member Functions

def _get_outcome_choices

Detailed Description

Definition at line 189 of file tool_utils.py.


Constructor & Destructor Documentation

def rcommander.tool_utils.ToolBase.__init__ (   self,
  rcommander,
  name,
  button_name,
  smach_class 
)

Definition at line 191 of file tool_utils.py.


Member Function Documentation

Definition at line 249 of file tool_utils.py.

def rcommander.tool_utils.ToolBase.activate_cb (   self,
  loaded_node_name = None 
)

Definition at line 213 of file tool_utils.py.

Definition at line 235 of file tool_utils.py.

def rcommander.tool_utils.ToolBase.create_button (   self,
  container 
)

Definition at line 208 of file tool_utils.py.

def rcommander.tool_utils.ToolBase.create_node (   self,
  unique = True 
)

Definition at line 337 of file tool_utils.py.

Definition at line 239 of file tool_utils.py.

Definition at line 276 of file tool_utils.py.

Responsible for setting up graphical widgets allowing users to edit the parameters of an action.

Called when users click on a node of the class smach_class (given in constructor) and whenever this tool is selected via its menu bar button.

Parameters:
pboxa QT widget with a FormLayout that can be filled with appropriate controls for this tool

Definition at line 372 of file tool_utils.py.

Definition at line 334 of file tool_utils.py.

Definition at line 360 of file tool_utils.py.

def rcommander.tool_utils.ToolBase.new_node (   self,
  name = None 
)

When called must return an instance of smach_class (an object which inherits from tool_utils.StateBase given in constructor).

Called with a name parameter when users click the big Add button, called with a name=None by the connections tab to find out how many outgoing connections this node has.

Returns:
a valid smach state derived from StateBase

Definition at line 384 of file tool_utils.py.

Definition at line 346 of file tool_utils.py.

Definition at line 255 of file tool_utils.py.

Resets the state of this GUI tool, sets all options to sensible defaults.

Called when users click the big Reset button.

Definition at line 399 of file tool_utils.py.

Definition at line 331 of file tool_utils.py.

Called by parent when user selects a node created by this tool (of class smach_class).

Parameters:
nodea State object created by this tool of class smach_class

Definition at line 392 of file tool_utils.py.


Member Data Documentation

Definition at line 191 of file tool_utils.py.

Definition at line 191 of file tool_utils.py.

Definition at line 191 of file tool_utils.py.

Definition at line 191 of file tool_utils.py.

Definition at line 191 of file tool_utils.py.

Definition at line 191 of file tool_utils.py.

Definition at line 191 of file tool_utils.py.

Definition at line 191 of file tool_utils.py.

Definition at line 191 of file tool_utils.py.

Definition at line 191 of file tool_utils.py.

Definition at line 191 of file tool_utils.py.


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


rcommander
Author(s): Hai Nguyen (haidai@gmail.com)
autogenerated on Thu Nov 28 2013 11:46:34