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

#include <DataPoint.h>

Public Member Functions

 DataPoint ()
 
 DataPoint (const std::string &name, const std::string &value, DataType dataType)
 
std::string getName () const
 
std::string getValue () const
 
DataType getDataType () const
 
bool isValid () const
 

Detailed Description

This class represents the immutable Datapoint objects.

Constructor & Destructor Documentation

◆ DataPoint() [1/2]

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

Default constructor. Creates a invalid metric point with empty values.

◆ DataPoint() [2/2]

alexaClientSDK::avsCommon::utils::metrics::DataPoint::DataPoint ( const std::string &  name,
const std::string &  value,
DataType  dataType 
)

Constructor

Parameters
nameis the name of the dataPoint
valueis the value of the dataPoint
dataTypeis the datatype of the dataPoint

Member Function Documentation

◆ getDataType()

DataType alexaClientSDK::avsCommon::utils::metrics::DataPoint::getDataType ( ) const

Getter method for the data type of the dataPoint

Returns
the data type of the dataPoint

◆ getName()

std::string alexaClientSDK::avsCommon::utils::metrics::DataPoint::getName ( ) const

Getter method for the name of the dataPoint

Returns
the name of the dataPoint

◆ getValue()

std::string alexaClientSDK::avsCommon::utils::metrics::DataPoint::getValue ( ) const

Getter method for the value of the dataPoint

Returns
the value of the dataPoint

◆ isValid()

bool alexaClientSDK::avsCommon::utils::metrics::DataPoint::isValid ( ) const

Checks to see if dataPoint is valid

Returns
true, if dataPoint is valid false, otherwise

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

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