rtctk::componentFramework::CounterMetricInfo Class Reference

Defines auxiliary information associated with each counter registered with ComponentMetricsIf. More...

#include <rtctk/componentFramework/componentMetricsIf.hpp>

Public Member Functions
	CounterMetricInfo (std::string id, std::string description) noexcept
	Construct instance.
const std::string &	GetId () const noexcept
const std::string &	GetDescription () const noexcept

Detailed Description

Defines auxiliary information associated with each counter registered with ComponentMetricsIf.

Properties:

• Id: String in the character class [0-9a-z] associates uniquely a logical counter instance.
• Description: String describing what the counter value represents.

Constructor & Destructor Documentation

CounterMetricInfo()

rtctk::componentFramework::CounterMetricInfo::CounterMetricInfo ( std::string id, std::string description )

explicitnoexcept

Construct instance.

Parameters

id	counter identifier.
description	counter description.

Member Function Documentation

GetDescription()

const std::string & rtctk::componentFramework::CounterMetricInfo::GetDescription ( ) const

inlinenoexcept

Returns

counter description.

GetId()

const std::string & rtctk::componentFramework::CounterMetricInfo::GetId ( ) const

inlinenoexcept

Returns

counter identifier.

---

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

• componentFramework/services/metrics/src/include/rtctk/componentFramework/componentMetricsIf.hpp
• componentFramework/services/metrics/src/componentMetricsIf.cpp