IDS peak ICV v1.0.0
Loading...
Searching...
No Matches
peak_icv_archive.hpp
Go to the documentation of this file.
1
11#pragma once
12
13#include <memory>
14#include <string>
15#include <vector>
16
20
22#include <peak_icv_c/serialization/peak_icv_archive.h>
23
24namespace peak
25{
26namespace icv
27{
48 , public detail::IBackendAccessible<Archive>
49{
50public:
58 Archive();
59
65 ~Archive() override;
66
72 Archive(const Archive&) = delete;
73
79 Archive& operator=(const Archive&) = delete;
80
88 Archive(Archive&& other) noexcept;
89
98 Archive& operator=(Archive&& other) noexcept;
99
108 PEAK_COMMON_NO_DISCARD std::shared_ptr<IArchive> CreateArchive() const override;
109
117 PEAK_COMMON_NO_DISCARD bool HasKey(const std::string& key) const override;
118
126 PEAK_COMMON_NO_DISCARD ValueType GetValueType(const std::string& key) const override;
127
134 PEAK_COMMON_NO_DISCARD std::vector<std::string> GetKeys() const override;
135
143 PEAK_COMMON_NO_DISCARD size_t GetArrayCount(const std::string& key) const override;
144
152 void SetBool(const std::string& key, bool value) override;
153
161 void SetInt(const std::string& key, int64_t value) override;
162
170 void SetDouble(const std::string& key, double value) override;
171
179 void SetString(const std::string& key, const std::string& value) override;
180
188 void SetArchive(const std::string& key, const std::shared_ptr<IArchive>& value) override;
189
197 void SetBoolArray(const std::string& key, const std::vector<bool>& value) override;
198
206 void SetIntArray(const std::string& key, const std::vector<int64_t>& value) override;
207
215 void SetDoubleArray(const std::string& key, const std::vector<double>& value) override;
216
224 void SetStringArray(const std::string& key, const std::vector<std::string>& value) override;
225
233 void SetArchiveArray(const std::string& key, const std::vector<std::shared_ptr<IArchive>>& value) override;
234
235 // Getter methods for single values
236
244 PEAK_COMMON_NO_DISCARD bool GetBool(const std::string& key) const override;
245
253 PEAK_COMMON_NO_DISCARD int64_t GetInt(const std::string& key) const override;
254
262 PEAK_COMMON_NO_DISCARD double GetDouble(const std::string& key) const override;
263
271 PEAK_COMMON_NO_DISCARD std::string GetString(const std::string& key) const override;
272
280 PEAK_COMMON_NO_DISCARD std::shared_ptr<IArchive> GetArchive(const std::string& key) const override;
281
289 PEAK_COMMON_NO_DISCARD std::vector<bool> GetBoolArray(const std::string& key) const override;
290
298 PEAK_COMMON_NO_DISCARD std::vector<int64_t> GetIntArray(const std::string& key) const override;
299
307 PEAK_COMMON_NO_DISCARD std::vector<double> GetDoubleArray(const std::string& key) const override;
308
316 PEAK_COMMON_NO_DISCARD std::vector<std::string> GetStringArray(const std::string& key) const override;
317
325 PEAK_COMMON_NO_DISCARD std::vector<std::shared_ptr<IArchive>> GetArchiveArray(const std::string& key) const override;
326
327private:
328 friend peak::common::detail::BackendAccessor<Archive>;
329
330 explicit Archive(peak_icv_archive_handle handle);
331
332 PEAK_COMMON_NO_DISCARD peak_icv_archive_handle GetHandle() const override
333 {
334 return m_handle;
335 }
336
337 peak_icv_archive_handle m_handle{};
338};
339} /* namespace icv */
340} /* namespace peak */
341
Interface for a hierarchical key-value archive system.
ValueType
Enumerates supported value types that can be stored or queried in the archive.
A simple key-value store that implements the IArchive interface.
std::vector< int64_t > GetIntArray(const std::string &key) const override
Gets an array of integer values.
std::vector< std::shared_ptr< IArchive > > GetArchiveArray(const std::string &key) const override
Gets an array of nested archive values.
void SetBoolArray(const std::string &key, const std::vector< bool > &value) override
Sets an array of boolean values.
double GetDouble(const std::string &key) const override
Gets a double precision floating point value.
void SetDouble(const std::string &key, double value) override
Sets a double precision floating point value.
Archive(const Archive &)=delete
Deleted copy constructor.
std::string GetString(const std::string &key) const override
Gets a string value.
void SetInt(const std::string &key, int64_t value) override
Sets an integer value.
std::shared_ptr< IArchive > GetArchive(const std::string &key) const override
Gets a nested archive value.
std::vector< std::string > GetStringArray(const std::string &key) const override
Gets an array of string values.
std::vector< double > GetDoubleArray(const std::string &key) const override
Gets an array of double precision floating point values.
void SetString(const std::string &key, const std::string &value) override
Sets a string value.
void SetIntArray(const std::string &key, const std::vector< int64_t > &value) override
Sets an array of integer values.
Archive & operator=(const Archive &)=delete
Deleted copy assignment operator.
void SetArchive(const std::string &key, const std::shared_ptr< IArchive > &value) override
Sets a nested archive value.
int64_t GetInt(const std::string &key) const override
Gets an integer value.
bool GetBool(const std::string &key) const override
Gets a boolean value.
size_t GetArrayCount(const std::string &key) const override
Gets the count of elements in an array value.
ValueType GetValueType(const std::string &key) const override
Gets the type of value stored under a key.
void SetStringArray(const std::string &key, const std::vector< std::string > &value) override
Sets an array of string values.
~Archive() override
Virtual destructor.
std::shared_ptr< IArchive > CreateArchive() const override
Creates a new Archive instance.
std::vector< std::string > GetKeys() const override
Gets all keys stored in the archive.
std::vector< bool > GetBoolArray(const std::string &key) const override
Gets an array of boolean values.
Archive()
Default constructor.
bool HasKey(const std::string &key) const override
Checks if a key exists in the archive.
void SetBool(const std::string &key, bool value) override
Sets a boolean value.
void SetDoubleArray(const std::string &key, const std::vector< double > &value) override
Sets an array of double precision floating point values.
void SetArchiveArray(const std::string &key, const std::vector< std::shared_ptr< IArchive > > &value) override
Sets an array of nested archive values.
#define PEAK_COMMON_NO_DISCARD
Compatability macro for the nodiscard attribute.