libstatistics_collector::collector::MetricDetailsInterface Class Reference

#include <metric_details_interface.hpp>

Inheritance diagram for libstatistics_collector::collector::MetricDetailsInterface:

Public Member Functions
virtual	~MetricDetailsInterface ()=default
virtual std::string	GetMetricName () const =0
virtual std::string	GetMetricUnit () const =0

Detailed Description

Interface to represent a single metric's name and unit, which are used for metric message generation and publication.

Constructor & Destructor Documentation

~MetricDetailsInterface()

virtual libstatistics_collector::collector::MetricDetailsInterface::~MetricDetailsInterface ( )

virtualdefault

Member Function Documentation

GetMetricName()

virtual std::string libstatistics_collector::collector::MetricDetailsInterface::GetMetricName ( ) const

pure virtual

Return a single metric's name.

Returns

a string representing the metric name

Implemented in libstatistics_collector::topic_statistics_collector::ReceivedMessageAgeCollector< T >, and libstatistics_collector::topic_statistics_collector::ReceivedMessagePeriodCollector< T >.

GetMetricUnit()

virtual std::string libstatistics_collector::collector::MetricDetailsInterface::GetMetricUnit ( ) const

pure virtual

Return a single metric's measurement unit.

Returns

a string representing the metric unit

Implemented in libstatistics_collector::topic_statistics_collector::ReceivedMessageAgeCollector< T >, and libstatistics_collector::topic_statistics_collector::ReceivedMessagePeriodCollector< T >.

---

The documentation for this class was generated from the following file:

• include/libstatistics_collector/collector/metric_details_interface.hpp