simple_script_server.action_handle Class Reference

Action handle class. More...

List of all members.

Public Member Functions
def	__init__
	Initializes the action handle.
def	AppendNode
	Appends a registered function to the graph.
def	cancel
	Cancel action.
def	check_pause
	Checks for pause.
def	get_error_code
	Gets the error code of an action handle.
def	get_state
	Gets the state of an action handle.
def	GetGraphstring
	Returns the graphstring.
def	GetLevel
	Gets level of function name.
def	PublishState
	Publishs the state of the action handle.
def	set_active
	Sets the execution state to active, if not paused.
def	set_client
	Sets the actionlib client.
def	set_failed
	Sets the execution state to failed.
def	set_succeeded
	Sets the execution state to succeeded.
def	wait
	Handles wait.
def	wait_for_finished
	Waits for the action to be finished.
def	wait_inside
	Handles inside wait.
Public Attributes
	blocking
	client
	client_mode
	client_state
	component_name
	error_code
	function_counter
	function_name
	level
	parameter_name
	parent_node
	parse
	state
	state_pub
	wait_log

---

Detailed Description

Action handle class.

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

Definition at line 1045 of file simple_script_server.py.

---

Constructor & Destructor Documentation

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

Initializes the action handle.

Definition at line 1047 of file simple_script_server.py.

---

Member Function Documentation

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

Appends a registered function to the graph.

Definition at line 1151 of file simple_script_server.py.

def simple_script_server.action_handle.cancel

(

self

)

Cancel action.

Cancels action goal(s).

Definition at line 1259 of file simple_script_server.py.

def simple_script_server.action_handle.check_pause

(

self

)

Checks for pause.

Definition at line 1085 of file simple_script_server.py.

def simple_script_server.action_handle.get_error_code

(

self

)

Gets the error code of an action handle.

Definition at line 1125 of file simple_script_server.py.

def simple_script_server.action_handle.get_state

(

self

)

Gets the state of an action handle.

Definition at line 1118 of file simple_script_server.py.

def simple_script_server.action_handle.GetGraphstring

(

self

)

Returns the graphstring.

Definition at line 1129 of file simple_script_server.py.

def simple_script_server.action_handle.GetLevel	(		self,
			function_name
	)

Gets level of function name.

Definition at line 1137 of file simple_script_server.py.

def simple_script_server.action_handle.PublishState

(

self

)

Publishs the state of the action handle.

Definition at line 1175 of file simple_script_server.py.

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

Sets the execution state to active, if not paused.

Definition at line 1072 of file simple_script_server.py.

def simple_script_server.action_handle.set_client	(		self,
			client
	)

Sets the actionlib client.

Definition at line 1068 of file simple_script_server.py.

def simple_script_server.action_handle.set_failed	(		self,
			error_code
	)

Sets the execution state to failed.

Definition at line 1107 of file simple_script_server.py.

def simple_script_server.action_handle.set_succeeded

(

self

)

Sets the execution state to succeeded.

Definition at line 1096 of file simple_script_server.py.

def 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 1195 of file simple_script_server.py.

def 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 1219 of file simple_script_server.py.

def 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 1206 of file simple_script_server.py.

---

Member Data Documentation

simple_script_server.action_handle::blocking

Definition at line 1047 of file simple_script_server.py.

simple_script_server.action_handle::client

Definition at line 1047 of file simple_script_server.py.

simple_script_server.action_handle::client_mode

Definition at line 1047 of file simple_script_server.py.

simple_script_server.action_handle::client_state

Definition at line 1047 of file simple_script_server.py.

simple_script_server.action_handle::component_name

Definition at line 1047 of file simple_script_server.py.

simple_script_server.action_handle::error_code

Definition at line 1047 of file simple_script_server.py.

simple_script_server.action_handle::function_counter

Definition at line 1047 of file simple_script_server.py.

simple_script_server.action_handle::function_name

Definition at line 1047 of file simple_script_server.py.

simple_script_server.action_handle::level

Definition at line 1047 of file simple_script_server.py.

simple_script_server.action_handle::parameter_name

Definition at line 1047 of file simple_script_server.py.

simple_script_server.action_handle::parent_node

Definition at line 1047 of file simple_script_server.py.

simple_script_server.action_handle::parse

Definition at line 1047 of file simple_script_server.py.

simple_script_server.action_handle::state

Definition at line 1047 of file simple_script_server.py.

simple_script_server.action_handle::state_pub

Definition at line 1047 of file simple_script_server.py.

simple_script_server.action_handle::wait_log

Definition at line 1047 of file simple_script_server.py.

---

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

• simple_script_server.py