MetricEventBuilder.h

Go to the documentation of this file.

/*
 * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the "License").
 * You may not use this file except in compliance with the License.
 * A copy of the License is located at
 *
 *     http://aws.amazon.com/apache2.0/
 *
 * or in the "license" file accompanying this file. This file is distributed
 * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
 * express or implied. See the License for the specific language governing
 * permissions and limitations under the License.
 */
#ifndef ALEXA_CLIENT_SDK_AVSCOMMON_UTILS_INCLUDE_AVSCOMMON_UTILS_METRICS_METRICEVENTBUILDER_H_
#define ALEXA_CLIENT_SDK_AVSCOMMON_UTILS_INCLUDE_AVSCOMMON_UTILS_METRICS_METRICEVENTBUILDER_H_

#include <unordered_map>

#include "AVSCommon/Utils/Metrics/DataPoint.h"
#include "AVSCommon/Utils/Metrics/MetricEvent.h"

namespace alexaClientSDK {
namespace avsCommon {
namespace utils {
namespace metrics {

class MetricEventBuilder {
public:
    MetricEventBuilder();

    MetricEventBuilder& setActivityName(const std::string& activityName);

    MetricEventBuilder& setPriority(Priority priority);

    MetricEventBuilder& addDataPoint(const DataPoint& dataPoint);

    MetricEventBuilder& addDataPoints(const std::vector<DataPoint>& dataPoints);

    MetricEventBuilder& removeDataPoint(const DataPoint& dataPoint);

    MetricEventBuilder& removeDataPoint(const std::string& name, DataType dataType);

    MetricEventBuilder& removeDataPoints();

    void clear();

    std::shared_ptr<MetricEvent> build();

    static std::string generateKey(const std::string& name, DataType dataType);

private:
    MetricEventBuilder& removeDataPoint(const std::string& key);

    // The activity name of the current metric event
    std::string m_activityName;

    // The priority of the current metric event
    Priority m_priority;

    // The dataPoints of the current metric event
    std::unordered_map<std::string, DataPoint> m_dataPoints;
};

}  // namespace metrics
}  // namespace utils
}  // namespace avsCommon
}  // namespace alexaClientSDK

#endif  // ALEXA_CLIENT_SDK_AVSCOMMON_UTILS_INCLUDE_AVSCOMMON_UTILS_METRICS_METRICEVENTBUILDER_H_