On this page

StatePublisher QML Type

Publishes lifecycle_msgs::msg::State messages — Primary state definitions as depicted in: http://design.ros2.org/articles/node_lifecycle.html. More...

Import Statement: import QtRos2.LifecycleMsgs
Inherits:

PublisherBase

Status: Experimental Extension

Properties

Methods

Detailed Description

These are the primary states. State changes can only be requested when the node is in one of these states.

StatePublisher publishes state values to a ROS 2 topic. Set the topic and node properties, then call publish() to send messages.

See also StateSubscriber and state.

Property Documentation

id : uint8_t

The id field value included in the next publish. Setting this property emits idChanged and, when autoPublish is true, requests a publish at the end of the current event-loop iteration.

label : string

The label field value included in the next publish. Setting this property emits labelChanged and, when autoPublish is true, requests a publish at the end of the current event-loop iteration.

Method Documentation

void publish(state msg)

Publishes state msg to the ROS 2 topic set by the topic property. Does nothing if the publisher is not connected.

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