action_msgs/srv/CancelGoal Service

File: action_msgs/srv/CancelGoal.msg

Raw Message Definition

# Cancel one or more goals with the following policy:

#

# - If the goal ID is zero and timestamp is zero, cancel all goals.

# - If the goal ID is zero and timestamp is not zero, cancel all goals accepted

# at or before the timestamp.

# - If the goal ID is not zero and timestamp is zero, cancel the goal with the

# given ID regardless of the time it was accepted.

# - If the goal ID is not zero and timestamp is not zero, cancel the goal with

# the given ID and all goals accepted at or before the timestamp.


# Goal info describing the goals to cancel, see above.

GoalInfo goal_info
---
#

# Return codes.

#


# Indicates the request was accepted without any errors.

#

# One or more goals have transitioned to the CANCELING state. The

# goals_canceling list is not empty.

int8 ERROR_NONE=0

# Indicates the request was rejected.

#

# No goals have transitioned to the CANCELING state. The goals_canceling list is

# empty.

int8 ERROR_REJECTED=1

# Indicates the requested goal ID does not exist.

#

# No goals have transitioned to the CANCELING state. The goals_canceling list is

# empty.

int8 ERROR_UNKNOWN_GOAL_ID=2

# Indicates the goal is not cancelable because it is already in a terminal state.

#

# No goals have transitioned to the CANCELING state. The goals_canceling list is

# empty.

int8 ERROR_GOAL_TERMINATED=3

# Return code, see above definitions.

int8 return_code

# Goals that accepted the cancel request.

GoalInfo[] goals_canceling

Compact Message Definition

int8 ERROR_NONE=0
int8 ERROR_REJECTED=1
int8 ERROR_UNKNOWN_GOAL_ID=2
int8 ERROR_GOAL_TERMINATED=3
int8 return_code
action_msgs/msg/GoalInfo[] goals_canceling

action_msgs/msg/GoalInfo goal_info