Action handle class. More...
Public Member Functions | |
| def | __init__ |
| Initializes the action handle. | |
| def | AppendNode |
| Appends a registered function to the graph. | |
| def | check_pause |
| Checks for pause. | |
| def | get_error_code |
| Gets the error code of an action handle. | |
| def | get_graph |
| 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_graph |
| 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 | |
| component_name | |
| error_code | |
| function_name | |
| graph_wait_list | |
| last_node | |
| level | |
| parameter_name | |
| parent_node | |
| parse | |
| state | |
| state_pub | |
| wait_log | |
Action handle class.
The action handle is used to implement asynchronous behaviour within the script.
Definition at line 85 of file action_handle.py.
| def action_handle::action_handle::__init__ | ( | self, | ||
| function_name, | ||||
| component_name, | ||||
| parameter_name, | ||||
| blocking, | ||||
| parse | ||||
| ) |
Initializes the action handle.
Definition at line 87 of file action_handle.py.
| def action_handle::action_handle::AppendNode | ( | self, | ||
blocking = True | ||||
| ) |
Appends a registered function to the graph.
Definition at line 191 of file action_handle.py.
| def action_handle::action_handle::check_pause | ( | self | ) |
Checks for pause.
Definition at line 131 of file action_handle.py.
| def action_handle::action_handle::get_error_code | ( | self | ) |
Gets the error code of an action handle.
Definition at line 164 of file action_handle.py.
| def action_handle::action_handle::get_graph | ( | self | ) |
Definition at line 106 of file action_handle.py.
| def action_handle::action_handle::get_state | ( | self | ) |
Gets the state of an action handle.
Definition at line 160 of file action_handle.py.
| def action_handle::action_handle::GetGraphstring | ( | self | ) |
Returns the graphstring.
Definition at line 168 of file action_handle.py.
| def action_handle::action_handle::GetLevel | ( | self, | ||
| function_name | ||||
| ) |
Gets level of function name.
Definition at line 177 of file action_handle.py.
| def action_handle::action_handle::PublishState | ( | self | ) |
Publishs the state of the action handle.
Definition at line 215 of file action_handle.py.
| def action_handle::action_handle::set_active | ( | self | ) |
Sets the execution state to active, if not paused.
Definition at line 121 of file action_handle.py.
| def action_handle::action_handle::set_client | ( | self, | ||
| client | ||||
| ) |
Sets the actionlib client.
Definition at line 117 of file action_handle.py.
| def action_handle::action_handle::set_failed | ( | self, | ||
| error_code | ||||
| ) |
Sets the execution state to failed.
Definition at line 151 of file action_handle.py.
| def action_handle::action_handle::set_graph | ( | self, | ||
| graph | ||||
| ) |
Definition at line 102 of file action_handle.py.
| def action_handle::action_handle::set_succeeded | ( | self | ) |
Sets the execution state to succeeded.
Definition at line 142 of file action_handle.py.
| def action_handle::action_handle::wait | ( | self, | ||
duration = None | ||||
| ) |
Handles wait.
This function is meant to be uses directly in the script.
| duration | Duration for timeout. |
Definition at line 235 of file action_handle.py.
| def action_handle::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.
| duration | Duration for timeout. | |
| logging | Enables or disables logging for this wait. |
Definition at line 259 of file action_handle.py.
| def action_handle::action_handle::wait_inside | ( | self, | ||
duration = None | ||||
| ) |
Handles inside wait.
This function is meant to be uses inside the simple_script_server.
| duration | Duration for timeout. |
Definition at line 246 of file action_handle.py.
Definition at line 95 of file action_handle.py.
Definition at line 118 of file action_handle.py.
Definition at line 92 of file action_handle.py.
Definition at line 89 of file action_handle.py.
Definition at line 91 of file action_handle.py.
Definition at line 203 of file action_handle.py.
Definition at line 205 of file action_handle.py.
Definition at line 97 of file action_handle.py.
Definition at line 93 of file action_handle.py.
Definition at line 88 of file action_handle.py.
Definition at line 96 of file action_handle.py.
Definition at line 94 of file action_handle.py.
Definition at line 98 of file action_handle.py.
Definition at line 90 of file action_handle.py.
