alexaClientSDK::avsCommon::utils::metrics::UplCalculatorInterface Class Reference

#include <UplCalculatorInterface.h>

Inheritance diagram for alexaClientSDK::avsCommon::utils::metrics::UplCalculatorInterface:

Public Types
using	UplTimePoint = std::chrono::steady_clock::time_point
	Alias for convenience. More...

Public Member Functions
virtual	~UplCalculatorInterface ()=default
virtual void	inspectMetric (const std::shared_ptr< avsCommon::utils::metrics::MetricEvent > &metricEvent)=0
virtual void	setUplData (const std::shared_ptr< UplData > &uplData)=0

Protected Attributes
std::shared_ptr< UplData >	m_uplData

Detailed Description

Interface class to inspect metrics and perform UPL analysis.

Member Typedef Documentation

UplTimePoint

using alexaClientSDK::avsCommon::utils::metrics::UplCalculatorInterface::UplTimePoint = std::chrono::steady_clock::time_point

Alias for convenience.

Constructor & Destructor Documentation

~UplCalculatorInterface()

virtual alexaClientSDK::avsCommon::utils::metrics::UplCalculatorInterface::~UplCalculatorInterface ( )

virtualdefault

Destructor.

Member Function Documentation

inspectMetric()

virtual void alexaClientSDK::avsCommon::utils::metrics::UplCalculatorInterface::inspectMetric ( const std::shared_ptr< avsCommon::utils::metrics::MetricEvent > &  metricEvent )

pure virtual

Inspect the given metric. If needed, record the metric and perform calculations.

Parameters

metricEvent

is the MetricEvent to inspect.

setUplData()

virtual void alexaClientSDK::avsCommon::utils::metrics::UplCalculatorInterface::setUplData ( const std::shared_ptr< UplData > &  uplData )

pure virtual

Sets the uplData to the given pointer.

Parameters

uplData

Object to record in.

Implemented in alexaClientSDK::metrics::implementations::BaseUplCalculator, alexaClientSDK::metrics::implementations::MediaUplCalculator, and alexaClientSDK::metrics::implementations::TtsUplCalculator.

Member Data Documentation

m_uplData

std::shared_ptr<UplData> alexaClientSDK::avsCommon::utils::metrics::UplCalculatorInterface::m_uplData

protected

---

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

• /workplace/avs-device-sdk/AVSCommon/Utils/include/AVSCommon/Utils/Metrics/UplCalculatorInterface.h