Interface for a hierarchical key-value archive system. More...

#include <peak_common/serialization/peak_common_iarchive.hpp>

Public Types
enum class	ValueType { Bool , BoolArray , Int , IntArray , Double , DoubleArray , String , StringArray , Archive , ArchiveArray }
	Enumerates supported value types that can be stored or queried in the archive. More...

Public Member Functions
virtual	~IArchive ()=default

virtual PEAK_COMMON_NO_DISCARD std::shared_ptr< IArchive >	CreateArchive () const =0
	Creates a new, empty archive instance.

virtual PEAK_COMMON_NO_DISCARD bool	HasKey (const std::string &key) const =0
	Checks whether a given key exists in the archive.

virtual PEAK_COMMON_NO_DISCARD ValueType	GetValueType (const std::string &key) const =0
	Retrieves the value type associated with a key.

virtual PEAK_COMMON_NO_DISCARD std::vector< std::string >	GetKeys () const =0
	Returns a list of all keys currently stored in the archive.

virtual PEAK_COMMON_NO_DISCARD size_t	GetArrayCount (const std::string &key) const =0
	Gets the number of elements in an array stored under the given key.

virtual void	SetBool (const std::string &key, bool value)=0
	Stores a boolean value.

virtual void	SetInt (const std::string &key, int64_t value)=0
	Stores a 64-bit signed integer.

virtual void	SetDouble (const std::string &key, double value)=0
	Stores a double-precision floating point number.

virtual void	SetString (const std::string &key, const std::string &value)=0
	Stores a UTF-8 string.

virtual void	SetArchive (const std::string &key, const std::shared_ptr< IArchive > &value)=0
	Stores a nested archive object.

virtual void	SetBoolArray (const std::string &key, const std::vector< bool > &value)=0
	Stores an array of boolean values.

virtual void	SetIntArray (const std::string &key, const std::vector< int64_t > &value)=0
	Stores an array of 64-bit integers.

virtual void	SetDoubleArray (const std::string &key, const std::vector< double > &value)=0
	Stores an array of doubles.

virtual void	SetStringArray (const std::string &key, const std::vector< std::string > &value)=0
	Stores an array of strings.

virtual void	SetArchiveArray (const std::string &key, const std::vector< std::shared_ptr< IArchive > > &value)=0
	Stores an array of nested archives.

virtual PEAK_COMMON_NO_DISCARD bool	GetBool (const std::string &key) const =0
	Retrieves a boolean value by key.

virtual PEAK_COMMON_NO_DISCARD int64_t	GetInt (const std::string &key) const =0
	Retrieves a 64-bit signed integer by key.

virtual PEAK_COMMON_NO_DISCARD double	GetDouble (const std::string &key) const =0
	Retrieves a double-precision number by key.

virtual PEAK_COMMON_NO_DISCARD std::string	GetString (const std::string &key) const =0
	Retrieves a string value by key.

virtual PEAK_COMMON_NO_DISCARD std::shared_ptr< IArchive >	GetArchive (const std::string &key) const =0
	Retrieves a nested archive by key.

virtual PEAK_COMMON_NO_DISCARD std::vector< bool >	GetBoolArray (const std::string &key) const =0
	Retrieves an array of booleans by key.

virtual PEAK_COMMON_NO_DISCARD std::vector< int64_t >	GetIntArray (const std::string &key) const =0
	Retrieves an array of integers by key.

virtual PEAK_COMMON_NO_DISCARD std::vector< double >	GetDoubleArray (const std::string &key) const =0
	Retrieves an array of doubles by key.

virtual PEAK_COMMON_NO_DISCARD std::vector< std::string >	GetStringArray (const std::string &key) const =0
	Retrieves an array of strings by key.

virtual PEAK_COMMON_NO_DISCARD std::vector< std::shared_ptr< IArchive > >	GetArchiveArray (const std::string &key) const =0
	Retrieves an array of nested archives by key.

Detailed Description

Interface for a hierarchical key-value archive system.

Provides methods for storing and retrieving structured data of various types, including primitive values, arrays, and nested archives.

This interface is suitable for serialization and deserialization purposes.

Since: ids_peak_common 1.0

Member Enumeration Documentation

◆ ValueType

enum class peak::common::serialization::IArchive::ValueType

strong

Enumerates supported value types that can be stored or queried in the archive.

Enumerator
Bool	Single boolean value.
BoolArray	Array of booleans.
Int	64-bit signed integer
IntArray	Array of integers.
Double	Double-precision floating point.
DoubleArray	Array of doubles.
String	UTF-8 encoded string.
StringArray	Array of strings.
Archive	Nested archive object.
ArchiveArray	Array of nested archives.

Constructor & Destructor Documentation

◆ ~IArchive()

virtual peak::common::serialization::IArchive::~IArchive ( )

virtualdefault

Member Function Documentation

◆ CreateArchive()

virtual PEAK_COMMON_NO_DISCARD std::shared_ptr< IArchive > peak::common::serialization::IArchive::CreateArchive ( ) const

pure virtual

Creates a new, empty archive instance.

◆ GetArchive()

virtual PEAK_COMMON_NO_DISCARD std::shared_ptr< IArchive > peak::common::serialization::IArchive::GetArchive ( const std::string & key ) const

pure virtual

Retrieves a nested archive by key.

◆ GetArchiveArray()

virtual PEAK_COMMON_NO_DISCARD std::vector< std::shared_ptr< IArchive > > peak::common::serialization::IArchive::GetArchiveArray ( const std::string & key ) const

pure virtual

Retrieves an array of nested archives by key.

◆ GetArrayCount()

virtual PEAK_COMMON_NO_DISCARD size_t peak::common::serialization::IArchive::GetArrayCount ( const std::string & key ) const

