alexaClientSDK::avsCommon::utils::metrics::UplData Class Reference

#include <UplData.h>

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

Public Member Functions
void	addTimepoint (const std::string &name, const UplTimePoint &timepoint)
UplTimePoint	getTimepoint (const std::string &name) const
void	addParseCompleteTimepoint (const std::string &directiveId, const UplTimePoint &timepoint)
UplTimePoint	getParseCompleteTimepoint (const std::string &directiveId) const
void	addDirectiveDispatchedTimepoint (const std::string &directiveId, const UplTimePoint &timepoint)
UplTimePoint	getDirectiveDispatchedTimepoint (const std::string &directiveId) const
void	addStringData (const std::string &name, const std::string &data)
std::string	getStringData (const std::string &name) const

Detailed Description

This class represents the UplData shared between UPL Calculators

Member Typedef Documentation

UplTimePoint

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

Alias for convenience.

Member Function Documentation

addDirectiveDispatchedTimepoint()

void alexaClientSDK::avsCommon::utils::metrics::UplData::addDirectiveDispatchedTimepoint	(	const std::string &	directiveId,
		const UplTimePoint &	timepoint
	)

Adds the time point of a specific directive's DIRECTIVE_DISPATCHED metric to the MessageIdToDirectiveDispatchedMap. If an entry with the same directiveId is already present, it will overwrite the previous UplTimePoint.

Parameters

directiveId	Id of directive dispatched
timepoint	Time point of the DIRECTIVE_DISPATCHED metric

addParseCompleteTimepoint()

void alexaClientSDK::avsCommon::utils::metrics::UplData::addParseCompleteTimepoint	(	const std::string &	directiveId,
		const UplTimePoint &	timepoint
	)

Adds the time point of a specific directive's PARSE_COMPLETE metric to the MessageIdToParseCompleteMap. If an entry with the same directiveId is already present, it will overwrite the previous UplTimePoint.

Parameters

directiveId	Id of directive parsed
timepoint	Time point of the PARSE_COMPLETE metric

addStringData()

void alexaClientSDK::avsCommon::utils::metrics::UplData::addStringData	(	const std::string &	name,
		const std::string &	data
	)

Adds a string data to OtherData. If an entry with the same name is already present, it will overwrite the previous string data.

Parameters

name	Name of the data
data	Data string

addTimepoint()

void alexaClientSDK::avsCommon::utils::metrics::UplData::addTimepoint	(	const std::string &	name,
		const UplTimePoint &	timepoint
	)

Add a metric TimePoint to the UplTimePointsMap. If an entry with the same name is already present, it will overwrite the previous UplTimePoint.

Parameters

name	Metric name
timepoint	Time point of the metric

getDirectiveDispatchedTimepoint()

UplTimePoint alexaClientSDK::avsCommon::utils::metrics::UplData::getDirectiveDispatchedTimepoint

(

const std::string &

directiveId

)

const

Returns the time point of a specific directive's DIRECTIVE_DISPATCHED metric from the MessageIdToDirectiveDispatchedMap.

Parameters

directiveId

Id of directive dispatched

Returns

Time point of the DIRECTIVE_DISPATCHED metric

getParseCompleteTimepoint()

UplTimePoint alexaClientSDK::avsCommon::utils::metrics::UplData::getParseCompleteTimepoint

(

const std::string &

directiveId

)

const

Returns the time point of a specific directive's PARSE_COMPLETE metric from the MessageIdToParseCompleteMap.

Parameters

directiveId

Id of directive parsed

Returns

Time point of the PARSE_COMPLETE metric

getStringData()

std::string alexaClientSDK::avsCommon::utils::metrics::UplData::getStringData

(

const std::string &

name

)

const

Returns a saved string data from OtherData.

Parameters

name	Name of the data

Returns

Data string

getTimepoint()

UplTimePoint alexaClientSDK::avsCommon::utils::metrics::UplData::getTimepoint

(

const std::string &

name

)

const

Returns a saved metric's TimePoint from the UplTimePointsMap.

Parameters

name	Name of metric

Returns

Time point of the metric

---

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

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