AlexaClientSDK  3.0.0
A cross-platform, modular SDK for interacting with the Alexa Voice Service
Public Member Functions | List of all members
alexaClientSDK::avsCommon::utils::metrics::DataPointDurationBuilder Class Reference

#include <DataPointDurationBuilder.h>

Public Member Functions

 DataPointDurationBuilder ()
 
 DataPointDurationBuilder (std::chrono::milliseconds duration)
 
DataPointDurationBuildersetName (const std::string &name)
 
DataPointDurationBuilderstartDurationTimer ()
 
DataPointDurationBuilderstopDurationTimer ()
 
DataPoint build ()
 

Detailed Description

DataPointDurationBuilder is a builder class responsible for building immutable timer DataPoint objects.

Constructor & Destructor Documentation

◆ DataPointDurationBuilder() [1/2]

alexaClientSDK::avsCommon::utils::metrics::DataPointDurationBuilder::DataPointDurationBuilder ( )

Constructor

◆ DataPointDurationBuilder() [2/2]

alexaClientSDK::avsCommon::utils::metrics::DataPointDurationBuilder::DataPointDurationBuilder ( std::chrono::milliseconds  duration)
explicit

Overloaded constructor

Parameters
durationThe duration of the timer datapoint. Durations cannot be negative. If a negative duration is passed in, the duration will be set to 0.

Member Function Documentation

◆ build()

DataPoint alexaClientSDK::avsCommon::utils::metrics::DataPointDurationBuilder::build ( )

Builds a new immutable DataPoint object with the current duration stored in dataPoint timer builder. If build() is called when the timer is running, this will be considered valid and the current timer duration will be used.

Returns
A new immutable DataPoint object

◆ setName()

DataPointDurationBuilder& alexaClientSDK::avsCommon::utils::metrics::DataPointDurationBuilder::setName ( const std::string &  name)

Sets the name of the timer dataPoint

Parameters
nameThe name of the timer dataPoint.
Returns
This instance to facilitate setting more information to this dataPoint timer builder.

◆ startDurationTimer()

DataPointDurationBuilder& alexaClientSDK::avsCommon::utils::metrics::DataPointDurationBuilder::startDurationTimer ( )

Starts a timer to help calculate duration dataPoints. Each time startDurationTimer is called, it will update the running start timer

Returns
This instance to facilitate setting more information to this dataPoint timer builder.

◆ stopDurationTimer()

DataPointDurationBuilder& alexaClientSDK::avsCommon::utils::metrics::DataPointDurationBuilder::stopDurationTimer ( )

If stopDurationTimer is called when startDurationTimer is not running, it would do nothing and return this instance. If stopDurationTimer is called when startDurationTimer is running, it would calculate and set the duration value before returning this instance.

Returns
This instance to facilitate setting more information to this dataPoint timer builder.

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

AlexaClientSDK 3.0.0 - Copyright 2016-2022 Amazon.com, Inc. or its affiliates. All Rights Reserved. Licensed under the Apache License, Version 2.0