$search

actionlib::action_client::ActionClient Class Reference

List of all members.

Public Member Functions

def __init__
 Constructs an ActionClient and opens connections to an ActionServer.
def cancel_all_goals
 Cancels all goals currently running on the action server.
def cancel_goals_at_and_before_time
 Cancels all goals prior to a given timestamp.
def send_goal
 Sends a goal to the action server.
def wait_for_action_server_to_start
 [Deprecated] Use wait_for_server
def wait_for_server
 Waits for the ActionServer to connect to this client.

Public Attributes

 ActionFeedback
 ActionGoal
 ActionResult
 ActionSpec
 feedback_sub
 last_status_msg
 manager
 ns
 pub_cancel
 pub_goal
 result_sub
 status_sub

Private Member Functions

def _feedback_cb
def _result_cb
def _status_cb

Detailed Description

Definition at line 493 of file action_client.py.


Member Function Documentation

def actionlib::action_client::ActionClient::__init__ (   self,
  ns,
  ActionSpec 
)

Constructs an ActionClient and opens connections to an ActionServer.

Parameters:
ns The namespace in which to access the action. For example, the "goal" topic should occur under ns/goal
ActionSpec The *Action message type. The ActionClient will grab the other message types from this type.

Definition at line 501 of file action_client.py.

def actionlib::action_client::ActionClient::_feedback_cb (   self,
  msg 
) [private]

Definition at line 617 of file action_client.py.

def actionlib::action_client::ActionClient::_result_cb (   self,
  msg 
) [private]

Definition at line 614 of file action_client.py.

def actionlib::action_client::ActionClient::_status_cb (   self,
  msg 
) [private]

Definition at line 610 of file action_client.py.

def actionlib::action_client::ActionClient::cancel_all_goals (   self  ) 

Cancels all goals currently running on the action server.

Preempts all goals running on the action server at the point that the cancel message is serviced by the action server.

Definition at line 547 of file action_client.py.

def actionlib::action_client::ActionClient::cancel_goals_at_and_before_time (   self,
  time 
)

Cancels all goals prior to a given timestamp.

This preempts all goals running on the action server for which the time stamp is earlier than the specified time stamp this message is serviced by the ActionServer.

Definition at line 558 of file action_client.py.

def actionlib::action_client::ActionClient::send_goal (   self,
  goal,
  transition_cb = None,
  feedback_cb = None 
)

Sends a goal to the action server.

Parameters:
goal An instance of the *Goal message.
transition_cb Callback that gets called on every client state transition for the sent goal. It should take in a ClientGoalHandle as an argument.
feedback_cb Callback that gets called every time feedback is received for the sent goal. It takes two parameters: a ClientGoalHandle and an instance of the *Feedback message.
Returns:
ClientGoalHandle for the sent goal.

Definition at line 540 of file action_client.py.

def actionlib::action_client::ActionClient::wait_for_action_server_to_start (   self,
  timeout = rospy.Duration(0.0) 
)

[Deprecated] Use wait_for_server

Definition at line 564 of file action_client.py.

def actionlib::action_client::ActionClient::wait_for_server (   self,
  timeout = rospy.Duration(0.0) 
)

Waits for the ActionServer to connect to this client.

Often, it can take a second for the action server & client to negotiate a connection, thus, risking the first few goals to be dropped. This call lets the user wait until the network connection to the server is negotiated

Definition at line 572 of file action_client.py.


Member Data Documentation

Definition at line 511 of file action_client.py.

Definition at line 509 of file action_client.py.

Definition at line 510 of file action_client.py.

Definition at line 508 of file action_client.py.

Definition at line 524 of file action_client.py.

Definition at line 503 of file action_client.py.

Definition at line 518 of file action_client.py.

Definition at line 502 of file action_client.py.

Definition at line 516 of file action_client.py.

Definition at line 515 of file action_client.py.

Definition at line 523 of file action_client.py.

Definition at line 522 of file action_client.py.


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Defines


actionlib
Author(s): Eitan Marder-Eppstein, Vijay Pradeep
autogenerated on Fri Mar 1 15:00:03 2013