#include <MetricEvent.h>

Public Member Functions
	MetricEvent (const std::string &activityName, Priority priority, const std::unordered_map< std::string, DataPoint > &dataPoints, std::chrono::steady_clock::time_point timestamp)

std::string	getActivityName () const

Priority	getPriority () const

Optional< DataPoint >	getDataPoint (const std::string &name, DataType dataType) const

std::vector< DataPoint >	getDataPoints () const

std::chrono::system_clock::time_point	getTimestamp () const

std::chrono::steady_clock::time_point	getSteadyTimestamp () const

Detailed Description

This class represents the immutable MetricEvent object.

Constructor & Destructor Documentation

◆ MetricEvent()

alexaClientSDK::avsCommon::utils::metrics::MetricEvent::MetricEvent	(	const std::string &	activityName,
		Priority	priority,
		const std::unordered_map< std::string, DataPoint > &	dataPoints,
		std::chrono::steady_clock::time_point	timestamp
	)

Constructor

Parameters

activityName	is the activity name of the metric event.
priority	is the priority of the metric event
dataPoints	is the collection of key value pairs from dataPoint id to dataPoint objects
timestamp	is the timestamp at which this metric event was created.

Member Function Documentation

◆ getActivityName()

std::string alexaClientSDK::avsCommon::utils::metrics::MetricEvent::getActivityName ( ) const

Getter method for the activity name of the metric event

Returns: the activity name of the metric event

◆ getDataPoint()

Optional<DataPoint> alexaClientSDK::avsCommon::utils::metrics::MetricEvent::getDataPoint	(	const std::string &	name,
		DataType	dataType
	)		const

Gets dataPoint object from the current metric event

Parameters

name	The name of the dataPoint to be retrieved
dataType	The dataType of the dataPoint to be retrieved

Returns: an optional dataPoint object

◆ getDataPoints()

std::vector<DataPoint> alexaClientSDK::avsCommon::utils::metrics::MetricEvent::getDataPoints ( ) const

Getter method for the dataPoints of the metric event

Returns: the dataPoints of the metric event

◆ getPriority()

Priority alexaClientSDK::avsCommon::utils::metrics::MetricEvent::getPriority ( ) const

Getter method for the priority of the metric event

Returns: the priority of the metric event

◆ getSteadyTimestamp()

std::chrono::steady_clock::time_point alexaClientSDK::avsCommon::utils::metrics::MetricEvent::getSteadyTimestamp ( ) const

Getter method for the timestamp of when the metric event was created as a steady clock time point.

Returns: the timestamp of the metric event

◆ getTimestamp()

std::chrono::system_clock::time_point alexaClientSDK::avsCommon::utils::metrics::MetricEvent::getTimestamp ( ) const

Getter method for the timestamp of when the metric event was created as a system clock time point.

Returns: the timestamp of the metric event

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

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

Public Member Functions