Serializable::Data Class Reference

#include <serialize.h>

Public Types
typedef insp::flat_map< std::string, Data >	ChildMap
typedef insp::flat_map< std::string, std::string >	EntryMap

Public Member Functions
const ChildMap &	GetChildren () const
ChildMap &	GetChildren ()
const EntryMap &	GetEntries () const
EntryMap &	GetEntries ()
Data &	Load (const std::string &key, Data &out)
Data &	Load (const std::string &key, std::string &out)
template<typename T >
Data &	Load (const std::string &key, T &out)
Data &	Store (const std::string &key, const Data &value)
Data &	Store (const std::string &key, const std::string &value)
template<typename T >
Data &	Store (const std::string &key, const T &value)

Detailed Description

Encapsulates a chunk of serialised data.

Member Typedef Documentation

ChildMap

typedef insp::flat_map<std::string, Data> Serializable::Data::ChildMap

Maps keys to serialised data.

EntryMap

typedef insp::flat_map<std::string, std::string> Serializable::Data::EntryMap

Maps keys to simple values.

Member Function Documentation

GetChildren()

const ChildMap& Serializable::Data::GetChildren ( ) const

inline

Retrieves the child elements.

GetEntries()

const EntryMap& Serializable::Data::GetEntries ( ) const

inline

Retrieves the key/value map.

Load() [1/3]

Serializable::Data & Serializable::Data::Load	(	const std::string &	key,
		Serializable::Data &	out
	)

Loads the serialised data with the specified key.

Parameters

key	The key by which this serialised data is identified.
out	The location to store the serialised data for this key.

Load() [2/3]

Serializable::Data & Serializable::Data::Load	(	const std::string &	key,
		std::string &	out
	)

Loads the value with the specified key.

Parameters

key	The key by which this data is identified.
out	The location to store the value for this key.

Load() [3/3]

template<typename T >

Data& Serializable::Data::Load ( const std::string &  key, T &  out  )

inline

Loads the value with the specified key. The value will be converted to the specified type.

Parameters

key	The key by which this data is identified.
out	The location to store the value for this key.

Store() [1/3]

Serializable::Data & Serializable::Data::Store	(	const std::string &	key,
		const Data &	value
	)

Stores the serialised data against the specified key.

Parameters

key	The key by which this serialised data should be stored against.
value	The serialised data to store.

Store() [2/3]

Serializable::Data & Serializable::Data::Store	(	const std::string &	key,
		const std::string &	value
	)

Stores the value against the specified key.

Parameters

key	The key by which this value should be stored against.
value	The value to store.

Store() [3/3]

template<typename T >

Data& Serializable::Data::Store ( const std::string &  key, const T &  value  )

inline

Stores the value against the specified key. The value will be converted to a string using ConvToStr.

Parameters

key	The key by which this value should be stored against.
value	The value to store.

---

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

• include/serialize.h
• src/serializable.cpp