ActionClientBase QML Type

Abstract base for all generated ROS 2 action client types. More...

Import Statement:	`import QtRos2.Core`
Inherits:	Entity
Inherited By:	LookupTransformActionClient
Status:	Experimental Extension

List of all members, including inherited members

Properties

isServerReady : bool
state : int

Methods

void cancelGoal()

Detailed Description

ActionClientBase is not creatable directly. Use a generated action client type.

Property Documentation

isServerReady : bool

true when the action server is available on topic.

state : int

The current action state as a ActionClientBase.ActionState enum value:

ActionClientBase.Idle — no active goal
ActionClientBase.Requested — goal sent, awaiting acceptance
ActionClientBase.Accepted — goal accepted by the server
ActionClientBase.Rejected — goal was rejected
ActionClientBase.Canceled — goal was canceled
ActionClientBase.Succeeded — goal completed successfully
ActionClientBase.Aborted — server aborted the goal

Method Documentation

void cancelGoal()

Requests cancellation of the currently active goal. Has no effect when state is ActionClientBase.Idle.

© 2026 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.