actionlib.server_goal_handle.ServerGoalHandle Class Reference

Public Member Functions
def	__eq__ (self, other)
def	__hash__ (self)
def	__init__ (self, status_tracker=None, action_server=None, handle_tracker=None)
def	__ne__ (self, other)
def	get_default_result (self)
def	get_goal (self)
def	get_goal_id (self)
def	get_goal_status (self)
def	publish_feedback (self, feedback)
def	set_aborted (self, result=None, text="")
def	set_accepted (self, text="")
def	set_cancel_requested (self)
def	set_canceled (self, result=None, text="")
def	set_rejected (self, result=None, text="")
def	set_succeeded (self, result=None, text="")

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 transitions on. All ROS interfaces for the goal are managed by
* the ActionServer to lessen the burden on the user.

Definition at line 35 of file server_goal_handle.py.

Constructor & Destructor Documentation

__init__()

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 44 of file server_goal_handle.py.

Member Function Documentation

__eq__()

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 256 of file server_goal_handle.py.

__hash__()

def actionlib.server_goal_handle.ServerGoalHandle.__hash__

(

self

)

hash function for ServerGoalHandles
@return hash of the goal ID

Definition at line 282 of file server_goal_handle.py.

__ne__()

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 269 of file server_goal_handle.py.

get_default_result()

def actionlib.server_goal_handle.ServerGoalHandle.get_default_result

(

self

)

Definition at line 58 of file server_goal_handle.py.

get_goal()

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 217 of file server_goal_handle.py.

get_goal_id()

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 232 of file server_goal_handle.py.

get_goal_status()

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 244 of file server_goal_handle.py.

publish_feedback()

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 204 of file server_goal_handle.py.

set_aborted()

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 151 of file server_goal_handle.py.

set_accepted()

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 61 of file server_goal_handle.py.

set_cancel_requested()

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 289 of file server_goal_handle.py.

set_canceled()

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 91 of file server_goal_handle.py.

set_rejected()

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 125 of file server_goal_handle.py.

set_succeeded()

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 177 of file server_goal_handle.py.

Member Data Documentation

action_server

actionlib.server_goal_handle.ServerGoalHandle.action_server

Definition at line 50 of file server_goal_handle.py.

goal

actionlib.server_goal_handle.ServerGoalHandle.goal

Definition at line 54 of file server_goal_handle.py.

handle_tracker

actionlib.server_goal_handle.ServerGoalHandle.handle_tracker

Definition at line 51 of file server_goal_handle.py.

status_tracker

actionlib.server_goal_handle.ServerGoalHandle.status_tracker

Definition at line 49 of file server_goal_handle.py.

---

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

• server_goal_handle.py