actionlib::server_goal_handle::ServerGoalHandle Class Reference

List of all members.

Public Member Functions

def __eq__
def __init__
def __ne__
def get_default_result
def get_goal
def get_goal_id
def get_goal_status
def publish_feedback
def set_aborted
def set_accepted
def set_cancel_requested
def set_canceled
def set_rejected
def set_succeeded

Public Attributes

 action_server
 goal
 handle_tracker
 status_tracker

Detailed Description

* @class ServerGoalHandle
* @brief Encapsulates a state machine for a given goal that the user can
* trigger transisions on. All ROS interfaces for the goal are managed by
* the ActionServer to lessen the burden on the user.

Definition at line 37 of file server_goal_handle.py.


Member Function Documentation

def actionlib::server_goal_handle::ServerGoalHandle::__eq__ (   self,
  other 
)
Equals operator for ServerGoalHandles
@param other The ServerGoalHandle to compare to
@return True if the ServerGoalHandles refer to the same goal, false otherwise

Definition at line 268 of file server_goal_handle.py.

def actionlib::server_goal_handle::ServerGoalHandle::__init__ (   self,
  status_tracker = None,
  action_server = None,
  handle_tracker = None 
)
A private constructor used by the ActionServer to initialize a ServerGoalHandle.
@node  The default constructor was not ported.

Definition at line 46 of file server_goal_handle.py.

def actionlib::server_goal_handle::ServerGoalHandle::__ne__ (   self,
  other 
)
!= operator for ServerGoalHandles
@param other The ServerGoalHandle to compare to
@return True if the ServerGoalHandles refer to different goals, false otherwise

Definition at line 281 of file server_goal_handle.py.

def actionlib::server_goal_handle::ServerGoalHandle::get_default_result (   self  ) 

Definition at line 61 of file server_goal_handle.py.

def actionlib::server_goal_handle::ServerGoalHandle::get_goal (   self  ) 
Accessor for the goal associated with the ServerGoalHandle
@return A shared_ptr to the goal object

Definition at line 226 of file server_goal_handle.py.

def actionlib::server_goal_handle::ServerGoalHandle::get_goal_id (   self  ) 
Accessor for the goal id associated with the ServerGoalHandle
@return The goal id

Definition at line 242 of file server_goal_handle.py.

def actionlib::server_goal_handle::ServerGoalHandle::get_goal_status (   self  ) 
Accessor for the status associated with the ServerGoalHandle
@return The goal status

Definition at line 255 of file server_goal_handle.py.

def actionlib::server_goal_handle::ServerGoalHandle::publish_feedback (   self,
  feedback 
)
Send feedback to any clients of the goal associated with this ServerGoalHandle
@param feedback The feedback to send to the client

Definition at line 212 of file server_goal_handle.py.

def actionlib::server_goal_handle::ServerGoalHandle::set_aborted (   self,
  result = None,
  text = "" 
)
Set the status of the goal associated with the ServerGoalHandle to aborted
@param  result Optionally, the user can pass in a result to be sent to any clients of the goal

Definition at line 157 of file server_goal_handle.py.

def actionlib::server_goal_handle::ServerGoalHandle::set_accepted (   self,
  text = "" 
)
Accept the goal referenced by the goal handle. This will
transition to the ACTIVE state or the PREEMPTING state depending
on whether a cancel request has been received for the goal

Definition at line 64 of file server_goal_handle.py.

def actionlib::server_goal_handle::ServerGoalHandle::set_cancel_requested (   self  ) 
A private method to set status to PENDING or RECALLING
@return True if the cancel request should be passed on to the user, false otherwise

Definition at line 295 of file server_goal_handle.py.

def actionlib::server_goal_handle::ServerGoalHandle::set_canceled (   self,
  result = None,
  text = "" 
)
Set the status of the goal associated with the ServerGoalHandle to RECALLED or PREEMPTED
depending on what the current status of the goal is
@param  result Optionally, the user can pass in a result to be sent to any clients of the goal

Definition at line 95 of file server_goal_handle.py.

def actionlib::server_goal_handle::ServerGoalHandle::set_rejected (   self,
  result = None,
  text = "" 
)
* @brief  Set the status of the goal associated with the ServerGoalHandle to rejected
* @param  result Optionally, the user can pass in a result to be sent to any clients of the goal

Definition at line 130 of file server_goal_handle.py.

def actionlib::server_goal_handle::ServerGoalHandle::set_succeeded (   self,
  result = None,
  text = "" 
)
Set the status of the goal associated with the ServerGoalHandle to succeeded
@param  result Optionally, the user can pass in a result to be sent to any clients of the goal

Definition at line 184 of file server_goal_handle.py.


Member Data Documentation

Definition at line 52 of file server_goal_handle.py.

Definition at line 56 of file server_goal_handle.py.

Definition at line 53 of file server_goal_handle.py.

Definition at line 51 of file server_goal_handle.py.


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


actionlib
Author(s): Eitan Marder-Eppstein, Vijay Pradeep
autogenerated on Fri Jan 11 09:41:44 2013