simple_script_server.simple_script_server.action_handle Class Reference

Action handle class. More...

Public Member Functions
def	__init__ (self, function_name, component_name, parameter_name, blocking, parse)
	Initializes the action handle. More...
def	AppendNode (self, blocking=True)
	Appends a registered function to the graph. More...
def	cancel (self)
	Cancel action. More...
def	check_pause (self)
	Checks for pause. More...
def	get_error_code (self)
	Gets the error code of an action handle. More...
def	get_state (self)
	Gets the state of an action handle. More...
def	GetGraphstring (self)
	Returns the graphstring. More...
def	GetLevel (self, function_name)
	Gets level of function name. More...
def	PublishState (self)
	Publishs the state of the action handle. More...
def	set_active (self, mode="")
	Sets the execution state to active, if not paused. More...
def	set_client (self, client)
	Sets the actionlib client. More...
def	set_failed (self, error_code, message="")
	Sets the execution state to failed. More...
def	set_succeeded (self, message="")
	Sets the execution state to succeeded. More...
def	wait (self, duration=None)
	Handles wait. More...
def	wait_for_finished (self, duration, logging)
	Waits for the action to be finished. More...
def	wait_inside (self, duration=None)
	Handles inside wait. More...

Public Attributes
	blocking
	client
	client_mode
	client_state
	component_name
	error_code
	function_name
	level
	message
	parameter_name
	parent_node
	parse
	state
	state_pub
	success

Detailed Description

Action handle class.

The action handle is used to implement asynchronous behaviour within the script.

Definition at line 1461 of file simple_script_server.py.

Constructor & Destructor Documentation

def simple_script_server.simple_script_server.action_handle.__init__	(		self,
			function_name,
			component_name,
			parameter_name,
			blocking,
			parse
	)

Initializes the action handle.

Definition at line 1463 of file simple_script_server.py.

Member Function Documentation

def simple_script_server.simple_script_server.action_handle.AppendNode	(		self,
			blocking = True
	)

Appends a registered function to the graph.

Definition at line 1572 of file simple_script_server.py.

def simple_script_server.simple_script_server.action_handle.cancel

(

self

)

Cancel action.

Cancels action goal(s).

Definition at line 1679 of file simple_script_server.py.

def simple_script_server.simple_script_server.action_handle.check_pause

(

self

)

Checks for pause.

Definition at line 1500 of file simple_script_server.py.

def simple_script_server.simple_script_server.action_handle.get_error_code

(

self

)

Gets the error code of an action handle.

Definition at line 1546 of file simple_script_server.py.

def simple_script_server.simple_script_server.action_handle.get_state

(

self

)

Gets the state of an action handle.

Definition at line 1537 of file simple_script_server.py.

def simple_script_server.simple_script_server.action_handle.GetGraphstring

(

self

)

Returns the graphstring.

Definition at line 1550 of file simple_script_server.py.

def simple_script_server.simple_script_server.action_handle.GetLevel	(		self,
			function_name
	)

Gets level of function name.

Definition at line 1558 of file simple_script_server.py.

def simple_script_server.simple_script_server.action_handle.PublishState

(

self

)

Publishs the state of the action handle.

Definition at line 1594 of file simple_script_server.py.

def simple_script_server.simple_script_server.action_handle.set_active	(		self,
			mode = ""
	)

Sets the execution state to active, if not paused.

Definition at line 1487 of file simple_script_server.py.

def simple_script_server.simple_script_server.action_handle.set_client	(		self,
			client
	)

Sets the actionlib client.

Definition at line 1483 of file simple_script_server.py.

def simple_script_server.simple_script_server.action_handle.set_failed	(		self,
			error_code,
			message = ""
	)

Sets the execution state to failed.

Definition at line 1524 of file simple_script_server.py.

def simple_script_server.simple_script_server.action_handle.set_succeeded	(		self,
			message = ""
	)

Sets the execution state to succeeded.

Definition at line 1511 of file simple_script_server.py.

def simple_script_server.simple_script_server.action_handle.wait	(		self,
			duration = None
	)

Handles wait.

This function is meant to be uses directly in the script.

Parameters

duration

Duration for timeout.

Definition at line 1613 of file simple_script_server.py.

def simple_script_server.simple_script_server.action_handle.wait_for_finished	(		self,
			duration,
			logging
	)

Waits for the action to be finished.

If duration is specified, waits until action is finished or timeout is reached.

Parameters

duration	Duration for timeout.
logging	Enables or disables logging for this wait.

Definition at line 1637 of file simple_script_server.py.

def simple_script_server.simple_script_server.action_handle.wait_inside	(		self,
			duration = None
	)

Handles inside wait.

This function is meant to be uses inside the simple_script_server.

Parameters

duration

Duration for timeout.

Definition at line 1624 of file simple_script_server.py.

Member Data Documentation

simple_script_server.simple_script_server.action_handle.blocking

Definition at line 1473 of file simple_script_server.py.

simple_script_server.simple_script_server.action_handle.client

Definition at line 1478 of file simple_script_server.py.

simple_script_server.simple_script_server.action_handle.client_mode

Definition at line 1480 of file simple_script_server.py.

simple_script_server.simple_script_server.action_handle.client_state

Definition at line 1479 of file simple_script_server.py.

simple_script_server.simple_script_server.action_handle.component_name

Definition at line 1470 of file simple_script_server.py.

simple_script_server.simple_script_server.action_handle.error_code

Definition at line 1466 of file simple_script_server.py.

simple_script_server.simple_script_server.action_handle.function_name

Definition at line 1469 of file simple_script_server.py.

simple_script_server.simple_script_server.action_handle.level

Definition at line 1475 of file simple_script_server.py.

simple_script_server.simple_script_server.action_handle.message

Definition at line 1468 of file simple_script_server.py.

simple_script_server.simple_script_server.action_handle.parameter_name

Definition at line 1471 of file simple_script_server.py.

simple_script_server.simple_script_server.action_handle.parent_node

Definition at line 1465 of file simple_script_server.py.

simple_script_server.simple_script_server.action_handle.parse

Definition at line 1474 of file simple_script_server.py.

simple_script_server.simple_script_server.action_handle.state

Definition at line 1472 of file simple_script_server.py.

simple_script_server.simple_script_server.action_handle.state_pub

Definition at line 1476 of file simple_script_server.py.

simple_script_server.simple_script_server.action_handle.success

Definition at line 1467 of file simple_script_server.py.

---

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

• simple_script_server.py