peak_common_iarchive.hpp

Go to the documentation of this file.

 
#pragma once
 
#include <peak_common_c/detail/peak_common_defines.h>
 
#include <memory>
#include <string>
#include <vector>
 
namespace peak
{
namespace common
{

namespace serialization
{

class IArchive
{
public:
    enum class ValueType
    {
        Bool,        
        BoolArray,   
 
        Int,         
        IntArray,    
 
        Double,      
        DoubleArray, 
 
        String,      
        StringArray, 
 
        Archive,     
        ArchiveArray 
    };
 
    virtual ~IArchive() = default;

    PEAK_COMMON_NO_DISCARD virtual std::shared_ptr<IArchive> CreateArchive() const = 0;

    PEAK_COMMON_NO_DISCARD virtual bool HasKey(const std::string& key) const = 0;

    PEAK_COMMON_NO_DISCARD virtual ValueType GetValueType(const std::string& key) const = 0;

    PEAK_COMMON_NO_DISCARD virtual std::vector<std::string> GetKeys() const = 0;

    PEAK_COMMON_NO_DISCARD virtual size_t GetArrayCount(const std::string& key) const = 0;
 
    // --------------------- Setters ---------------------

    virtual void SetBool(const std::string& key, bool value) = 0;

    virtual void SetInt(const std::string& key, int64_t value) = 0;

    virtual void SetDouble(const std::string& key, double value) = 0;

    virtual void SetString(const std::string& key, const std::string& value) = 0;

    virtual void SetArchive(const std::string& key, const std::shared_ptr<IArchive>& value) = 0;

    virtual void SetBoolArray(const std::string& key, const std::vector<bool>& value) = 0;

    virtual void SetIntArray(const std::string& key, const std::vector<int64_t>& value) = 0;

    virtual void SetDoubleArray(const std::string& key, const std::vector<double>& value) = 0;

    virtual void SetStringArray(const std::string& key, const std::vector<std::string>& value) = 0;

    virtual void SetArchiveArray(const std::string& key, const std::vector<std::shared_ptr<IArchive>>& value) = 0;
 
    // --------------------- Getters ---------------------

    PEAK_COMMON_NO_DISCARD virtual bool GetBool(const std::string& key) const = 0;

    PEAK_COMMON_NO_DISCARD virtual int64_t GetInt(const std::string& key) const = 0;

    PEAK_COMMON_NO_DISCARD virtual double GetDouble(const std::string& key) const = 0;

    PEAK_COMMON_NO_DISCARD virtual std::string GetString(const std::string& key) const = 0;

    PEAK_COMMON_NO_DISCARD virtual std::shared_ptr<IArchive> GetArchive(const std::string& key) const = 0;

    PEAK_COMMON_NO_DISCARD virtual std::vector<bool> GetBoolArray(const std::string& key) const = 0;

    PEAK_COMMON_NO_DISCARD virtual std::vector<int64_t> GetIntArray(const std::string& key) const = 0;

    PEAK_COMMON_NO_DISCARD virtual std::vector<double> GetDoubleArray(const std::string& key) const = 0;

    PEAK_COMMON_NO_DISCARD virtual std::vector<std::string> GetStringArray(const std::string& key) const = 0;

    PEAK_COMMON_NO_DISCARD virtual std::vector<std::shared_ptr<IArchive>> GetArchiveArray(const std::string& key) const = 0;
};
 
} // namespace serialization
} // namespace common 
} // namespace peak