MetricsMessagePublisher QML Type

Publishes statistics_msgs::msg::MetricsMessage messages — A generic metrics message providing statistics for measurements from different sources. For example, measure a system's CPU % for a given window yields the following data points over a window of time:. More...

• List of all members, including inherited members

Properties

• measurementSourceName : string
• metricsSource : string
• statistics : list<statisticDataPoint>
• unit : string
• windowStart : time
• windowStop : time

Methods

• void publish(metricsMessage msg)

Detailed Description

• average cpu %
• std deviation
• min
• max
• sample count

These are all represented as different 'StatisticDataPoint's.

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

See also MetricsMessageSubscriber and metricsMessage.

Property Documentation

measurementSourceName : string

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

metricsSource : string

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

statistics : list<statisticDataPoint>

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

unit : string

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

windowStart : time

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

windowStop : time

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

Method Documentation

void publish(metricsMessage msg)

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