pure virtual

Gets the number of elements in an array stored under the given key.

Parameters

key	The key referencing the array.

Returns: Element count of the array.

◆ GetBool()

virtual PEAK_COMMON_NO_DISCARD bool peak::common::serialization::IArchive::GetBool ( const std::string & key ) const

pure virtual

Retrieves a boolean value by key.

◆ GetBoolArray()

virtual PEAK_COMMON_NO_DISCARD std::vector< bool > peak::common::serialization::IArchive::GetBoolArray ( const std::string & key ) const

pure virtual

Retrieves an array of booleans by key.

◆ GetDouble()

virtual PEAK_COMMON_NO_DISCARD double peak::common::serialization::IArchive::GetDouble ( const std::string & key ) const

pure virtual

Retrieves a double-precision number by key.

◆ GetDoubleArray()

virtual PEAK_COMMON_NO_DISCARD std::vector< double > peak::common::serialization::IArchive::GetDoubleArray ( const std::string & key ) const

pure virtual

Retrieves an array of doubles by key.

◆ GetInt()

virtual PEAK_COMMON_NO_DISCARD int64_t peak::common::serialization::IArchive::GetInt ( const std::string & key ) const

pure virtual

Retrieves a 64-bit signed integer by key.

◆ GetIntArray()

virtual PEAK_COMMON_NO_DISCARD std::vector< int64_t > peak::common::serialization::IArchive::GetIntArray ( const std::string & key ) const

pure virtual

Retrieves an array of integers by key.

◆ GetKeys()

virtual PEAK_COMMON_NO_DISCARD std::vector< std::string > peak::common::serialization::IArchive::GetKeys ( ) const

pure virtual

Returns a list of all keys currently stored in the archive.

Returns: Vector containing all stored keys.

◆ GetString()

virtual PEAK_COMMON_NO_DISCARD std::string peak::common::serialization::IArchive::GetString ( const std::string & key ) const

pure virtual

Retrieves a string value by key.

◆ GetStringArray()

virtual PEAK_COMMON_NO_DISCARD std::vector< std::string > peak::common::serialization::IArchive::GetStringArray ( const std::string & key ) const

pure virtual

Retrieves an array of strings by key.

◆ GetValueType()

virtual PEAK_COMMON_NO_DISCARD ValueType peak::common::serialization::IArchive::GetValueType ( const std::string & key ) const

pure virtual

Retrieves the value type associated with a key.

Parameters

key	The key whose value type to retrieve.

Returns: The ValueType of the stored data.

◆ HasKey()

virtual PEAK_COMMON_NO_DISCARD bool peak::common::serialization::IArchive::HasKey ( const std::string & key ) const

pure virtual

Checks whether a given key exists in the archive.

Parameters

key	The key to look for.

Returns: true if the key exists, false otherwise.

◆ SetArchive()

virtual void peak::common::serialization::IArchive::SetArchive	(	const std::string &	key,
		const std::shared_ptr< IArchive > &	value )

pure virtual

Stores a nested archive object.

◆ SetArchiveArray()

virtual void peak::common::serialization::IArchive::SetArchiveArray	(	const std::string &	key,
		const std::vector< std::shared_ptr< IArchive > > &	value )

pure virtual

Stores an array of nested archives.

◆ SetBool()

virtual void peak::common::serialization::IArchive::SetBool	(	const std::string &	key,
		bool	value )

pure virtual

Stores a boolean value.

◆ SetBoolArray()

virtual void peak::common::serialization::IArchive::SetBoolArray	(	const std::string &	key,
		const std::vector< bool > &	value )

pure virtual

Stores an array of boolean values.

◆ SetDouble()

virtual void peak::common::serialization::IArchive::SetDouble	(	const std::string &	key,
		double	value )

pure virtual

Stores a double-precision floating point number.

◆ SetDoubleArray()

virtual void peak::common::serialization::IArchive::SetDoubleArray	(	const std::string &	key,
		const std::vector< double > &	value )

pure virtual

Stores an array of doubles.

◆ SetInt()

virtual void peak::common::serialization::IArchive::SetInt	(	const std::string &	key,
		int64_t	value )

pure virtual

Stores a 64-bit signed integer.

◆ SetIntArray()

virtual void peak::common::serialization::IArchive::SetIntArray	(	const std::string &	key,
		const std::vector< int64_t > &	value )

pure virtual

Stores an array of 64-bit integers.

◆ SetString()

virtual void peak::common::serialization::IArchive::SetString	(	const std::string &	key,
		const std::string &	value )

pure virtual

Stores a UTF-8 string.

◆ SetStringArray()

virtual void peak::common::serialization::IArchive::SetStringArray	(	const std::string &	key,
		const std::vector< std::string > &	value )

pure virtual

Stores an array of strings.

The documentation for this class was generated from the following file:

peak_common/serialization/peak_common_iarchive.hpp

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

◆ ValueType

Constructor & Destructor Documentation

◆ ~IArchive()

Member Function Documentation

◆ CreateArchive()

◆ GetArchive()

◆ GetArchiveArray()

◆ GetArrayCount()

◆ GetBool()

◆ GetBoolArray()

◆ GetDouble()

◆ GetDoubleArray()

◆ GetInt()

◆ GetIntArray()

◆ GetKeys()

◆ GetString()

◆ GetStringArray()

◆ GetValueType()

◆ HasKey()

◆ SetArchive()

◆ SetArchiveArray()

◆ SetBool()

◆ SetBoolArray()

◆ SetDouble()

◆ SetDoubleArray()

◆ SetInt()

◆ SetIntArray()

◆ SetString()

◆ SetStringArray()