MenuEntrySubscriber QML Type

Subscribes to visualization_msgs::msg::MenuEntry messages — MenuEntry message. More...

• List of all members, including inherited members

Properties

• command : string
• commandType : uint8_t
• id : uint32_t
• message : menuEntry
• parentId : uint32_t
• title : string

Signals

• messageReceived(menuEntry msg)

Detailed Description

Each InteractiveMarker message has an array of MenuEntry messages. A collection of MenuEntries together describe a menu/submenu/subsubmenu/etc tree, though they are stored in a flat array. The tree structure is represented by giving each menu entry an ID number and a "parent_id" field. Top-level entries are the ones with parent_id = 0. Menu entries are ordered within their level the same way they are ordered in the containing array. Parent entries must appear before their children.

Example: - id = 3 parent_id = 0 title = "fun" - id = 2 parent_id = 0 title = "robot" - id = 4 parent_id = 2 title = "pr2" - id = 5 parent_id = 2 title = "turtle"

Gives a menu tree like this:

• fun
• robot
• pr2
• turtle

MenuEntrySubscriber receives menuEntry values from a ROS 2 topic. Set the topic and node properties, then connect to the messageReceived() signal.

See also MenuEntryPublisher and menuEntry.

Property Documentation

command : string

The command field of the last received message. Updated whenever a new message arrives. commandChanged is emitted on every update.

commandType : uint8_t

The commandType field of the last received message. Updated whenever a new message arrives. commandTypeChanged is emitted on every update.

id : uint32_t

The id field of the last received message. Updated whenever a new message arrives. idChanged is emitted on every update.

message : menuEntry

The last message received on topic. Updated whenever a new message arrives.

parentId : uint32_t

The parentId field of the last received message. Updated whenever a new message arrives. parentIdChanged is emitted on every update.

title : string

The title field of the last received message. Updated whenever a new message arrives. titleChanged is emitted on every update.

Signal Documentation

messageReceived(menuEntry msg)

Emitted when a new menuEntry arrives on topic. msg contains the received value.