ListParametersServiceClient QML Type
Qt service client for the ListParameters ROS 2 service. More...
| Import Statement: | import QtRos2.RclInterfaces |
| Inherits: | |
| Status: | Experimental Extension |
Properties
Signals
- callFailed(string error)
- responseReceived(Qtros2RclInterfacesMsgs::ListParametersResult response)
Methods
- QJSValue callService(const listParametersRequest&request)
Detailed Description
ListParametersServiceClient calls a ROS 2 service. Set the topic and node properties, then call callService() to invoke the service. Alternatively, bind the request property: whenever the bound value changes, the service is called automatically and response is updated with the result.
Property Documentation
request : listParametersRequest
The request value for declarative service calls. When autoCall is true (the default), each change of this property schedules a service call at the end of the current event-loop iteration; changes made while the service is unavailable or a call is in flight are remembered and the latest value is dispatched as soon as possible. The result arrives in response.
response : Qtros2RclInterfacesMsgs::ListParametersResult
The most recent response received from the service, whether the call was made via request or 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(Qtros2RclInterfacesMsgs::ListParametersResult response)
Emitted when the service call completes successfully. response is a Qtros2RclInterfacesMsgs::ListParametersResult value.
Note: The corresponding handler is onResponseReceived.
Method Documentation
QJSValue callService(const listParametersRequest&request)
Calls the ListParameters ROS 2 service with listParametersRequest request. Returns a JS promise that resolves with a Qtros2RclInterfacesMsgs::ListParametersResult 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.
