Program Listing for File metrics-group.h

↰ Return to documentation for file (include\metrics\metrics-group.h)

/*
    Copyright (c) 2018 Intel Corporation.

    This software and the related documents are Intel copyrighted materials,
    and your use of them is governed by the express license under which they
    were provided to you ("License"). Unless the License provides otherwise,
    you may not use, modify, copy, publish, distribute, disclose or transmit
    this software or the related documents without Intel's prior written
    permission.

    This software and the related documents are provided as is, with no express
    or implied warranties, other than those that are expressly stated in the
    License.
*/

#pragma once

#include <cstdint>

namespace gpa {
namespace metrics {

class IMetric;

struct QueryReportDescription
{
    uint32_t flagCount = 0u;
    char const** ppFlagSymbolicNameArray = nullptr;
    char const** ppFlagDescriptionArray = nullptr;
};

class IMetricGroup
{
public:
    virtual ~IMetricGroup();

    virtual char const* Name() const = 0;
    virtual char const* SymbolName() const = 0;
    virtual unsigned int Count() const = 0;
    virtual unsigned int ID() const = 0;
    virtual IMetric const* Metric(unsigned int index) const = 0;
    virtual unsigned int StartMetricIndex() const = 0;

    // Note that adding struct to the return type is necessary to avoid a GCC compilation failure.
    virtual struct metrics::QueryReportDescription const& QueryReportDescription() const = 0;
};

}  // namespace metrics
}  // namespace gpa