typeSource QML Value Type

Represents the original source of a ROS 2 interface definition. More...

Properties

• encoding : string
• rawFileContents : string
• typeName : string

Detailed Description

typeSource is a structured value type usable in QML. It maps directly to the type_description_interfaces::msg::TypeSource ROS 2 message type.

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

See also TypeSourcePublisher and TypeSourceSubscriber.

Property Documentation

encoding : string

The type of the original source file, typically matching the file extension.

Well-known encodings: "idl", "msg", "srv", "action", "dynamic", "implicit". "dynamic" specifies a type created programmatically by a user, thus having no source. "implicit" specifies a type created automatically as a subtype of a complex type (service or action) - such as the request message for a service. Implicit types will have no contents, the full source will be available on the parent srv/action.

rawFileContents : string

Dumped contents of the interface definition source file.

If `encoding` is "dynamic" or "implicit", this field will be empty.

typeName : string

ROS interface type name, in PACKAGE/NAMESPACE/TYPENAME format.