Public Member Functions | Public Attributes
simple_script_server.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_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 1138 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 1140 of file simple_script_server.py.


Member Function Documentation

Appends a registered function to the graph.

Definition at line 1249 of file simple_script_server.py.

Cancel action.

Cancels action goal(s).

Definition at line 1356 of file simple_script_server.py.

Checks for pause.

Definition at line 1177 of file simple_script_server.py.

Gets the error code of an action handle.

Definition at line 1223 of file simple_script_server.py.

Gets the state of an action handle.

Definition at line 1214 of file simple_script_server.py.

Returns the graphstring.

Definition at line 1227 of file simple_script_server.py.

Gets level of function name.

Definition at line 1235 of file simple_script_server.py.

Publishs the state of the action handle.

Definition at line 1271 of file simple_script_server.py.

Sets the execution state to active, if not paused.

Definition at line 1164 of file simple_script_server.py.

Sets the actionlib client.

Definition at line 1160 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 1201 of file simple_script_server.py.

Sets the execution state to succeeded.

Definition at line 1188 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:
durationDuration for timeout.

Definition at line 1290 of file simple_script_server.py.

Waits for the action to be finished.

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

Parameters:
durationDuration for timeout.
loggingEnables or disables logging for this wait.

Definition at line 1314 of file simple_script_server.py.

Handles inside wait.

This function is meant to be uses inside the simple_script_server.

Parameters:
durationDuration for timeout.

Definition at line 1301 of file simple_script_server.py.


Member Data Documentation

Definition at line 1140 of file simple_script_server.py.

Definition at line 1140 of file simple_script_server.py.

Definition at line 1140 of file simple_script_server.py.

Definition at line 1140 of file simple_script_server.py.

Definition at line 1140 of file simple_script_server.py.

Definition at line 1140 of file simple_script_server.py.

Definition at line 1140 of file simple_script_server.py.

Definition at line 1140 of file simple_script_server.py.

Definition at line 1140 of file simple_script_server.py.

Definition at line 1140 of file simple_script_server.py.

Definition at line 1140 of file simple_script_server.py.

Definition at line 1140 of file simple_script_server.py.

Definition at line 1140 of file simple_script_server.py.

Definition at line 1140 of file simple_script_server.py.

Definition at line 1140 of file simple_script_server.py.


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


cob_script_server
Author(s): Florian Weisshardt
autogenerated on Sun Jun 9 2019 20:20:12