rcommander.tool_utils.StateBase Class Reference

Inheritance diagram for rcommander.tool_utils.StateBase:

List of all members.

Public Member Functions
def	__init__
	Base construction for a state.
def	get_name
	Gets the name of this object.
def	get_smach_state
	Returns an object that implements smach.State, needed by RCommander to create the final state machine.
def	is_runnable
	Checks to see whether this node is executable.
def	output_names
	Returns a list of names of all declared outputs variables (same as the output variables in SMACH).
def	output_type
	Gives the type (class) of output with the given name.
def	remapping_for
	Gets the name of an output variable of another node in the state machine that maps to the input var_name in this node.
def	set_name
	Sets the name of this action, used when user sets name in the GUI's Connections tab.
def	set_remapping_for
	Sets the name of an output variable of another node in the state machine that maps to the input var_name in this node.
def	set_runnable
	Identifies whether this node is executable or not (almost always this should be True.
Public Attributes
	name
	outputs
	remapping
	runnable

---

Detailed Description

Definition at line 403 of file tool_utils.py.

---

Constructor & Destructor Documentation

def rcommander.tool_utils.StateBase.__init__	(		self,
			name,
			outputs = {}
	)

Base construction for a state.

Parameters:

name	name of this state
outputs	a dictionary mapping names (strings) to Python classes.

Reimplemented in rcommander.tool_utils.EmbeddableState.

Definition at line 410 of file tool_utils.py.

---

Member Function Documentation

def rcommander.tool_utils.StateBase.get_name

(

self

)

Gets the name of this object.

Definition at line 442 of file tool_utils.py.

def rcommander.tool_utils.StateBase.get_smach_state

(

self

)

Returns an object that implements smach.State, needed by RCommander to create the final state machine.

Reimplemented in rcommander.tool_utils.SimpleStateBase, and rcommander.tool_utils.EmptyState.

Definition at line 480 of file tool_utils.py.

def rcommander.tool_utils.StateBase.is_runnable

(

self

)

Checks to see whether this node is executable.

Definition at line 465 of file tool_utils.py.

def rcommander.tool_utils.StateBase.output_names

(

self

)

Returns a list of names of all declared outputs variables (same as the output variables in SMACH).

Definition at line 420 of file tool_utils.py.

def rcommander.tool_utils.StateBase.output_type	(		self,
			name
	)

Gives the type (class) of output with the given name.

Used by RCommander to match node's input with other node's outputs.

Parameters:

name	string, name of output whose class we are interested in.

Definition at line 428 of file tool_utils.py.

def rcommander.tool_utils.StateBase.remapping_for	(		self,
			var_name
	)

Gets the name of an output variable of another node in the state machine that maps to the input var_name in this node.

Parameters:

var_name

an input variable for this state

Definition at line 450 of file tool_utils.py.

def rcommander.tool_utils.StateBase.set_name	(		self,
			name
	)

Sets the name of this action, used when user sets name in the GUI's Connections tab.

Parameters:

name

string

Definition at line 436 of file tool_utils.py.

def rcommander.tool_utils.StateBase.set_remapping_for	(		self,
			var,
			remapped
	)

Sets the name of an output variable of another node in the state machine that maps to the input var_name in this node.

Parameters:

var	input variable for this node.
remapped	output variable of another node.

Definition at line 459 of file tool_utils.py.

def rcommander.tool_utils.StateBase.set_runnable	(		self,
			v
	)

Identifies whether this node is executable or not (almost always this should be True.

Parameters:

v	boolean value

Definition at line 473 of file tool_utils.py.

---

Member Data Documentation

rcommander::tool_utils.StateBase::name

Definition at line 410 of file tool_utils.py.

rcommander::tool_utils.StateBase::outputs

Definition at line 410 of file tool_utils.py.

rcommander::tool_utils.StateBase::remapping

Definition at line 410 of file tool_utils.py.

rcommander::tool_utils.StateBase::runnable

Definition at line 410 of file tool_utils.py.

---

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

• tool_utils.py