getTypeDescriptionResponse QML Value Type

Qt value type wrapper for type_description_interfaces::srv::GetTypeDescription_Response ROS 2 messages. More...

Properties

• extraInformation : list<typeDescriptionKeyValue>
• failureReason : string
• successful : bool
• typeDescription : typeDescription
• typeSources : list<typeSource>

Detailed Description

getTypeDescriptionResponse is a structured value type usable in QML. It maps directly to the type_description_interfaces::srv::GetTypeDescription_Response ROS 2 message type.

Construct a getTypeDescriptionResponse in QML by assigning a JavaScript object whose keys are its component properties, or by setting those properties individually.

Property Documentation

extraInformation : list<typeDescriptionKeyValue>

Key-value pairs of extra information.

failureReason : string

If `successful` is false, contains a reason for failure.

If `successful` is true, this is left empty.

successful : bool

typeDescription : typeDescription

The parsed type description which can be used programmatically.

typeSources : list<typeSource>

A list containing the interface definition source text of the requested type,

plus all types it recursively depends on. Each source text is a copy of the original contents of the .msg, .srv, .action, .idl, or other file if it exists, including comments and whitespace. Sources can be matched with IndividualTypeDescriptions by their `type_name`. The `encoding` field of each entry informs how to interpret its contents.