Class: ActionClient

ActionClient(options)

new ActionClient(options)

An actionlib action client.

Emits the following events:

  • 'timeout' - If a timeout occurred while sending a goal.
  • 'status' - The status messages received from the action server.
  • 'feedback' - The feedback messages received from the action server.
  • 'result' - The result returned from the action server.
Parameters:
Name Type Description
options Object
Properties
Name Type Attributes Description
ros Ros

The ROSLIB.Ros connection handle.
serverName string

The action server name, like '/fibonacci'.
actionName string

The action message name, like 'actionlib_tutorials/FibonacciAction'.
timeout number <optional>

The timeout length when connecting to the action server.
omitFeedback boolean <optional>

The flag to indicate whether to omit the feedback channel or not.
omitStatus boolean <optional>

The flag to indicate whether to omit the status channel or not.
omitResult boolean <optional>

The flag to indicate whether to omit the result channel or not.
Source:

Methods

cancel()

Cancel all goals associated with this ActionClient.

Source:

dispose()

Unsubscribe and unadvertise all topics associated with this ActionClient.

Source: