An output archive designed to save data to JSON. More...

#include <json.hpp>

Inheritance diagram for cereal::JSONOutputArchive:

Classes
class	Options
	A class containing various advanced options for the JSON archive. More...

Public Member Functions
Common Functionality
Common use cases for directly interacting with an JSONOutputArchive
	JSONOutputArchive (std::ostream &stream, Options const &options=Options::Default())
	Construct, outputting to the provided stream. More...

	~JSONOutputArchive () CEREAL_NOEXCEPT
	Destructor, flushes the JSON. More...

void	saveBinaryValue (const void data, size_t size, const char name=nullptr)
	Saves some binary data, encoded as a base64 string, with an optional name. More...

Public Member Functions inherited from cereal::OutputArchive< JSONOutputArchive >
	OutputArchive (JSONOutputArchive *const derived)
	Construct the output archive. More...

OutputArchive &	operator= (OutputArchive const &)=delete

JSONOutputArchive &	operator() (Types &&... args)
	Serializes all passed in data. More...

void	serializeDeferments ()
	Serializes any data marked for deferment using defer. More...

std::uint32_t	registerSharedPointer (const std::shared_ptr< const void > &sharedPointer)
	Registers a shared pointer with the archive. More...

std::uint32_t	registerPolymorphicType (char const *name)
	Registers a polymorphic type name with the archive. More...

JSONOutputArchive &	operator& (T &&arg)
	Serializes passed in data. More...

JSONOutputArchive &	operator<< (T &&arg)
	Serializes passed in data. More...

Public Member Functions inherited from cereal::detail::OutputArchiveBase
	OutputArchiveBase ()=default

	OutputArchiveBase (OutputArchiveBase &&) CEREAL_NOEXCEPT

OutputArchiveBase &	operator= (OutputArchiveBase &&) CEREAL_NOEXCEPT

virtual	~OutputArchiveBase () CEREAL_NOEXCEPT=default

Private Types
enum class	NodeType { StartObject , InObject , StartArray , InArray }

using	WriteStream = CEREAL_RAPIDJSON_NAMESPACE::OStreamWrapper

using	JSONWriter = CEREAL_RAPIDJSON_NAMESPACE::PrettyWriter< WriteStream >

Private Attributes
WriteStream	itsWriteStream
	Rapidjson write stream. More...

JSONWriter	itsWriter
	Rapidjson writer. More...

char const *	itsNextName
	The next name. More...

std::stack< uint32_t >	itsNameCounter
	Counter for creating unique names for unnamed nodes. More...

std::stack< NodeType >	itsNodeStack

Internal Functionality
Functionality designed for use by those requiring control over the inner mechanisms of the JSONOutputArchive
void	startNode ()
	Starts a new node in the JSON output. More...

void	finishNode ()
	Designates the most recently added node as finished. More...

void	setNextName (const char *name)
	Sets the name for the next node created with startNode. More...

void	saveValue (bool b)
	Saves a bool to the current node. More...

void	saveValue (int i)
	Saves an int to the current node. More...

void	saveValue (unsigned u)
	Saves a uint to the current node. More...

void	saveValue (int64_t i64)
	Saves an int64 to the current node. More...

void	saveValue (uint64_t u64)
	Saves a uint64 to the current node. More...

void	saveValue (double d)
	Saves a double to the current node. More...

void	saveValue (std::string const &s)
	Saves a string to the current node. More...

void	saveValue (char const *s)
	Saves a const char * to the current node. More...

void	saveValue (std::nullptr_t)
	Saves a nullptr to the current node. More...

template<class T >
std::enable_if<!std::is_same< T, int64_t >::value &&std::is_same< T, long long >::value, void >::type	saveValue (T val)

template<class T >
std::enable_if<!std::is_same< T, uint64_t >::value &&std::is_same< T, unsigned long long >::value, void >::type	saveValue (T val)

template<class T , traits::EnableIf< std::is_same< T, long >::value, !std::is_same< T, int >::value, !std::is_same< T, std::int64_t >::value > = traits::sfinae>
void	saveValue (T t)
	Serialize a long if it would not be caught otherwise. More...

template<class T , traits::EnableIf< std::is_same< T, unsigned long >::value, !std::is_same< T, unsigned >::value, !std::is_same< T, std::uint64_t >::value > = traits::sfinae>
void	saveValue (T t)
	Serialize an unsigned long if it would not be caught otherwise. More...

template<class T , traits::EnableIf< std::is_arithmetic< T >::value, !std::is_same< T, long >::value, !std::is_same< T, unsigned long >::value, !std::is_same< T, std::int64_t >::value, !std::is_same< T, std::uint64_t >::value, !std::is_same< T, long long >::value, !std::is_same< T, unsigned long long >::value,(sizeof(T) >=sizeof(long double)\|\|sizeof(T) >=sizeof(long long))> = traits::sfinae>
void	saveValue (T const &t)
	Save exotic arithmetic as strings to current node. More...

void	writeName ()
	Write the name of the upcoming node and prepare object/array state. More...

void	makeArray ()
	Designates that the current node should be output as an array, not an object. More...

template<class T , traits::EnableIf< sizeof(T)==sizeof(std::int32_t), std::is_signed< T >::value > = traits::sfinae>
void	saveLong (T l)
	32 bit signed long saving to current node More...

template<class T , traits::EnableIf< sizeof(T) !=sizeof(std::int32_t), std::is_signed< T >::value > = traits::sfinae>
void	saveLong (T l)
	non 32 bit signed long saving to current node More...

template<class T , traits::EnableIf< sizeof(T)==sizeof(std::int32_t), std::is_unsigned< T >::value > = traits::sfinae>
void	saveLong (T lu)
	32 bit unsigned long saving to current node More...

template<class T , traits::EnableIf< sizeof(T) !=sizeof(std::int32_t), std::is_unsigned< T >::value > = traits::sfinae>
void	saveLong (T lu)
	non 32 bit unsigned long saving to current node More...

Additional Inherited Members
Public Types inherited from cereal::OutputArchive< JSONOutputArchive >
using	is_loading = std::false_type
	Indicates this archive is not intended for loading. More...

using	is_saving = std::true_type
	Indicates this archive is intended for saving. More...

Detailed Description

An output archive designed to save data to JSON.

This archive uses RapidJSON to build serialize data to JSON.

JSON archives provides a human readable output but at decreased performance (both in time and space) compared to binary archives.

JSON archives are only guaranteed to finish flushing their contents upon destruction and should thus be used in an RAII fashion.

JSON benefits greatly from name-value pairs, which if present, will name the nodes in the output. If these are not present, each level of the output will be given an automatically generated delimited name.

The precision of the output archive controls the number of decimals output for floating point numbers and should be sufficiently large (i.e. at least 20) if there is a desire to have binary equality between the numbers output and those read in. In general you should expect a loss of precision when going from floating point to text and back.

JSON archives do not output the size information for any dynamically sized structure and instead infer it from the number of children for a node. This means that data can be hand edited for dynamic sized structures and will still be readable. This is accomplished through the cereal::SizeTag object, which will cause the archive to output the data as a JSON array (e.g. marked by [] instead of {}), which indicates that the container is variable sized and may be edited.

Member Typedef Documentation

◆ JSONWriter

using cereal::JSONOutputArchive::JSONWriter = CEREAL_RAPIDJSON_NAMESPACE::PrettyWriter<WriteStream>

private

◆ WriteStream

using cereal::JSONOutputArchive::WriteStream = CEREAL_RAPIDJSON_NAMESPACE::OStreamWrapper

private

Member Enumeration Documentation

◆ NodeType

enum cereal::JSONOutputArchive::NodeType

strongprivate

Enumerator
StartObject
InObject
StartArray
InArray

Constructor & Destructor Documentation

◆ JSONOutputArchive()

cereal::JSONOutputArchive::JSONOutputArchive	(	std::ostream &	stream,
		Options const &	options = `Options::Default()`
	)

inline

Construct, outputting to the provided stream.

Parameters

