rtctk::componentFramework::ThreadMetricInfo Class Reference

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

#include <componentMetricsIf.hpp>

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

Detailed Description

Defines auxiliary information associated with each thread registered with ComponentMetricsIf.

Properties:

• Id: String in the character class [0-9a-z]. Uniquely identifies a logical thread in component.
• Description: Explains what the thread is/does and possibly why it is being monitored.

Constructor & Destructor Documentation

ThreadMetricInfo()

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

explicitnoexcept

Construct instance.

Parameters

id	thread identifier.
description	thread description.

Member Function Documentation

GetDescription()

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

inlinenoexcept

Returns

thread description.

GetId()

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

inlinenoexcept

Returns

thread 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