On this page

GetAvailableStatesServiceClient QML Type

Qt service client for the GetAvailableStates ROS 2 service. More...

Import Statement: import QtRos2.LifecycleMsgs
Inherits:

ServiceClientBase

Status: Experimental Extension

Properties

  • response : QList<Qtros2LifecycleMsgs::State>

Signals

Methods

Detailed Description

GetAvailableStatesServiceClient calls a ROS 2 service. Set the topic and node properties, then call callService() to invoke the service.

Property Documentation

response : QList<Qtros2LifecycleMsgs::State>

The most recent response received from the service, whether the call was made via callService(). Holds a default-constructed value until the first response arrives. Updated just before responseReceived is emitted.

Signal Documentation

callFailed(string error)

Emitted when the service call fails. error contains the error message.

Note: The corresponding handler is onCallFailed.

responseReceived(QList<Qtros2LifecycleMsgs::State> response)

Emitted when the service call completes successfully. response is a QList<Qtros2LifecycleMsgs::State> value.

Note: The corresponding handler is onResponseReceived.

Method Documentation

QJSValue callService()

Calls the GetAvailableStates ROS 2 service. Returns a JS promise that resolves with a QList<Qtros2LifecycleMsgs::State> response or rejects with an error string. isServiceReady must be true before calling.

© 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.