SaveControl.hpp

Go to the documentation of this file.

/*
 * Copyright (c) 2015 - 2024 Intel Corporation
 * SPDX-License-Identifier: BSD-3-Clause
 */
 
#ifndef SAVECONTROL_HPP_INCLUDE
#define SAVECONTROL_HPP_INCLUDE
 
#include <memory>
#include <vector>
#include <string>
#include <set>
 
#include "geopm_public.h"
 
namespace geopm
{
    class IOGroup;
    class PlatformTopo;
 
    class GEOPM_PUBLIC SaveControl
    {
        public:
            struct m_setting_s {
                std::string name;
                int domain_type;
                int domain_idx;
                double setting;
            };
            SaveControl() = default;
            virtual ~SaveControl() = default;
            static std::unique_ptr<SaveControl> make_unique(const std::vector<m_setting_s> &settings);
            static std::unique_ptr<SaveControl> make_unique(const std::string &json_string);
            static std::unique_ptr<SaveControl> make_unique(IOGroup &io_group);
            virtual std::string json(void) const = 0;
            virtual std::vector<m_setting_s> settings(void) const = 0;
            virtual void write_json(const std::string &save_path) const = 0;
            virtual void restore(IOGroup &io_group) const = 0;
            virtual std::set<std::string> unsaved_controls(const std::set<std::string> &all_controls) const = 0;
    };
 
    class GEOPM_PUBLIC SaveControlImp : public SaveControl
    {
        public:
            SaveControlImp(const std::vector<m_setting_s> &settings);
            SaveControlImp(const std::string &json_string);
            SaveControlImp(IOGroup &io_group, const PlatformTopo &topo);
            virtual ~SaveControlImp() = default;
            std::string json(void) const override;
            std::vector<m_setting_s> settings(void) const override;
            void write_json(const std::string &save_path) const override;
            void restore(IOGroup &io_group) const override;
            std::set<std::string> unsaved_controls(const std::set<std::string> &all_controls) const override;
 
            static std::string json(const std::vector<m_setting_s> &settings);
            static std::vector<m_setting_s> settings(const std::string &json_string);
            static std::vector<m_setting_s> settings(IOGroup &io_group,
                                                     const PlatformTopo &topo);
        private:
            const std::vector<m_setting_s> m_settings;
            const std::string m_json;
    };
}
 
#endif