The SimpleActionServer implements a singe goal policy on top of the ActionServer class. More...
Public Member Functions | |
def | __del__ (self) |
def | __init__ (self, name, ActionSpec, execute_cb=None, auto_start=True) |
Constructor for a SimpleActionServer. More... | |
def | accept_new_goal (self) |
Accepts a new goal when one is available The status of this goal is set to active upon acceptance, and the status of any previously active goal is set to preempted. More... | |
def | executeLoop (self) |
Called from a separate thread to call blocking execute calls. More... | |
def | get_default_result (self) |
def | internal_goal_callback (self, goal) |
Callback for when the ActionServer receives a new goal and passes it on. More... | |
def | internal_preempt_callback (self, preempt) |
Callback for when the ActionServer receives a new preempt and passes it on. More... | |
def | is_active (self) |
Allows polling implementations to query about the status of the current goal. More... | |
def | is_new_goal_available (self) |
Allows polling implementations to query about the availability of a new goal. More... | |
def | is_preempt_requested (self) |
Allows polling implementations to query about preempt requests. More... | |
def | publish_feedback (self, feedback) |
Publishes feedback for a given goal. More... | |
def | register_goal_callback (self, cb) |
Allows users to register a callback to be invoked when a new goal is available. More... | |
def | register_preempt_callback (self, cb) |
Allows users to register a callback to be invoked when a new preempt request is available. More... | |
def | set_aborted (self, result=None, text="") |
Sets the status of the active goal to aborted. More... | |
def | set_preempted (self, result=None, text="") |
Sets the status of the active goal to preempted. More... | |
def | set_succeeded (self, result=None, text="") |
Sets the status of the active goal to succeeded. More... | |
def | start (self) |
Explicitly start the action server, used it auto_start is set to false. More... | |
The SimpleActionServer implements a singe goal policy on top of the ActionServer class.
The specification of the policy is as follows: only one goal can have an active status at a time, new goals preempt previous goals based on the stamp in their GoalID field (later goals preempt earlier ones), an explicit preempt goal preempts all goals with timestamps that are less than or equal to the stamp associated with the preempt, accepting a new goal implies successful preemption of any old goal and the status of the old goal will be change automatically to reflect this.
Definition at line 55 of file simple_action_server.py.
def actionlib.simple_action_server.SimpleActionServer.__init__ | ( | self, | |
name, | |||
ActionSpec, | |||
execute_cb = None , |
|||
auto_start = True |
|||
) |
Constructor for a SimpleActionServer.
name | A name for the action server |
execute_cb | Optional callback that gets called in a separate thread whenever a new goal is received, allowing users to have blocking callbacks. Adding an execute callback also deactivates the goalCallback. |
auto_start | A boolean value that tells the ActionServer wheteher or not to start publishing as soon as it comes up. THIS SHOULD ALWAYS BE SET TO FALSE TO AVOID RACE CONDITIONS and start() should be called after construction of the server. |
Definition at line 62 of file simple_action_server.py.
def actionlib.simple_action_server.SimpleActionServer.__del__ | ( | self | ) |
Definition at line 95 of file simple_action_server.py.
def actionlib.simple_action_server.SimpleActionServer.accept_new_goal | ( | self | ) |
Accepts a new goal when one is available The status of this goal is set to active upon acceptance, and the status of any previously active goal is set to preempted.
Preempts received for the new goal between checking if isNewGoalAvailable or invokation of a goal callback and the acceptNewGoal call will not trigger a preempt callback. This means, isPreemptReqauested should be called after accepting the goal even for callback-based implementations to make sure the new goal does not have a pending preempt request.
Definition at line 112 of file simple_action_server.py.
def actionlib.simple_action_server.SimpleActionServer.executeLoop | ( | self | ) |
Called from a separate thread to call blocking execute calls.
Definition at line 265 of file simple_action_server.py.
def actionlib.simple_action_server.SimpleActionServer.get_default_result | ( | self | ) |
Definition at line 177 of file simple_action_server.py.
def actionlib.simple_action_server.SimpleActionServer.internal_goal_callback | ( | self, | |
goal | |||
) |
Callback for when the ActionServer receives a new goal and passes it on.
Definition at line 207 of file simple_action_server.py.
def actionlib.simple_action_server.SimpleActionServer.internal_preempt_callback | ( | self, | |
preempt | |||
) |
Callback for when the ActionServer receives a new preempt and passes it on.
Definition at line 247 of file simple_action_server.py.
def actionlib.simple_action_server.SimpleActionServer.is_active | ( | self | ) |
Allows polling implementations to query about the status of the current goal.
Definition at line 149 of file simple_action_server.py.
def actionlib.simple_action_server.SimpleActionServer.is_new_goal_available | ( | self | ) |
Allows polling implementations to query about the availability of a new goal.
Definition at line 139 of file simple_action_server.py.
def actionlib.simple_action_server.SimpleActionServer.is_preempt_requested | ( | self | ) |
Allows polling implementations to query about preempt requests.
Definition at line 144 of file simple_action_server.py.
def actionlib.simple_action_server.SimpleActionServer.publish_feedback | ( | self, | |
feedback | |||
) |
Publishes feedback for a given goal.
feedback | Shared pointer to the feedback to publish |
Definition at line 174 of file simple_action_server.py.
def actionlib.simple_action_server.SimpleActionServer.register_goal_callback | ( | self, | |
cb | |||
) |
Allows users to register a callback to be invoked when a new goal is available.
cb | The callback to be invoked |
Definition at line 191 of file simple_action_server.py.
def actionlib.simple_action_server.SimpleActionServer.register_preempt_callback | ( | self, | |
cb | |||
) |
Allows users to register a callback to be invoked when a new preempt request is available.
cb | The callback to be invoked |
Definition at line 199 of file simple_action_server.py.
def actionlib.simple_action_server.SimpleActionServer.set_aborted | ( | self, | |
result = None , |
|||
text = "" |
|||
) |
Sets the status of the active goal to aborted.
result | An optional result to send back to any clients of the goal |
Definition at line 166 of file simple_action_server.py.
def actionlib.simple_action_server.SimpleActionServer.set_preempted | ( | self, | |
result = None , |
|||
text = "" |
|||
) |
Sets the status of the active goal to preempted.
result | An optional result to send back to any clients of the goal |
Definition at line 182 of file simple_action_server.py.
def actionlib.simple_action_server.SimpleActionServer.set_succeeded | ( | self, | |
result = None , |
|||
text = "" |
|||
) |
Sets the status of the active goal to succeeded.
result | An optional result to send back to any clients of the goal |
Definition at line 158 of file simple_action_server.py.
def actionlib.simple_action_server.SimpleActionServer.start | ( | self | ) |
Explicitly start the action server, used it auto_start is set to false.
Definition at line 203 of file simple_action_server.py.
actionlib.simple_action_server.SimpleActionServer.action_server |
Definition at line 93 of file simple_action_server.py.
actionlib.simple_action_server.SimpleActionServer.current_goal |
Definition at line 83 of file simple_action_server.py.
actionlib.simple_action_server.SimpleActionServer.execute_callback |
Definition at line 68 of file simple_action_server.py.
actionlib.simple_action_server.SimpleActionServer.execute_condition |
Definition at line 81 of file simple_action_server.py.
actionlib.simple_action_server.SimpleActionServer.execute_thread |
Definition at line 87 of file simple_action_server.py.
actionlib.simple_action_server.SimpleActionServer.goal_callback |
Definition at line 69 of file simple_action_server.py.
actionlib.simple_action_server.SimpleActionServer.lock |
Definition at line 79 of file simple_action_server.py.
actionlib.simple_action_server.SimpleActionServer.need_to_terminate |
Definition at line 72 of file simple_action_server.py.
actionlib.simple_action_server.SimpleActionServer.new_goal |
Definition at line 64 of file simple_action_server.py.
actionlib.simple_action_server.SimpleActionServer.new_goal_preempt_request |
Definition at line 66 of file simple_action_server.py.
actionlib.simple_action_server.SimpleActionServer.next_goal |
Definition at line 84 of file simple_action_server.py.
actionlib.simple_action_server.SimpleActionServer.preempt_callback |
Definition at line 70 of file simple_action_server.py.
actionlib.simple_action_server.SimpleActionServer.preempt_request |
Definition at line 65 of file simple_action_server.py.
actionlib.simple_action_server.SimpleActionServer.terminate_mutex |
Definition at line 73 of file simple_action_server.py.