C++ API

libstatistics_collector

Description

This C++ library provides the following:

• A Collector interface for implementing classes that collect observed data and generate statistics for them

• A TopicStatisticsCollector interface for implementing classes that collect and perform measurements for ROS2 topic statistics. Classes for calculating ROS 2 message age and message period statistics are also implemented.

• A MovingAverageStatistics class for calculating moving average statistics

Quality Declaration

This package claims to be in the Quality Level 1 category, see the Quality Declaration for more details.

Class Hierarchy

• • Namespace libstatistics_collector
    • Namespace libstatistics_collector::collector
      • Class Collector
      • Class MetricDetailsInterface
    • Namespace libstatistics_collector::moving_average_statistics
      • Struct StatisticData
      • Class MovingAverageStatistics
    • Namespace libstatistics_collector::topic_statistics_collector
      • Template Struct HasHeader
      • Template Struct HasHeader< M, typename std::enable_if< std::is_same< builtin_interfaces::msg::Time, decltype(M().header.stamp) >::value >::type >
      • Template Struct TimeStamp
      • Template Struct TimeStamp< M, typename std::enable_if< HasHeader< M >::value >::type >
      • Template Class ReceivedMessageAgeCollector
      • Template Class ReceivedMessagePeriodCollector
      • Template Class TopicStatisticsCollector

File Hierarchy

• • Directory include
    • Directory libstatistics_collector
      • Directory collector
        • File collector.hpp
        • File generate_statistics_message.hpp
        • File metric_details_interface.hpp
      • Directory moving_average_statistics
        • File moving_average.hpp
        • File types.hpp
      • Directory topic_statistics_collector
        • File constants.hpp
        • File received_message_age.hpp
        • File received_message_period.hpp
        • File topic_statistics_collector.hpp
      • File visibility_control.hpp
  • File README.md

Full C++ API

Namespaces

• Namespace libstatistics_collector

• Namespace libstatistics_collector::collector

• Namespace libstatistics_collector::moving_average_statistics

• Namespace libstatistics_collector::topic_statistics_collector

• Namespace libstatistics_collector::topic_statistics_collector::topic_statistics_constants

• Namespace std

Classes and Structs

• Struct StatisticData

• Template Struct HasHeader

• Template Struct HasHeader< M, typename std::enable_if< std::is_same< builtin_interfaces::msg::Time, decltype(M().header.stamp) >::value >::type >

• Template Struct TimeStamp

• Template Struct TimeStamp< M, typename std::enable_if< HasHeader< M >::value >::type >

• Class Collector

• Class MetricDetailsInterface

• Class MovingAverageStatistics

• Template Class ReceivedMessageAgeCollector

• Template Class ReceivedMessagePeriodCollector

• Template Class TopicStatisticsCollector

Functions

• Function libstatistics_collector::collector::GenerateStatisticMessage

• Function libstatistics_collector::moving_average_statistics::StatisticsDataToString

Variables

• Variable libstatistics_collector::topic_statistics_collector::kUninitializedTime

• Variable libstatistics_collector::topic_statistics_collector::topic_statistics_constants::kCollectStatsTopicNameParam

• Variable libstatistics_collector::topic_statistics_collector::topic_statistics_constants::kMillisecondUnitName

• Variable libstatistics_collector::topic_statistics_collector::topic_statistics_constants::kMsgAgeStatName

• Variable libstatistics_collector::topic_statistics_collector::topic_statistics_constants::kMsgPeriodStatName

• Variable libstatistics_collector::topic_statistics_collector::topic_statistics_constants::kPublishStatsTopicNameParam

Defines

• Define LIBSTATISTICS_COLLECTOR_EXPORT

• Define LIBSTATISTICS_COLLECTOR_IMPORT

• Define LIBSTATISTICS_COLLECTOR_LOCAL

• Define LIBSTATISTICS_COLLECTOR_PUBLIC

• Define LIBSTATISTICS_COLLECTOR_PUBLIC_TYPE

Directories

• Directory include

• Directory libstatistics_collector

• Directory collector

• Directory moving_average_statistics

• Directory topic_statistics_collector

Files

• File collector.hpp

• File constants.hpp

• File generate_statistics_message.hpp

• File metric_details_interface.hpp

• File moving_average.hpp

• File README.md

• File received_message_age.hpp

• File received_message_period.hpp

• File topic_statistics_collector.hpp

• File types.hpp

• File visibility_control.hpp