stream	The stream to output to.
options	The JSON specific options to use. See the Options struct for the values of default parameters

◆ ~JSONOutputArchive()

cereal::JSONOutputArchive::~JSONOutputArchive ( )

inline

Destructor, flushes the JSON.

Member Function Documentation

◆ finishNode()

void cereal::JSONOutputArchive::finishNode ( )

inline

Designates the most recently added node as finished.

◆ makeArray()

void cereal::JSONOutputArchive::makeArray ( )

inline

Designates that the current node should be output as an array, not an object.

◆ saveBinaryValue()

void cereal::JSONOutputArchive::saveBinaryValue	(	const void *	data,
		size_t	size,
		const char *	name = `nullptr`
	)

inline

Saves some binary data, encoded as a base64 string, with an optional name.

This will create a new node, optionally named, and insert a value that consists of the data encoded as a base64 string

◆ saveLong() [1/4]

template<class T , traits::EnableIf< sizeof(T)==sizeof(std::int32_t), std::is_signed< T >::value > = traits::sfinae>

void cereal::JSONOutputArchive::saveLong ( T l )

inlineprivate

32 bit signed long saving to current node

◆ saveLong() [2/4]

template<class T , traits::EnableIf< sizeof(T) !=sizeof(std::int32_t), std::is_signed< T >::value > = traits::sfinae>

void cereal::JSONOutputArchive::saveLong ( T l )

inlineprivate

non 32 bit signed long saving to current node

◆ saveLong() [3/4]

template<class T , traits::EnableIf< sizeof(T)==sizeof(std::int32_t), std::is_unsigned< T >::value > = traits::sfinae>

void cereal::JSONOutputArchive::saveLong ( T lu )

inlineprivate

32 bit unsigned long saving to current node

◆ saveLong() [4/4]

template<class T , traits::EnableIf< sizeof(T) !=sizeof(std::int32_t), std::is_unsigned< T >::value > = traits::sfinae>

void cereal::JSONOutputArchive::saveLong ( T lu )

inlineprivate

non 32 bit unsigned long saving to current node

◆ saveValue() [1/14]

void cereal::JSONOutputArchive::saveValue ( bool b )

inline

Saves a bool to the current node.

◆ saveValue() [2/14]

void cereal::JSONOutputArchive::saveValue ( char const * s )

inline

Saves a const char * to the current node.

◆ saveValue() [3/14]

void cereal::JSONOutputArchive::saveValue ( double d )

inline

Saves a double to the current node.

◆ saveValue() [4/14]

void cereal::JSONOutputArchive::saveValue ( int i )

inline

Saves an int to the current node.

◆ saveValue() [5/14]

void cereal::JSONOutputArchive::saveValue ( int64_t i64 )

inline

Saves an int64 to the current node.

◆ saveValue() [6/14]

void cereal::JSONOutputArchive::saveValue ( std::nullptr_t )

inline

Saves a nullptr to the current node.

◆ saveValue() [7/14]

void cereal::JSONOutputArchive::saveValue ( std::string const & s )

inline

Saves a string to the current node.

◆ saveValue() [8/14]

template<class T , traits::EnableIf< std::is_arithmetic< T >::value, !std::is_same< T, long >::value, !std::is_same< T, unsigned long >::value, !std::is_same< T, std::int64_t >::value, !std::is_same< T, std::uint64_t >::value, !std::is_same< T, long long >::value, !std::is_same< T, unsigned long long >::value,(sizeof(T) >=sizeof(long double)||sizeof(T) >=sizeof(long long))> = traits::sfinae>

void cereal::JSONOutputArchive::saveValue ( T const & t )

inline

Save exotic arithmetic as strings to current node.

Handles long long (if distinct from other types), unsigned long (if distinct), and long double

◆ saveValue() [9/14]

template<class T , traits::EnableIf< std::is_same< T, long >::value, !std::is_same< T, int >::value, !std::is_same< T, std::int64_t >::value > = traits::sfinae>

void cereal::JSONOutputArchive::saveValue ( T t )

inline

Serialize a long if it would not be caught otherwise.

◆ saveValue() [10/14]

template<class T , traits::EnableIf< std::is_same< T, unsigned long >::value, !std::is_same< T, unsigned >::value, !std::is_same< T, std::uint64_t >::value > = traits::sfinae>

void cereal::JSONOutputArchive::saveValue ( T t )

inline

Serialize an unsigned long if it would not be caught otherwise.

◆ saveValue() [11/14]

template<class T >

std::enable_if<!std::is_same<T, int64_t>::value && std::is_same<T, long long>::value, void>::type cereal::JSONOutputArchive::saveValue ( T val )

inline

◆ saveValue() [12/14]

template<class T >

std::enable_if<!std::is_same<T, uint64_t>::value && std::is_same<T, unsigned long long>::value, void>::type cereal::JSONOutputArchive::saveValue ( T val )

inline

◆ saveValue() [13/14]

void cereal::JSONOutputArchive::saveValue ( uint64_t u64 )

inline

Saves a uint64 to the current node.

◆ saveValue() [14/14]

void cereal::JSONOutputArchive::saveValue ( unsigned u )

inline

Saves a uint to the current node.

◆ setNextName()

void cereal::JSONOutputArchive::setNextName ( const char * name )

inline

Sets the name for the next node created with startNode.

◆ startNode()

void cereal::JSONOutputArchive::startNode ( )

inline

Starts a new node in the JSON output.

The node can optionally be given a name by calling setNextName prior to creating the node

Nodes only need to be started for types that are themselves objects or arrays

◆ writeName()

void cereal::JSONOutputArchive::writeName ( )

inline

Write the name of the upcoming node and prepare object/array state.

Since writeName is called for every value that is output, regardless of whether it has a name or not, it is the place where we will do a deferred check of our node state and decide whether we are in an array or an object.

The general workflow of saving to the JSON archive is:

(optional) Set the name for the next node to be created, usually done by an NVP
Start the node
(if there is data to save) Write the name of the node (this function)
(if there is data to save) Save the data (with saveValue)
Finish the node

Member Data Documentation

◆ itsNameCounter

std::stack<uint32_t> cereal::JSONOutputArchive::itsNameCounter

private

Counter for creating unique names for unnamed nodes.

◆ itsNextName

char const* cereal::JSONOutputArchive::itsNextName

private

The next name.

◆ itsNodeStack

std::stack<NodeType> cereal::JSONOutputArchive::itsNodeStack

private

◆ itsWriter

JSONWriter cereal::JSONOutputArchive::itsWriter

private

Rapidjson writer.

◆ itsWriteStream

WriteStream cereal::JSONOutputArchive::itsWriteStream

private

Rapidjson write stream.

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

/home/runner/work/NDDEM/NDDEM/src/Dem/cereal/archives/json.hpp

Classes

Public Member Functions

Private Types

Private Attributes

Internal Functionality

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ JSONWriter

◆ WriteStream

Member Enumeration Documentation

◆ NodeType

Constructor & Destructor Documentation

◆ JSONOutputArchive()

◆ ~JSONOutputArchive()

Member Function Documentation

◆ finishNode()

◆ makeArray()

◆ saveBinaryValue()

◆ saveLong() [1/4]

◆ saveLong() [2/4]

◆ saveLong() [3/4]

◆ saveLong() [4/4]

◆ saveValue() [1/14]

◆ saveValue() [2/14]

◆ saveValue() [3/14]

◆ saveValue() [4/14]

◆ saveValue() [5/14]

◆ saveValue() [6/14]

◆ saveValue() [7/14]

◆ saveValue() [8/14]

◆ saveValue() [9/14]

◆ saveValue() [10/14]

◆ saveValue() [11/14]

◆ saveValue() [12/14]

◆ saveValue() [13/14]

◆ saveValue() [14/14]

◆ setNextName()

◆ startNode()

◆ writeName()

Member Data Documentation

◆ itsNameCounter

◆ itsNextName

◆ itsNodeStack

◆ itsWriter

◆ itsWriteStream